Java Doc for Manager.java in » Sevlet-Container » apache-tomcat-6.0.14 » org » apache » catalina » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Sevlet Container » apache tomcat 6.0.14 » org.apache.catalina

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.catalina .Manager

All known Subclasses:   org.apache.catalina.session .ManagerBase,
Manager
public interface Manager (Code)
A Manager manages the pool of Sessions that are associated with a particular Container. Different Manager implementations may support value-added features such as the persistent storage of session data, as well as migrating sessions for distributable web applications.
In order for a Manager implementation to successfully operate with a Context implementation that implements reloading, it must obey the following constraints:

Must implement Lifecycle so that the Context can indicate that a restart is required.
Must allow a call to stop() to be followed by a call to start() on the same Manager instance.

author:
   Craig R. McClanahan
version:
   $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $

Method Summary
public void add(Session session)
     Add this Session to the set of active Sessions for this Manager.
public void addPropertyChangeListener(PropertyChangeListener listener)
     Add a property change listener to this component.
public void backgroundProcess()
     This method will be invoked by the context/container on a periodic basis and allows the manager to implement a method that executes periodic tasks, such as expiring sessions etc.
public Session createEmptySession()
     Get a session from the recycled ones or create a new empty one.
public Session createSession()
     Construct and return a new session object, based on the default settings specified by this Manager's properties.
public Session createSession(String sessionId)
     Construct and return a new session object, based on the default settings specified by this Manager's properties.
public Session findSession(String id)
     Return the active Session, associated with this Manager, with the specified session id (if any); otherwise return null.
public Session[] findSessions()
     Return the set of active Sessions associated with this Manager.
public int getActiveSessions()
     Gets the number of currently active sessions.
public Container getContainer()
     Return the Container with which this Manager is associated.
public boolean getDistributable()
     Return the distributable flag for the sessions supported by this Manager.
public int getExpiredSessions()
     Gets the number of sessions that have expired.
public String getInfo()
     Return descriptive information about this Manager implementation and the corresponding version number, in the format <description>/<version>.
public int getMaxActive()
     Gets the maximum number of sessions that have been active at the same time.
public int getMaxInactiveInterval()
     Return the default maximum inactive interval (in seconds) for Sessions created by this Manager.
public int getRejectedSessions()
     Gets the number of sessions that were not created because the maximum number of active sessions was reached.
public int getSessionAverageAliveTime()
     Gets the average time (in seconds) that expired sessions had been alive.
public int getSessionCounter()
     Returns the total number of sessions created by this manager.
public int getSessionIdLength()
     Gets the session id length (in bytes) of Sessions created by this Manager.
public int getSessionMaxAliveTime()
     Gets the longest time (in seconds) that an expired session had been alive.
public void load()
     Load any currently active sessions that were previously unloaded to the appropriate persistence mechanism, if any.
public void remove(Session session)
     Remove this Session from the active Sessions for this Manager.
public void removePropertyChangeListener(PropertyChangeListener listener)
     Remove a property change listener from this component.
public void setContainer(Container container)
     Set the Container with which this Manager is associated.
public void setDistributable(boolean distributable)
     Set the distributable flag for the sessions supported by this Manager.
public void setExpiredSessions(int expiredSessions)
     Sets the number of sessions that have expired.
public void setMaxActive(int maxActive)
     (Re)sets the maximum number of sessions that have been active at the same time.
public void setMaxInactiveInterval(int interval)
     Set the default maximum inactive interval (in seconds) for Sessions created by this Manager.
public void setRejectedSessions(int rejectedSessions)
     Sets the number of sessions that were not created because the maximum number of active sessions was reached.
public void setSessionAverageAliveTime(int sessionAverageAliveTime)
     Sets the average time (in seconds) that expired sessions had been alive.
public void setSessionCounter(int sessionCounter)
     Sets the total number of sessions created by this manager.
public void setSessionIdLength(int idLength)
     Sets the session id length (in bytes) for Sessions created by this Manager.
public void setSessionMaxAliveTime(int sessionMaxAliveTime)
     Sets the longest time (in seconds) that an expired session had been alive.
public void unload()
     Save any currently active sessions in the appropriate persistence mechanism, if any.

Method Detail
add
public void add(Session session)(Code)
Add this Session to the set of active Sessions for this Manager.
Parameters:
  session - Session to be added

addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)(Code)
Add a property change listener to this component.
Parameters:
  listener - The listener to add

backgroundProcess
public void backgroundProcess()(Code)
This method will be invoked by the context/container on a periodic basis and allows the manager to implement a method that executes periodic tasks, such as expiring sessions etc.

createEmptySession
public Session createEmptySession()(Code)
Get a session from the recycled ones or create a new empty one. The PersistentManager manager does not need to create session data because it reads it from the Store.

createSession
public Session createSession()(Code)
Construct and return a new session object, based on the default settings specified by this Manager's properties. The session id will be assigned by this method, and available via the getId() method of the returned session. If a new session cannot be created for any reason, return null.
exception:
  IllegalStateException - if a new session cannot beinstantiated for any reason

createSession
public Session createSession(String sessionId)(Code)
Construct and return a new session object, based on the default settings specified by this Manager's properties. The session id specified will be used as the session id. If a new session cannot be created for any reason, return null.
Parameters:
  sessionId - The session id which should be used to create thenew session; if null, the sessionid will be assigned by this method, and available via the getId()method of the returned session.
