Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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)

Check Out this Related Man Page

HTTP::Request(3)					User Contributed Perl Documentation					  HTTP::Request(3)

NAME

       HTTP::Request - Class encapsulating HTTP Requests

SYNOPSIS

	require HTTP::Request;
	$request = HTTP::Request->new(GET => 'http://www.oslo.net/');

DESCRIPTION

       "HTTP::Request" is a class encapsulating HTTP style requests, consisting of a request line, some headers, and some (potentially empty) con-
       tent. Note that the LWP library also uses this HTTP style requests for non-HTTP protocols.

       Instances of this class are usually passed to the "request()" method of an "LWP::UserAgent" object:

	$ua = LWP::UserAgent->new;
	$request = HTTP::Request->new(GET => 'http://www.oslo.net/');
	$response = $ua->request($request);

       "HTTP::Request" is a subclass of "HTTP::Message" and therefore inherits its methods.  The inherited methods most often used are header(),
       push_header(), remove_header(), and content(). See HTTP::Message for details.

       The following additional methods are available:

       $r = HTTP::Request->new($method, $uri)
       $r = HTTP::Request->new($method, $uri, $header)
       $r = HTTP::Request->new($method, $uri, $header, $content)
	   Constructs a new "HTTP::Request" object describing a request on the object $uri using method $method.  The $uri argument can be either
	   a string, or a reference to a "URI" object.	The optional $header argument should be a reference to an "HTTP::Headers" object.  The
	   optional $content argument should be a string.

       $r->method([$val])
       $r->uri([$val])
	   These methods provide public access to the attributes containing respectively the method of the request and the URI object of the
	   request.

	   If an argument is given the attribute is given that as its new value. If no argument is given the value is not touched. In either case
	   the previous value is returned.

	   The method() method argument should be a string.

	   The uri() method accept both a reference to a URI object and a string as its argument.  If a string is given, then it should be
	   parseable as an absolute URI.

       $r->as_string()
	   Method returning a textual representation of the request.  Mainly useful for debugging purposes. It takes no arguments.

SEE ALSO

       HTTP::Headers, HTTP::Message, HTTP::Request::Common

COPYRIGHT

       Copyright 1995-2001 Gisle Aas.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

libwww-perl-5.65						    2001-11-15							  HTTP::Request(3)
Man Page