Java Doc for ManagerBase.java in » Sevlet-Container » apache-tomcat-6.0.14 » org » apache » catalina » session » 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.session

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.catalina.session .ManagerBase

All known Subclasses:   org.apache.catalina.session .StandardManager,  org.apache.catalina.ha.session .ClusterManagerBase,  org.apache.catalina.session .PersistentManagerBase,
ManagerBase
abstract public class ManagerBase implements Manager,MBeanRegistration(Code)
Minimal implementation of the Manager interface that supports no session persistence or distributable capabilities. This class may be subclassed to create more sophisticated Manager implementations.
author:
   Craig R. McClanahan
version:
   $Revision: 531901 $ $Date: 2007-04-24 14:24:34 +0200 (mar., 24 avr. 2007) $

Field Summary
final protected static String DEFAULT_ALGORITHM
     The default message digest algorithm to use if we cannot use the requested one.
protected String algorithm
     The message digest algorithm to be used when generating session identifiers.
protected Container container
     The Container with which this Manager is associated.
protected String devRandomSource

protected MessageDigest digest
     Return the MessageDigest implementation to be used when creating session identifiers.
protected boolean distributable
     The distributable flag for Sessions created by this Manager.
protected String domain

protected int duplicates

protected String entropy
     A String initialization parameter used to increase the entropy of the initialization of our random number generator.
protected int expiredSessions
     Number of sessions that have expired.
protected boolean initialized

protected Log log

protected int maxActive

protected int maxInactiveInterval
     The default maximum inactive interval for Sessions created by this Manager.
protected MBeanServer mserver

protected static String name
     The descriptive name of this Manager implementation (for logging).
protected ObjectName oname

protected int processExpiresFrequency
     Frequency of the session expiration, and related manager operations.
protected long processingTime
     Processing time during session expiration.
protected Random random
     A random number generator to use when generating session identifiers.
protected String randomClass
     The Java class name of the random number generator class to be used when generating session identifiers.
protected DataInputStream randomIS

protected int sessionAverageAliveTime
     Average time (in seconds) that expired sessions had been alive.
protected int sessionCounter

protected int sessionIdLength
     The session id length of Sessions created by this Manager.
protected int sessionMaxAliveTime
     The longest time (in seconds) that an expired session had been alive.
protected Map sessions
     The set of currently active Sessions for this Manager, keyed by session identifier.
protected static StringManager sm
     The string manager for this package.
protected PropertyChangeSupport support
     The property change support for this component.

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()

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 void destroy()

public void expireSession(String sessionId)

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.
protected synchronized String generateSessionId()
     Generate and return a new session identifier.
public int getActiveSessions()

public String getAlgorithm()
     Return the message digest algorithm for this Manager.
public String getClassName()
     Returns the name of the implementation class.
public Container getContainer()
     Return the Container with which this Manager is associated.
public synchronized MessageDigest getDigest()
     Return the MessageDigest object to be used for calculating session identifiers.
public boolean getDistributable()
     Return the distributable flag for the sessions supported by this Manager.
public String getDomain()

public int getDuplicates()
     Number of duplicated session IDs generated by the random source.
public Engine getEngine()
     Retrieve the enclosing Engine for this Manager.
public String getEntropy()
     Return the entropy increaser value, or compute a semi-useful value if this String has not yet been set.
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 String getJvmRoute()
     Retrieve the JvmRoute for the enclosing Engine.
public String getLastAccessedTime(String sessionId)

public int getMaxActive()

public int getMaxInactiveInterval()
     Return the default maximum inactive interval (in seconds) for Sessions created by this Manager.
public String getName()
     Return the descriptive short name of this Manager implementation.
protected StandardSession getNewSession()
     Get new session class to be used in the doLoad() method.
public ObjectName getObjectName()

public int getProcessExpiresFrequency()
     Return the frequency of manager checks.
public long getProcessingTime()

public Random getRandom()
     Return the random number generator instance we should use for generating session identifiers.
protected void getRandomBytes(byte bytes)

public String getRandomClass()
     Return the random number generator class name.
public String getRandomFile()

public HashMap getSession(String sessionId)
     Returns information about the session with the given session id.
public String getSessionAttribute(String sessionId, String key)

public int getSessionAverageAliveTime()
     Gets the average time (in seconds) that expired sessions had been alive.
