org.jboss.metadata.web.jboss
Class PassivationConfig

java.lang.Object
  org.jboss.metadata.javaee.support.IdMetaDataImpl
      org.jboss.metadata.web.jboss.PassivationConfig

All Implemented Interfaces:

Serializable, Cloneable, IdMetaData

public class PassivationConfig
extends IdMetaDataImpl

Represents a element of the jboss-web.xml deployment descriptor

Version:

$Revision: 67676 $

Author:

Brian Stansberry

See Also:

Serialized Form

Constructor Summary

PassivationConfig()

Method Summary

Integer	getMaxObjects() Gets the maximum number of cached ReplicationGranularity.FIELD session attribute objects before the session management layer should begin passivating them to persistent storage.
Integer	getObjectMaxIdleTime() Gets the maximum time (in seconds) cached ReplicationGranularity.FIELD session attribute objects can remain unaccessed before the session management layer should begin passivating them to persistent storage.
Integer	getPassivationMaxIdleTime() Gets the max time (seconds) the session must be idle after which it's eligible for passivation whether or not maxActiveSessions has been reached.
Integer	getPassivationMinIdleTime() Gets the min time (seconds) a session must be idle before it's eligible for passivation.
Boolean	getUseSessionPassivation() Gets whether passivation is enabled for this webapp.
void	setMaxObjects(Integer maxObjects) Sets the maximum number of cached ReplicationGranularity.FIELD session attribute objects before the session management layer should begin passivating them to persistent storage.
void	setObjectMaxIdleTime(Integer objectMaxIdleTime) Sets the maximum time (in seconds) cached ReplicationGranularity.FIELD session attribute objects can remain unaccessed before the session management layer should begin passivating them to persistent storage.
void	setPassivationMaxIdleTime(Integer passivationMaxIdleTime) Sets the max time (seconds) the session must be idle after which it's eligible for passivation whether or not maxActiveSessions has been reached.
void	setPassivationMinIdleTime(Integer passivationMinIdleTime) Sets the min time (seconds) a session must be idle before it's eligible for passivation.
void	setUseSessionPassivation(Boolean useSessionPassivation) Sets whether passivation is enabled for this webapp.

Methods inherited from class org.jboss.metadata.javaee.support.IdMetaDataImpl

clone, equals, getId, hashCode, merge, merge, setId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PassivationConfig

public PassivationConfig()

Method Detail

getPassivationMaxIdleTime

public Integer getPassivationMaxIdleTime()

Gets the max time (seconds) the session must be idle after which it's eligible for passivation whether or not maxActiveSessions has been reached.

setPassivationMaxIdleTime

public void setPassivationMaxIdleTime(Integer passivationMaxIdleTime)

Sets the max time (seconds) the session must be idle after which it's eligible for passivation whether or not maxActiveSessions has been reached.

getPassivationMinIdleTime

public Integer getPassivationMinIdleTime()

Gets the min time (seconds) a session must be idle before it's eligible for passivation. This overrides the maxActiveSessions config, to prevent thrashing if the there are lots of active sessions. Setting to -1 means it's ignored

setPassivationMinIdleTime

public void setPassivationMinIdleTime(Integer passivationMinIdleTime)

Sets the min time (seconds) a session must be idle before it's eligible for passivation. This overrides the maxActiveSessions config, to prevent thrashing if the there are lots of active sessions. Setting to -1 means it's ignored

getUseSessionPassivation

public Boolean getUseSessionPassivation()

Gets whether passivation is enabled for this webapp.

setUseSessionPassivation

public void setUseSessionPassivation(Boolean useSessionPassivation)

Sets whether passivation is enabled for this webapp.

getMaxObjects

public Integer getMaxObjects()

Gets the maximum number of cached ReplicationGranularity.FIELD session attribute objects before the session management layer should begin passivating them to persistent storage.

Returns:

the maximum number of objects, or null

setMaxObjects

public void setMaxObjects(Integer maxObjects)

Sets the maximum number of cached ReplicationGranularity.FIELD session attribute objects before the session management layer should begin passivating them to persistent storage.

Parameters:

maxObjects - the maximum number of objects. Note that if a complex object graph is passed to setAttribute(), the number of cached objects is increased by the number of objects in the graph, not by 1. Primitive objects (i.e. java.lang.String, java.lang.Number) included within a complex object graph do not increase the total. If set to null or a value less than one, the number of objects is not considered.

getObjectMaxIdleTime

public Integer getObjectMaxIdleTime()

Gets the maximum time (in seconds) cached ReplicationGranularity.FIELD session attribute objects can remain unaccessed before the session management layer should begin passivating them to persistent storage. Only relevant if ReplicationGranularity.FIELD is used.

Returns:

the maximum idle time, or null. A value less than 1 means object idle time should not be considered.

setObjectMaxIdleTime

public void setObjectMaxIdleTime(Integer objectMaxIdleTime)

Sets the maximum time (in seconds) cached ReplicationGranularity.FIELD session attribute objects can remain unaccessed before the session management layer should begin passivating them to persistent storage. Only relevant if ReplicationGranularity.FIELD is used.

Parameters:

objectIdleTime - the maximum idle time. A value of null or less than 1 means object idle time should not be considered.