exception:
  IllegalStateException - if a new session cannot beinstantiated for any reason

findSession
public Session findSession(String id) throws IOException(Code)
Return the active Session, associated with this Manager, with the specified session id (if any); otherwise return null.
Parameters:
  id - The session id for the session to be returned
exception:
  IllegalStateException - if a new session cannot beinstantiated for any reason
exception:
  IOException - if an input/output error occurs whileprocessing this request

findSessions
public Session[] findSessions()(Code)
Return the set of active Sessions associated with this Manager. If this Manager has no active Sessions, a zero-length array is returned.

getActiveSessions
public int getActiveSessions()(Code)
Gets the number of currently active sessions. Number of currently active sessions

getContainer
public Container getContainer()(Code)
Return the Container with which this Manager is associated.

getDistributable
public boolean getDistributable()(Code)
Return the distributable flag for the sessions supported by this Manager.

getExpiredSessions
public int getExpiredSessions()(Code)
Gets the number of sessions that have expired. Number of sessions that have expired

getInfo
public String getInfo()(Code)
Return descriptive information about this Manager implementation and the corresponding version number, in the format <description>/<version>.

getMaxActive
public int getMaxActive()(Code)
Gets the maximum number of sessions that have been active at the same time. Maximum number of sessions that have been active at the sametime

getMaxInactiveInterval
public int getMaxInactiveInterval()(Code)
Return the default maximum inactive interval (in seconds) for Sessions created by this Manager.

getRejectedSessions
public int getRejectedSessions()(Code)
Gets the number of sessions that were not created because the maximum number of active sessions was reached. Number of rejected sessions

getSessionAverageAliveTime
public int getSessionAverageAliveTime()(Code)
Gets the average time (in seconds) that expired sessions had been alive. Average time (in seconds) that expired sessions had beenalive.

getSessionCounter
public int getSessionCounter()(Code)
Returns the total number of sessions created by this manager. Total number of sessions created by this manager.

getSessionIdLength
public int getSessionIdLength()(Code)
Gets the session id length (in bytes) of Sessions created by this Manager. The session id length

getSessionMaxAliveTime
public int getSessionMaxAliveTime()(Code)
Gets the longest time (in seconds) that an expired session had been alive. Longest time (in seconds) that an expired session had beenalive.

load
public void load() throws ClassNotFoundException, IOException(Code)
Load any currently active sessions that were previously unloaded to the appropriate persistence mechanism, if any. If persistence is not supported, this method returns without doing anything.
exception:
  ClassNotFoundException - if a serialized class cannot befound during the reload
exception:
  IOException - if an input/output error occurs

remove
public void remove(Session session)(Code)
Remove this Session from the active Sessions for this Manager.
Parameters:
  session - Session to be removed

removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)(Code)
Remove a property change listener from this component.
Parameters:
  listener - The listener to remove

setContainer
public void setContainer(Container container)(Code)
Set the Container with which this Manager is associated.
Parameters:
  container - The newly associated Container

setDistributable
public void setDistributable(boolean distributable)(Code)
Set the distributable flag for the sessions supported by this Manager. If this flag is set, all user data objects added to sessions associated with this manager must implement Serializable.
Parameters:
  distributable - The new distributable flag

setExpiredSessions
public void setExpiredSessions(int expiredSessions)(Code)
Sets the number of sessions that have expired.
Parameters:
  expiredSessions - Number of sessions that have expired

setMaxActive
public void setMaxActive(int maxActive)(Code)
(Re)sets the maximum number of sessions that have been active at the same time.
Parameters:
  maxActive - Maximum number of sessions that have been active atthe same time.

setMaxInactiveInterval
public void setMaxInactiveInterval(int interval)(Code)
Set the default maximum inactive interval (in seconds) for Sessions created by this Manager.
Parameters:
  interval - The new default value

setRejectedSessions
public void setRejectedSessions(int rejectedSessions)(Code)
Sets the number of sessions that were not created because the maximum number of active sessions was reached.
Parameters:
  rejectedSessions - Number of rejected sessions

setSessionAverageAliveTime
public void setSessionAverageAliveTime(int sessionAverageAliveTime)(Code)
Sets the average time (in seconds) that expired sessions had been alive.
Parameters:
  sessionAverageAliveTime - Average time (in seconds) that expiredsessions had been alive.

setSessionCounter
public void setSessionCounter(int sessionCounter)(Code)
Sets the total number of sessions created by this manager.
Parameters:
  sessionCounter - Total number of sessions created by this manager.

setSessionIdLength
public void setSessionIdLength(int idLength)(Code)
Sets the session id length (in bytes) for Sessions created by this Manager.
Parameters:
  idLength - The session id length

setSessionMaxAliveTime
public void setSessionMaxAliveTime(int sessionMaxAliveTime)(Code)
Sets the longest time (in seconds) that an expired session had been alive.
Parameters:
  sessionMaxAliveTime - Longest time (in seconds) that an expiredsession had been alive.

unload
public void unload() throws IOException(Code)
Save any currently active sessions in the appropriate persistence mechanism, if any. If persistence is not supported, this method returns without doing anything.
exception:
  IOException - if an input/output error occurs

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.