.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SRU::Server 3pm"
.TH SRU::Server 3pm "2022-06-17" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
SRU::Server \- Respond to SRU requests via CGI::Application
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    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;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module brings together all of the \s-1SRU\s0 verbs (explain, scan
and searchRetrieve) under a sub-classable object based on CGI::Application.
.SH "METHODS"
.IX Header "METHODS"
.SS "explain"
.IX Subsection "explain"
This method is used to return an explain response. It is the default
method.
.SS "scan"
.IX Subsection "scan"
This method returns a scan response.
.SS "searchRetrieve"
.IX Subsection "searchRetrieve"
This method returns a searchRetrieve response.
.SH "CGI::APPLICATION METHODS"
.IX Header "CGI::APPLICATION METHODS"
.SS "setup"
.IX Subsection "setup"
Sets the \f(CW\*(C`run_modes\*(C'\fR, \f(CW\*(C`mode_param\*(C'\fR and the default runmode (explain).
.SS "cgiapp_prerun"
.IX Subsection "cgiapp_prerun"
Parses the incoming \s-1SRU\s0 request and if needed, checks the \s-1CQL\s0 query.
.SS "cgiapp_postrun"
.IX Subsection "cgiapp_postrun"
Sets the content type (text/xml) and serializes the response.
.SS "error_mode"
.IX Subsection "error_mode"
Stub error runmode.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Brian Cassidy <bricas@cpan.org>
.IP "\(bu" 4
Ed Summers <ehs@pobox.com>
.IP "\(bu" 4
Jakob Voss <voss@gbv.de>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2013 by Ed Summers.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.