NAME

DTA::CAB::Server::HTTP::Handler::QueryList - CAB HTTP Server: request handler: analyzer list queries

SYNOPSIS

 ##========================================================================
 ## PRELIMINARIES
 
 use DTA::CAB::Server::HTTP::Handler::QueryList;
 
 ##========================================================================
 ## Methods: API
 
 $h = $class_or_obj->new(%options);
 $bool = $h->prepare($server);
 $bool = $path->run($server, $localPath, $clientSocket, $httpRequest);

DESCRIPTION

DTA::CAB::Server::HTTP::Handler::QueryList is a request handler class for use with a DTA::CAB::Server::HTTP server which handles analyzer list queries for a selected DTA::CAB::Server::HTTP::Handler::Query handler.

Globals

Variable: @ISA: DTA::CAB::Server::HTTP::Handler::QueryList inherits from DTA::CAB::Server::HTTP::Handler::CGI and implements the DTA::CAB::Server::HTTP::Handler API.

Methods: API

new

 $h = $class_or_obj->new(%options);

%$h, %options:

  (
   ##-- INHERITED from Handler::CGI
   #encoding => $defaultEncoding,  ##-- default encoding (UTF-8)
   allowGet => $bool,             ##-- allow GET requests? (default=1)
   allowPost => $bool,            ##-- allow POST requests? (default=1)
   allowList => $bool,            ##-- if true, allowed analyzers will be listed for 'PATHROOT/.../list' paths
   pushMode => $mode,             ##-- push mode for addVars (default='keep')
   ##
   ##-- NEW in Handler::QueryList
   qh => $qh,                     ##-- associated query handler
  )

prepare

 $bool = $h->prepare($server);

Checks that $h->{qh} is defined.

run

 $bool = $path->run($server, $localPath, $clientSocket, $httpRequest);

Process $httpRequest matching $localPath as CGI form-encoded analyzer list query. The following CGI form parameters are supported:

 (
  a => $analyerRegex,            ##-- analyzer regex in %{$srv->{as}}
  fmt => $format,                ##-- I/O format
  #enc => $enc,                   ##-- I/O encoding
  pretty => $level,              ##-- pretty-printing level
  raw => $bool,                  ##-- if true, data will be returned as text/plain (default=$h->{returnRaw})
 )

AUTHOR

Bryan Jurish <moocow@cpan.org>

COPYRIGHT AND LICENSE

This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.24.1 or, at your option, any later version of Perl 5 you may have available.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 268:: You forgot a '=back' before '=head1'