Man pages sections > man3 > Catalyst::Plugin::Session::State

Catalyst::Plugin::Session::State - Base class for session state preservation

Catalyst::Plugin::Session::State(3pm) User Contributed Perl Documentation Catalyst::Plugin::Session::State(3pm)

NAME

Catalyst::Plugin::Session::State - Base class for session state preservation plugins.

SYNOPSIS

    package Catalyst::Plugin::Session::State::MyBackend;
    use base qw/Catalyst::Plugin::Session::State/;

DESCRIPTION

This class doesn't actually provide any functionality, but when the "Catalyst::Plugin::Session" module sets up it will check to see that "YourApp->isa("Catalyst::Plugin::Session::State")".
When you write a session state plugin you should subclass this module this reason only.

WRITING STATE PLUGINS

To write a session state plugin you usually need to extend two methods:
prepare_(action|cookies|whatever)
Set "sessionid" (accessor) at prepare time using data in the request.
 
Note that this must happen before other "prepare_action" instances, in order to get along with Catalyst::Plugin::Session. Overriding "prepare_cookies" is probably the stablest approach.
finalize
Modify the response at to include the session ID if "sessionid" is defined, using whatever scheme you use. For example, set a cookie,
2015-01-26 perl v5.20.2