Wombat::SessionManager - internal session manager interface

- NAME
- SYNOPSIS
- DESCRIPTION
- ACCESSOR METHODS
- PUBLIC METHODS
- SEE ALSO
- AUTHOR

# NAME

Wombat::SessionManager - internal session manager interface

# SYNOPSIS

# DESCRIPTION

This interface specifies a component that manages a pool of Sessions for a Container.

# ACCESSOR METHODS

`getContainer()`
  Return the Container for which this SessionManager manages Sessions.

`setContainer($container)`
  Set the Container for which this SessionManager manages Sessions.

  Parameters:

  $container
    the Wombat::Container

`getMaxInactiveInterval()`
  Return the default maximum inactive interval in seconds for Sessions created by this SessionManager.

`setMaxInactiveInterval($interval)`
  Set the default maximum inactive interval for Sessions created by this SessionManager.

  Parameters:

  $interval
    the new interval, in seconds

`getName()`
  Return the display name of this SessionManager. Subclasses MUST override this method.

# PUBLIC METHODS

`add($session)`
  Add this Session to the set of active Sessions for this SessionManager.

  Parameters:

  $session
    the Wombat::Session to be added

`createSession()`
  Construct and return a Wombat::Session, based on the default settings specified by this SessionManager's fields. The session id will be assigned by this method.

  Throws:

  Servlet::Util::IllegalStateException
    if a new Session cannot be created for, any reason

`getSession($id)`
  Return the active Session managed by this SessionManager with the specified id, or `undef` if no session exists with that id or if the session is not valid.

  Parameters:

  $id
    the id for the Session to be returned

  Throws:

  Servlet::Util::IllegalStateException
    if the session exists but cannot be returned, for any reason

`getSessions()`
  Return an array containing the active Sessions managed by this SessionManager.

`remove($session)`
  Remove this Session from the active Sessions managed by this SessionManager.

  Parameters:

  $session
    the Wombat::Session to be added

# SEE ALSO

the Wombat::Container manpage, the Wombat::Session manpage

# AUTHOR

Brian Moseley, bcm@maz.org