The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
IX / Wombat-0.7.1 / docs / api / Wombat / SessionManager.html 
<HTML>
<HEAD>
<TITLE>Wombat::SessionManager - internal session manager interface</TITLE>
<LINK REL="stylesheet" HREF="../../wombat.css" TYPE="text/css">
<LINK REV="made" HREF="mailto:feedback@suse.de">
</HEAD>

<BODY>

<A NAME="__index__"></A>
<!-- INDEX BEGIN -->

<UL>

	<LI><A HREF="#name">NAME</A></LI>
	<LI><A HREF="#synopsis">SYNOPSIS</A></LI>
	<LI><A HREF="#description">DESCRIPTION</A></LI>
	<LI><A HREF="#accessor methods">ACCESSOR METHODS</A></LI>
	<LI><A HREF="#public methods">PUBLIC METHODS</A></LI>
	<LI><A HREF="#see also">SEE ALSO</A></LI>
	<LI><A HREF="#author">AUTHOR</A></LI>
</UL>
<!-- INDEX END -->

<HR>
<P>
<HR>
<H1><A NAME="name">NAME</A></H1>
<P>Wombat::SessionManager - internal session manager interface</P>
<P>
<HR>
<H1><A NAME="synopsis">SYNOPSIS</A></H1>
<P>
<HR>
<H1><A NAME="description">DESCRIPTION</A></H1>
<P>This interface specifies a component that manages a pool of Sessions
for a Container.</P>
<P>
<HR>
<H1><A NAME="accessor methods">ACCESSOR METHODS</A></H1>
<DL>
<DT><STRONG><A NAME="item_getContainer"><CODE>getContainer()</CODE></A></STRONG><BR>
<DD>
Return the Container for which this SessionManager manages Sessions.
<P></P>
<DT><STRONG><A NAME="item_setContainer"><CODE>setContainer($container)</CODE></A></STRONG><BR>
<DD>
Set the Container for which this SessionManager manages Sessions.
<P><STRONG>Parameters:</STRONG></P>
<DL>
<DT><STRONG><A NAME="item_%24container">$container</A></STRONG><BR>
<DD>
the <STRONG>Wombat::Container</STRONG>
<P></P></DL>
<DT><STRONG><A NAME="item_getMaxInactiveInterval"><CODE>getMaxInactiveInterval()</CODE></A></STRONG><BR>
<DD>
Return the default maximum inactive interval in seconds for Sessions
created by this SessionManager.
<P></P>
<DT><STRONG><A NAME="item_setMaxInactiveInterval"><CODE>setMaxInactiveInterval($interval)</CODE></A></STRONG><BR>
<DD>
Set the default maximum inactive interval for Sessions created by this
SessionManager.
<P><STRONG>Parameters:</STRONG></P>
<DL>
<DT><STRONG><A NAME="item_%24interval">$interval</A></STRONG><BR>
<DD>
the new interval, in seconds
<P></P></DL>
<DT><STRONG><A NAME="item_getName"><CODE>getName()</CODE></A></STRONG><BR>
<DD>
Return the display name of this SessionManager. Subclasses <STRONG>MUST</STRONG>
override this method.
<P></P></DL>
<P>
<HR>
<H1><A NAME="public methods">PUBLIC METHODS</A></H1>
<DL>
<DT><STRONG><A NAME="item_add"><CODE>add($session)</CODE></A></STRONG><BR>
<DD>
Add this Session to the set of active Sessions for this
SessionManager.
<P><STRONG>Parameters:</STRONG></P>
<DL>
<DT><STRONG><A NAME="item_%24session">$session</A></STRONG><BR>
<DD>
the <STRONG>Wombat::Session</STRONG> to be added
<P></P></DL>
<DT><STRONG><A NAME="item_createSession"><CODE>createSession()</CODE></A></STRONG><BR>
<DD>
Construct and return a <STRONG>Wombat::Session</STRONG>, based on the default
settings specified by this SessionManager's fields. The session id
will be assigned by this method.
<P><STRONG>Throws:</STRONG></P>
<DL>
<DT><STRONG><A NAME="item_Servlet%3A%3AUtil%3A%3AIllegalStateException"><STRONG>Servlet::Util::IllegalStateException</STRONG></A></STRONG><BR>
<DD>
if a new Session cannot be created for, any reason
<P></P></DL>
<DT><STRONG><A NAME="item_getSession"><CODE>getSession($id)</CODE></A></STRONG><BR>
<DD>
Return the active Session managed by this SessionManager with the
specified id, or <CODE>undef</CODE> if no session exists with that id or if the
session is not valid.
<P><STRONG>Parameters:</STRONG></P>
<DL>
<DT><STRONG><A NAME="item_%24id">$id</A></STRONG><BR>
<DD>
the id for the Session to be returned
<P></P></DL>
<P><STRONG>Throws:</STRONG></P>
<DL>
<DT><STRONG><STRONG>Servlet::Util::IllegalStateException</STRONG></STRONG><BR>
<DD>
if the session exists but cannot be returned, for any reason
<P></P></DL>
<DT><STRONG><A NAME="item_getSessions"><CODE>getSessions()</CODE></A></STRONG><BR>
<DD>
Return an array containing the active Sessions managed by this
SessionManager.
<P></P>
<DT><STRONG><A NAME="item_remove"><CODE>remove($session)</CODE></A></STRONG><BR>
<DD>
Remove this Session from the active Sessions managed by this
SessionManager.
<P><STRONG>Parameters:</STRONG></P>
<DL>
<DT><STRONG>$session</STRONG><BR>
<DD>
the <STRONG>Wombat::Session</STRONG> to be added
<P></P></DL>
</DL>
<P>
<HR>
<H1><A NAME="see also">SEE ALSO</A></H1>
<P><A HREF="../../api/Wombat/Container.html">the Wombat::Container manpage</A>,
<A HREF="../../api/Wombat/Session.html">the Wombat::Session manpage</A></P>
<P>
<HR>
<H1><A NAME="author">AUTHOR</A></H1>
<P>Brian Moseley, <A HREF="mailto:bcm@maz.org">bcm@maz.org</A></P>

</BODY>

</HTML>