NAME
Apache2::REST::Handler - Base class for a resource handler.
SYNOPSIS
A Handler object is build for each fragment of the URI, and objects are chained via the attibute parent.
You _must_ implement at list one Handler class to handle the root URI of your application and set it in your apache conf by : PerlSetVar Apache2RESTHandlerRootClass "MyApp::REST::API" (for instance).
You _must_ implement at least one HTTP method (GET,POST,PUT,DELETE ...).
They will be called by the framework like this (for instance):
$this->GET($request,$response) ;$request is an Apache2::REST::Request (which is a subclass of Apache2::Request). $response is an Apache2::REST::Response
Each method must return a valid Apache2::Const::HTTP_* code. Typically Apache2::Const::HTTP_OK when everything went smoothly.
See http://search.cpan.org/dist/Apache2-Controller/lib/Apache2/Controller/Refcard.pm for a list.
You _must_ implement at least one isAuth method along the URI. Typically if you want to allow GET by default:
sub isAuth{ my ( $self , $method , $req ) = @ _; return $method eq 'GET' ;}See Apache2::REST for a full working handler example.
class
Helper to get the class of this (or this class).
handle
Handles a request and does the framework magic. Override at your own risks.
buildNext
This method is responsible for building the handler handling the next fragment. It is given the fragment to build an handler for as well as the Request.
The default implementation builds a handler of class $this->class().'::'.$frag
It _must_ return undef when the resource is not found.
Called like this by the framework:
$this->buildNext($frag , $req ) ;
Overriding use cases:
- Build a dynamic handler. For instance if the fragment is an item ID, you might want to build an item handler with this particular item. See Apache2::REST::Handler::test for an example.
- Rerouting outside of the handler classes space. If you want to escape the default class resolution mecanism.
isAuth
Given a method and a request, returns true if this method is allowed.
The default implementation delegates to the parent.
Nothing is allowed by default. So you need to override this method at least once.
It is called by the framework like this (for instance):
$this->isAuth('GET' , $req) ;
new
You can override this in subclasses. Do not forget to call $class->SUPER::new() ;
conf
Get/Sets the configuration attached to this handler. Or the parent one if no one is defined.
isTopLevel
Returns true if this handler handles the application top level.
Usage:
if ( $this->isTopLevel() ){ .. }rootHandler
Returns the root handler processing this request.
seekByClass
Seek for a handler of the given class along the parent path. Returns the first handler found or undef if nothing found.
usage:
my $handler = $self->seekByClass('My::REST::API::myclass') ;