Wombat::Authenticator::AuthenticatorBase - internal authenticator base class
Convenience base implementation of Wombat::Valve that enforces the security-constraint elements in the web application deployment descriptor. This functionality is implemented as a Valve so that it can be omitted in environments that do not require these features. Individual implementations of each supported authentication method can subclass this base class as required. Subclasses MUST implement authenticate() and getName().
authenticate()
getName()
When this class is utilized, the Application to which it is attached must have an associated Realm that can be used for authenticating users and enumerating the roles to which they have been assigned.
This Valve is only useful when processing HTTP requests. Requests of any other type will simply be passed through.
Set the Application to which this Authenticator is attached.
Parameters:
the Wombat::Core::Application to which this Authenticator is attached
Throws:
if the Container is not Wombat::Core::Application
Perform request processing as required by this Valve.
Parameters
the Wombat::Request to be processed
the Wombat::Response to be created
the Wombat::ValveContext allowing access to the next Valve in the Pipeline being processed
if a servlet error occurs or is thrown by a subsequently invoked Valve, Filter or Servlet
if an input or output error occurs
Authenticate the user making this request, based on the specified login configuration. Return true if any specified constraint has been satisfied, or false if we have created a response already.
the Wombat::HttpRequest being processed
the Wombat::HttpResponse being created
the Wombat::Deploy::LoginConfig describing the authentication procedure
Perform access control based on the specified authorization constraint. Return true if this constraint was not violated and processing should continue, of false if we have created a response already.
the Wombat::Deploy::SecurityConstraint being checked
Enforce any user data constraint required by the security constraint guarding this request URI. Return true if this constraint was not violated and processing should continue, of false if we have created a response already.
Return the Wombat::Deploy::SecurityConstraint configured to guard the request URI for this request, or undef if there is no constraint.
undef
Return a short name for this Authenticator implementation. Must be overridden by subclasses.
Register an authenticated Principal and authentication tyhpe in the request and in the current session (if there is one).
the authenticated Servlet::Util::Principal to be registered
the authentication type to be registered
Servlet::ServletException, Servlet::Util::Exception, Wombat::Core::Application, Wombat::Realm, Wombat::Valve::ValveBase, Wombat::ValveContext
Brian Moseley, bcm@maz.org
To install Wombat, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Wombat
CPAN shell
perl -MCPAN -e shell install Wombat
For more information on module installation, please visit the detailed CPAN module installation guide.