public int getSessionCounter()
     Total 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 init()

public String listSessionIds()

public void postDeregister()

public void postRegister(Boolean registrationDone)

public void preDeregister()

public ObjectName preRegister(MBeanServer server, ObjectName name)

public void processExpires()
     Invalidate all sessions that have expired.
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 setAlgorithm(String algorithm)
     Set the message digest algorithm for this Manager.
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 setDuplicates(int duplicates)

public void setEntropy(String entropy)
     Set the entropy increaser value.
public void setExpiredSessions(int expiredSessions)
     Sets the number of sessions that have expired.
public void setMaxActive(int maxActive)

public void setMaxInactiveInterval(int interval)
     Set the default maximum inactive interval (in seconds) for Sessions created by this Manager.
public void setProcessExpiresFrequency(int processExpiresFrequency)
     Set the manager checks frequency.
public void setProcessingTime(long processingTime)

public void setRandomClass(String randomClass)
     Set the random number generator class name.
public void setRandomFile(String s)
     Use /dev/random-type special device.
public void setSessionAverageAliveTime(int sessionAverageAliveTime)
     Sets the average time (in seconds) that expired sessions had been alive.
public void setSessionCounter(int sessionCounter)

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.

Field Detail
DEFAULT_ALGORITHM
final protected static String DEFAULT_ALGORITHM(Code)
The default message digest algorithm to use if we cannot use the requested one.

algorithm
protected String algorithm(Code)
The message digest algorithm to be used when generating session identifiers. This must be an algorithm supported by the java.security.MessageDigest class on your platform.

container
protected Container container(Code)
The Container with which this Manager is associated.

devRandomSource
protected String devRandomSource(Code)

digest
protected MessageDigest digest(Code)
Return the MessageDigest implementation to be used when creating session identifiers.

distributable
protected boolean distributable(Code)
The distributable flag for Sessions created by this Manager. If this flag is set to true, any user attributes added to a session controlled by this Manager must be Serializable.

domain
protected String domain(Code)

duplicates
protected int duplicates(Code)

entropy
protected String entropy(Code)
A String initialization parameter used to increase the entropy of the initialization of our random number generator.

expiredSessions
protected int expiredSessions(Code)
Number of sessions that have expired.

initialized
protected boolean initialized(Code)

log
protected Log log(Code)

maxActive
protected int maxActive(Code)

maxInactiveInterval
protected int maxInactiveInterval(Code)
The default maximum inactive interval for Sessions created by this Manager.

mserver
protected MBeanServer mserver(Code)

name
protected static String name(Code)
The descriptive name of this Manager implementation (for logging).

oname
protected ObjectName oname(Code)

processExpiresFrequency
protected int processExpiresFrequency(Code)
Frequency of the session expiration, and related manager operations. Manager operations will be done once for the specified amount of backgrondProcess calls (ie, the lower the amount, the most often the checks will occur).

processingTime
protected long processingTime(Code)
Processing time during session expiration.

random
protected Random random(Code)
A random number generator to use when generating session identifiers.

randomClass
protected String randomClass(Code)
The Java class name of the random number generator class to be used when generating session identifiers.

randomIS
protected DataInputStream randomIS(Code)

sessionAverageAliveTime
protected int sessionAverageAliveTime(Code)
Average time (in seconds) that expired sessions had been alive.

sessionCounter
protected int sessionCounter(Code)

sessionIdLength
protected int sessionIdLength(Code)
The session id length of Sessions created by this Manager.

sessionMaxAliveTime
protected int sessionMaxAliveTime(Code)
The longest time (in seconds) that an expired session had been alive.

sessions
protected Map sessions(Code)
The set of currently active Sessions for this Manager, keyed by session identifier.

sm
protected static StringManager sm(Code)
The string manager for this package.

support
protected PropertyChangeSupport support(Code)
The property change support for this component.

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)
Implements the Manager interface, direct call to processExpires

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, a new session id will begenerated
exception:
  IllegalStateException - if a new session cannot beinstantiated for any reason

destroy
public void destroy()(Code)

expireSession
public void expireSession(String sessionId)(Code)

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.

generateSessionId
protected synchronized String generateSessionId()(Code)
Generate and return a new session identifier.

getActiveSessions
public int getActiveSessions()(Code)
Returns the number of active sessions number of sessions active

