Wombat::Realm::RealmBase - internal realm base clas
Convenience base implementation of Wombat::Realm. Subclasses should implement getName(), getPassword(), and getPrincipal().
getName()
getPassword()
getPrincipal()
Construct and return a Wombat::Realm::RealmBase instance, initializing fields appropriately. If subclasses override the constructor, they must be sure to call
$self->SUPER::new();
Return the digest algorithm used for authenticating credentials. If no algorithm is specified, credentials will be used as submitted.
Set the digest algorithm used for authenticating credentials. Supported algorithms include: MD5, SHA1, HMAC, MD2, and anything else provided by the Digest library.
Parameters:
the digest algorithm
Return the Container associated with this Realm.
Set the Container associated with this Realm.
the Wombat::Container associated with this Realm
Return the Principal associated with the specified username and credentials, if there is one, or undef otherwise.
undef
Parameters
username of the principal to be looked up
password or other credentials to use in authenticating this username
Return true if the specified Principal has the specified security role within the context of this Realm, or false otherwise.
the Wombat::Realm::Genericrincipal for whom the role is to be checked
the name of the security role to be checked
Digest a submitted password using the configured algorithm and convert the result to a corresponding hexadecimal string. If an exception is thrown, the plain credentials string is returned.
the password or other credentials to use in authentication
Return a short name for this Realm implementation. Must be overridden by subclasses.
Return the password associated with the given Principal's user name. Should be overridden by subclasses.
the username of the Principal
Return the Principal associated with the given user name. Should be overridden by subclasses.
Prepare for active use of this Realm. This method should be called before any of the public methods of the Realm are utilized.
Throws:
if the Realm has already been started
Gracefully terminate active use of this Realm. Once this method has been called, no public methods of the Realm should be utilized.
if the Realm is not started
Digest, Wombat::Container, Wombat::Exception, Wombat::Realm, Wombat::Realm::GenericPrincipal
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.