http::oai::identify(3pm) [debian man page]

HTTP::OAI::Identify(3pm)				User Contributed Perl Documentation				  HTTP::OAI::Identify(3pm)

NAME

       HTTP::OAI::Identify - Provide access to an OAI Identify response

SYNOPSIS

	       use HTTP::OAI::Identify;

	       my $i = new HTTP::OAI::Identify(
		       adminEmail=>'billg@microsoft.com',
		       baseURL=>'http://www.myarchives.org/oai',
		       repositoryName=>'www.myarchives.org'
	       );

	       for( $i->adminEmail ) {
		       print $_, "
";
	       }

METHODS

       $i = new HTTP::OAI::Identify(-baseURL=>'http://arXiv.org/oai1'[, adminEmail=>$email, protocolVersion=>'2.0', repositoryName=>'myarchive'])
	   This constructor method returns a new instance of the OAI::Identify module.

       $i->version
	   Return the original version of the OAI response, according to the given XML namespace.

       $i->headers
	   Returns an HTTP::OAI::Headers object. Use $headers->header('headername') to retrive field values.

       $burl = $i->baseURL([$burl])
       $eds = $i->earliestDatestamp([$eds])
       $gran = $i->granularity([$gran])
       $version = $i->protocolVersion($version)
       $name = $i->repositoryName($name)
	   Returns and optionally sets the relevent header. NOTE: protocolVersion will always be '2.0'. Use $i->version to find out the protocol
	   version used by the repository.

       @addys = $i->adminEmail([$email])
       @cmps = $i->compression([$cmp])
	   Returns and optionally adds to the multi-value headers.

       @dl = $i->description([$d])
	   Returns the description list and optionally appends a new description $d. Returns an array ref of HTTP::OAI::Descriptions, or an empty
	   ref if there are no description.

       $d = $i->next
	   Returns the next description or undef if no more description left.

       $dom = $i->toDOM
	   Returns a XML::DOM object representing the Identify response.

perl v5.12.4							    2011-06-23						  HTTP::OAI::Identify(3pm)

HTTP::OAI::Repository(3pm)				User Contributed Perl Documentation				HTTP::OAI::Repository(3pm)

NAME

       HTTP::OAI::Repository - Documentation for building an OAI compliant repository using OAI-PERL

DESCRIPTION

       Using the OAI-PERL library in a repository context requires the user to build the OAI responses to be sent to OAI harvesters.

SYNOPSIS 1
	       use HTTP::OAI::Harvester;
	       use HTTP::OAI::Metadata::OAI_DC;
	       use XML::SAX::Writer;
	       use XML::LibXML;

	       # (all of these options _must_ be supplied to comply with the OAI protocol)
	       # (protocolVersion and responseDate both have sensible defaults)
	       my $r = new HTTP::OAI::Identify(
		       baseURL=>'http://yourhost/cgi/oai',
		       adminEmail=>'youremail@yourhost',
		       repositoryName=>'agoodname',
		       requestURL=>self_url()
	       );

	       # Include a description (an XML::LibXML Dom object)
	       $r->description(new HTTP::OAI::Metadata(dom=>$dom));

	       my $r = HTTP::OAI::Record->new(
		       header=>HTTP::OAI::Header->new(
			       identifier=>'oai:myrepo:10',
			       datestamp=>'2004-10-01'
			       ),
		       metadata=>HTTP::OAI::Metadata::OAI_DC->new(
			       dc=>{title=>['Hello, World!'],description=>['My Record']}
			       )
	       );
	       $r->about(HTTP::OAI::Metadata->new(dom=>$dom));

	       my $writer = XML::SAX::Writer->new();
	       $r->set_handler($writer);
	       $r->generate;

Building an OAI compliant repository
       The validation scripts included in this module provide the repository admin with a number of tools for helping with being OAI compliant,
       however they can not be exhaustive in themselves.

METHODS

       $r = HTTP::OAI::Repository::validate_request(%paramlist)
       $r = HTTP::OAI::Repository::validate_request_2_0(%paramlist)
	   These functions, exported by the Repository module, validate an OAI request against the protocol requirements. Returns an
	   HTTP::Response object, with the code set to 200 if the request is well-formed, or an error code and the message set.

	   e.g:

		   my $r = validate_request(%paramlist);

		   print header(-status=>$r->code.' '.$r->message),
			   $r->error_as_HTML;

	   Note that validate_request attempts to be as strict to the Protocol as possible.

       $b = HTTP::OAI::Repository::validate_date($date)
       $b = HTTP::OAI::Repository::validate_metadataPrefix($mdp)
       $b = HTTP::OAI::Repository::validate_responseDate($date)
       $b = HTTP::OAI::Repository::validate_setSpec($set)
	   These functions, exported by the Repository module, validate the given type of OAI data. Returns true if the given value is sane, false
	   otherwise.

EXAMPLE

       See the bin/gateway.pl for an example implementation (it's actually for creating a static repository gateway, but you get the idea!).

perl v5.12.4							    2010-09-01						HTTP::OAI::Repository(3pm)