getAlgorithm
public String getAlgorithm()(Code)
Return the message digest algorithm for this Manager.

getClassName
public String getClassName()(Code)
Returns the name of the implementation class.

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

getDigest
public synchronized MessageDigest getDigest()(Code)
Return the MessageDigest object to be used for calculating session identifiers. If none has been created yet, initialize one the first time this method is called.

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

getDomain
public String getDomain()(Code)

getDuplicates
public int getDuplicates()(Code)
Number of duplicated session IDs generated by the random source. Anything bigger than 0 means problems. The count of duplicates

getEngine
public Engine getEngine()(Code)
Retrieve the enclosing Engine for this Manager. an Engine object (or null).

getEntropy
public String getEntropy()(Code)
Return the entropy increaser value, or compute a semi-useful value if this String has not yet been set.

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>.

getJvmRoute
public String getJvmRoute()(Code)
Retrieve the JvmRoute for the enclosing Engine. the JvmRoute or null.

getLastAccessedTime
public String getLastAccessedTime(String sessionId)(Code)

getMaxActive
public int getMaxActive()(Code)
Max number of concurrent active sessions The highest number of concurrent active sessions

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

getName
public String getName()(Code)
Return the descriptive short name of this Manager implementation.

getNewSession
protected StandardSession getNewSession()(Code)
Get new session class to be used in the doLoad() method.

getObjectName
public ObjectName getObjectName()(Code)

getProcessExpiresFrequency
public int getProcessExpiresFrequency()(Code)
Return the frequency of manager checks.

getProcessingTime
public long getProcessingTime()(Code)

getRandom
public Random getRandom()(Code)
Return the random number generator instance we should use for generating session identifiers. If there is no such generator currently defined, construct and seed a new one.

getRandomBytes
protected void getRandomBytes(byte bytes)(Code)

getRandomClass
public String getRandomClass()(Code)
Return the random number generator class name.

getRandomFile
public String getRandomFile()(Code)

getSession
public HashMap getSession(String sessionId)(Code)
Returns information about the session with the given session id.
The session information is organized as a HashMap, mapping session attribute names to the String representation of their values.
Parameters:
  sessionId - Session id HashMap mapping session attribute names to the Stringrepresentation of their values, or null if no session with thespecified id exists, or if the session does not have any attributes

getSessionAttribute
public String getSessionAttribute(String sessionId, String key)(Code)
For debugging: get a session attribute
Parameters:
  sessionId -
Parameters:
  key - The attribute value, if found, null otherwise

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)
Total sessions created by this manager. sessions created

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.

init
public void init()(Code)

listSessionIds
public String listSessionIds()(Code)
For debugging: return a list of all session ids currently active

postDeregister
public void postDeregister()(Code)

postRegister
public void postRegister(Boolean registrationDone)(Code)

preDeregister
public void preDeregister() throws Exception(Code)

preRegister
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception(Code)

processExpires
public void processExpires()(Code)
Invalidate all sessions that have expired.

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

setAlgorithm
public void setAlgorithm(String algorithm)(Code)
Set the message digest algorithm for this Manager.
Parameters:
  algorithm - The new message digest algorithm

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

setDuplicates
public void setDuplicates(int duplicates)(Code)

setEntropy
public void setEntropy(String entropy)(Code)
Set the entropy increaser value.
Parameters:
  entropy - The new entropy increaser value

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)

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

setProcessExpiresFrequency
public void setProcessExpiresFrequency(int processExpiresFrequency)(Code)
Set the manager checks frequency.
Parameters:
  processExpiresFrequency - the new manager checks frequency

setProcessingTime
public void setProcessingTime(long processingTime)(Code)

setRandomClass
public void setRandomClass(String randomClass)(Code)
Set the random number generator class name.
Parameters:
  randomClass - The new random number generator class name

setRandomFile
public void setRandomFile(String s)(Code)
Use /dev/random-type special device. This is new code, but may reduce the big delay in generating the random. You must specify a path to a random generator file. Use /dev/urandom for linux ( or similar ) systems. Use /dev/random for maximum security ( it may block if not enough "random" exist ). You can also use a pipe that generates random. The code will check if the file exists, and default to java Random if not found. There is a significant performance difference, very visible on the first call to getSession ( like in the first JSP ) - so use it if available.

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)

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.

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.