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)

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

NAME

       HTTP::Message - Class encapsulating HTTP messages

SYNOPSIS

	package HTTP::Request;	# or HTTP::Response
	require HTTP::Message;
	@ISA=qw(HTTP::Message);

DESCRIPTION

       An "HTTP::Message" object contains some headers and a content (body).  The class is abstract, i.e. it only used as a base class for
       "HTTP::Request" and "HTTP::Response" and should never instantiated as itself.

       The following methods are available:

       $mess = HTTP::Message->new
	   This is the object constructor.  It should only be called internally by this library.  External code should construct "HTTP::Request"
	   or "HTTP::Response" objects.

       $mess->clone()
	   Returns a copy of the object.

       $mess->protocol([$proto])
	   Sets the HTTP protocol used for the message.  The protocol() is a string like "HTTP/1.0" or "HTTP/1.1".

       $mess->content([$content])
	   The content() method sets the content if an argument is given.  If no argument is given the content is not touched.	In either case the
	   previous content is returned.

       $mess->add_content($data)
	   The add_content() methods appends more data to the end of the current content buffer.

       $mess->content_ref
	   The content_ref() method will return a reference to content buffer string.  It can be more efficient to access the content this way if
	   the content is huge, and it can even be used for direct manipulation of the content, for instance:

	     ${$res->content_ref} =~ s/foo/bar/g;

       $mess->headers;
	   Return the embedded HTTP::Headers object.

       $mess->headers_as_string([$endl])
	   Call the as_string() method for the headers in the message.	This will be the same as:

	    $mess->headers->as_string

	   but it will make your program a whole character shorter :-)

       All unknown "HTTP::Message" methods are delegated to the "HTTP::Headers" object that is part of every message.  This allows convenient
       access to these methods.  Refer to HTTP::Headers for details of these methods:

	 $mess->header($field => $val);
	 $mess->push_header($field => $val);
	 $mess->init_header($field => $val);
	 $mess->remove_header($field);
	 $mess->scan(&doit);

	 $mess->date;
	 $mess->expires;
	 $mess->if_modified_since;
	 $mess->if_unmodified_since;
	 $mess->last_modified;
	 $mess->content_type;
	 $mess->content_encoding;
	 $mess->content_length;
	 $mess->content_language
	 $mess->title;
	 $mess->user_agent;
	 $mess->server;
	 $mess->from;
	 $mess->referer;
	 $mess->www_authenticate;
	 $mess->authorization;
	 $mess->proxy_authorization;
	 $mess->authorization_basic;
	 $mess->proxy_authorization_basic;

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::Message(3)