sru::request(3pm) [debian man page]

SRU::Request(3pm)					User Contributed Perl Documentation					 SRU::Request(3pm)

NAME

       SRU::Request - Factories for creating SRU request objects.

SYNOPSIS

	   use SRU::Request;
	   my $request = SRU::Request->newFromURI( $uri );

DESCRIPTION

       SRU::Request allows you to create the appropriate SRU request object from a URI object. This allows you to pass in a URI and get back one
       of SRU::Request::Explain, SRU::Request::Scan or SRU::Request::SearchRetrieve depending on the type of URI that is passed in. See the docs
       for those classes for more information about what they contain.

METHODS

   newFromURI()
       newFromURI() is a factory method which you pass a complete SRU url.  newFromURI() will return an appropriate object for the type of request
       being conducted:

       o   SRU::Request::Explain

       o   SRU::Request::Scan

       o   SRU::Request::SearchRetrieve

       If the request is not formatted properly the call will return undef.  The error encountered should be available in $SRU::Error.

   newFromCGI()
       A factory method for creating a request object from a CGI object.

	   my $cgi = CGI->new();
	   my $request = SRU::Request->newFromCGI( $cgi );

   asXML()
       Used to generate <echoedExplainRequest>, <echoedSearchRetrieveRequest> and <echoedScanRequest> elements in the response.

   type()
       Returns 'searchRetrieve', 'scan' or 'explain' depending on what type of object it is.

perl v5.12.4							    2009-11-20							 SRU::Request(3pm)

SRU::Server(3pm)					User Contributed Perl Documentation					  SRU::Server(3pm)

NAME

       SRU::Server - respond to SRU requests via CGI::Application

SYNOPSIS

	   package MySRU;

	   use base qw( SRU::Server );

	   sub explain {
	       my $self = shift;

	       # $self->request isa SRU::Request::Explain
	       # $self->response isa SRU::Response::Explain
	   }

	   sub scan {
	       my $self = shift;

	       # $self->request isa SRU::Request::Scan
	       # $self->response isa SRU::Response::Scan
	       # $self->cql is the root node of a CQL::Parser-parsed query
	   }

	   sub searchRetrieve {
	       my $self = shift;

	       # $self->request isa SRU::Request::SearchRetrieve
	       # $self->response isa SRU::Response::SearchRetrieve
	       # $self->cql is the root node of a CQL::Parser-parsed query
	   }

	   package main;

	   MySRU->new->run;

DESCRIPTION

       This module brings together all of the SRU verbs (explain, scan and searchRetrieve) under a sub-classable object based on CGI::Application.

METHODS

   explain
       This method is used to return an explain response. It is the default method.

   scan
       This method returns a scan response.

   searchRetrieve
       This method returns a searchRetrieve response.

CGI
::APPLICATION METHODS
   setup
       Sets the "run_modes", "mode_param" and the default runmode (explain).

   cgiapp_prerun
       Parses the incoming SRU request and if needed, checks the CQL query.

   cgiapp_postrun
       Sets the content type (text/xml) and serializes the response.

   error_mode
       Stub error runmode.

AUTHORS

       o   Brian Cassidy <bricas@cpan.org>

       o   Ed Summers <ehs@pobox.com>

perl v5.12.4							    2009-11-20							  SRU::Server(3pm)