catalyst::controller::sru(3pm) [debian man page]

Catalyst::Controller::SRU(3pm)				User Contributed Perl Documentation			    Catalyst::Controller::SRU(3pm)

NAME

       Catalyst::Controller::SRU - Dispatch SRU methods with Catalyst

SYNOPSIS

	   package MyApp::Controller::SRU;

	   # use it as a base controller
	   use base qw( Catalyst::Controller::SRU );

	   # explain, scan and searchretrieve methods
	   sub explain {
	       my ( $self, $c,
		   $sru_request,  # ISA SRU::Request::Explain
		   $sru_response, # ISA SRU::Response::Explain
	       ) = @_;
	   }

	   sub scan {
	       my ( $self, $c,
		   $sru_request,  # ISA SRU::Request::Scan
		   $sru_response, # ISA SRU::Response::Scan
		   $cql,	  # ISA CQL::Parser root node
	       ) = @_;

	   }

	   sub searchRetrieve {
	       my ( $self, $c,
		   $sru_request,  # ISA SRU::Request::SearchRetrieve
		   $sru_response, # ISA SRU::Response::SearchRetrieve
		   $cql,	  # ISA CQL::Parser root node
	       ) = @_;
	   }

DESCRIPTION

       This module allows your controller class to dispatch SRU actions ("explain", "scan", and "searchRetrieve") from its own class.

METHODS

   index : Private
       This method will create an SRU request, response and possibly a CQL object based on the type of SRU request it finds. It will then pass the
       data over to your customized method.

SEE ALSO

       o   Catalyst

AUTHOR

       Brian Cassidy <bricas@cpan.org>

COPYRIGHT AND LICENSE

       Copyright 2005-2009 by Brian Cassidy

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

perl v5.12.4							    2009-12-02					    Catalyst::Controller::SRU(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)