Wombat::Session - internal session interface
This interface extends Servlet::Http::HttpSession to provide
fields and methods accessible only to the container.
getAuthType()
-
Return the authentication type used to authenticate the cached
principal, if any.
setAuthType($authType)
-
Set the authentication type used to authenticate the cached principal,
if any.
Parameters:
- $authType
-
the authentication type
setCreationTime(time)
-
Set the creation time for this Session. This method is called by the
SessionManager when a Session instance is created or an existing
Session instance is reused.
Parameters:
- $time
-
the creation time, in seconds since the epoch
setId($id)
-
Set the session identifier for this Session.
Parameters:
- $id
-
the session identifier
setNew($flag)
-
Set a flag specifying whether or not the session is newly created.
Parameters:
- $flag
-
the boolean value to set
getPrincipal()
-
Return the authenticated principal for this Session, or
undef
if
there is none.
setPrincipal($principal)
-
Set the authenticated principal for this Session.
Parameters:
- $principal
-
the new principal
getSession()
-
Return the HttpSession which acts as a facade for this Session to
servlet applications.
getSessionManager()
-
Return the SessionManager which manages this Session.
setSessionManager($manager)
-
Set the SessionManager which manages this Session.
Parameters:
- $manager
-
the Wombat::SessionManager
isValid()
-
Return a flag specifying whether or not the session is valid.
setValid($flag)
-
Set a flag specifying whether or not the session is valid.
Parameters:
- $flag
-
the boolean value to set
access()
-
Update the accessed time information for this Session. This method
should be called by the Application when processing a Request, even if
the Application does not reference it.
expire()
-
Perform the internal processing required to invalidate this session,
without triggering an exception if the session has already expired.
recycle()
-
Release all object references and initialize instances variables in
preparation for use or reuse of this object.
the Servlet::Http::HttpSession manpage,
the Wombat::SessionManager manpage
Brian Moseley, bcm@maz.org