Jay Kuri > Catalyst-Plugin-Authentication-0.10005 > Catalyst::Authentication::Realm

Download:
Catalyst-Plugin-Authentication-0.10005.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View Bugs
Report a bug
Source   Latest Release: Catalyst-Plugin-Authentication-0.10015

NAME ^

Catalyst::Authentication::Realm - Base class for realm objects.

DESCRIPTION ^

CONFIGURATION ^

class

By default this class is the default realm class. You can specify a custom realm class with this config parameter.

auto_create_user

Set this to true if you wish this realm to auto-create user accounts when the user doesn't exist (most useful for remote authentication schemes).

auto_update_user

Set this to true if you wish this realm to auto-update user accounts after authentication (most useful for remote authentication schemes).

METHODS ^

new( )

Instantiantes this realm, plus the specified store and credential classes.

store( )

Holds an instance of the store object for this realm.

credential( )

Holds an instance of the credential object for this realm.

find_user( )

Delegates to the store object. Will also re-delegate auto_create_user and auto_update_user at this time, if necessary.

authenticate( )

Delegates to the credential objects and sets the authenticated user on success.

save_user_in_session( )

Delegates to the store object.

from_session( )

Delegates to the store object.