public class ConfigurationImpl extends Object implements SplitSessionCollectionConfiguration, Serializable
SessionHelperConfiguration
HttpSessionCollectionConfiguration
and
SplitSessionCollectionConfiguration
interfaces.Constructor and Description |
---|
ConfigurationImpl() |
Modifier and Type | Method and Description |
---|---|
String |
checkCompatible(com.tangosol.coherence.servlet.ValidatingConfiguration configuration)
Compares an existing configuration with a new one.
|
String |
getApplicationName()
Return the name of the web application.
|
int |
getAsyncExitDelayMillis()
The length of time to defer async exit on a session that is accessed
"out of context".
|
protected static boolean |
getBooleanValue(XmlElement xml,
String param,
boolean defaultValue) |
String |
getCacheConfigurationPath()
Get the user configured cache-config.xml, Default is session-cache-config.
|
String |
getCacheDelegatorClassName()
The fully qualified class name of the CacheDelegator implementation to use.
|
int |
getDaemonMaxThreads()
The maximum number of threads used by the session reaper daemon.
|
int |
getDaemonMinThreads()
The minimum number of threads used by the session reaper daemon.
|
int |
getDaemonQueueSize()
The queue size of the session reaper daemon work manager.
|
String |
getDistControllerClassName()
The name of an implementation of the SessionDistributionController
interface to use.
|
String |
getHttpSessionCollectionClassName()
The name of the class implementing HttpSessionCollection.
|
protected static int |
getIntValue(XmlElement xml,
String param,
int defaultValue) |
String |
getLocalAttributesCacheName()
The name of the local cache that stores non-distributed session attributes
(if allowed.)
|
String |
getLocalSessionCacheName()
The name of the local cache that stores non-distributed sessions when the
SessionDistributionController option is implemented.
|
int |
getLockTimeout()
The maximum time (in seconds) that Coherence*Web will wait attempting to
aquire a lock on a session.
|
Level |
getLoggerLevel()
Return the level of logging for this Coherence*Web instance.
|
String |
getManagementCacheName()
The name of the clustered cache that stores the sessions management
configuration data.
|
int |
getMaxInactiveSeconds()
Determine the default maximum interval, in seconds, that a session will
be kept alive without any activity.
|
String |
getOverflowCacheName()
This method uses the ConfigurationImpl.getStringValue method
to return the configured overflowCacheName value from
the web.xml, System.property or defaultValue if
not configured.
|
int |
getOverflowThreshold()
This method uses the ConfigurationImpl.getIntegerValue method
to return the configured overflowThreshold value from
the web.xml, System.property or defaultValue if
not configured.
|
String |
getOwnershipServiceName()
The name of the invocation service that will be used to manage sticky
session ownership.
|
int |
getReaperCheckCollectionModulo()
Determine how many times the reaper will perform its check before
checking the session models that the collection considers "local".
|
int |
getReaperCycleSeconds()
Determine the number of seconds per reap cycle.
|
int |
getReaperPriority()
Determine the configured priority for the session reaper.
|
String |
getScopeControllerClassName()
The name of an implementation of the AttributeScopeController interface
to use.
|
int |
getServletContextVersionMajor()
Returns the major version of the Java Servlet API that the
underlying servlet container.
|
int |
getServletContextVersionMinor()
Returns the minor version of the Servlet API that this servlet
container supports.
|
String |
getSessionAccessDebugLoggingFilter()
Get the String containing the session attribute prefixes/names not to be logged
when Session Access Debug Logging is enabled.
|
String |
getSessionCacheName()
The name of the clustered cache that stores the sessions.
|
String |
getSessionExpiryFilterFactoryClassName()
A class name of a SessionExpiryFilterFactory implementation.
|
String |
getSessionIdAffinityToken()
Retrieve the session id affinity suffix token if one is defined.
|
String |
getSessionIdCookieDomain()
Determine the domain of the cookie for holding the session ID.
|
int |
getSessionIdCookieMaxAgeSeconds()
Determine the max age (in seconds) of the cookie for holding the
session ID.
|
String |
getSessionIdCookieName()
Determine the name of the cookie for holding the session ID.
|
String |
getSessionIdCookiePath()
Determine the path of the cookie for holding the session ID.
|
String |
getSessionIdEncodingName()
Determine the name of the URL parameter for session ID encoding and
decoding.
|
String |
getSessionIdGeneratorClassName()
The fully qualified class name of the HttpSessionIdGenerator implementation
to use.
|
int |
getSessionIdLength()
Determine the length that session IDs will be created with.
|
boolean |
getSessionIdReplaceAffinityToken()
If true, replace the session id affinity suffix token with the configured
affinity token for this server.
|
String |
getSessionReapingMechanism()
The configured session reaping mechanism
|
int |
getShutdownDelaySeconds()
Determine the number of seconds to defer shutdown after the app
appears to have stopped.
|
static String |
getStringValue(String param) |
protected static String |
getStringValue(XmlElement xml,
String param,
String defaultValue) |
boolean |
isAllowLocalAttributes()
Determine if non-serializable attributes should be preserved as local.
|
protected boolean |
isApplicationNameGenerated() |
boolean |
isAppLockingEnforced()
Determine whether or not two or more applications should be prevented
from accessing the same session simultaneously.
|
boolean |
isClusterOwned()
Determine if the responsibility for shutting down the cluster is owned
by the application.
|
boolean |
isConfigurationConsistencyRequired()
Used to check if the configuration consistency check is required.
|
boolean |
isEnableAttributeListenerOptimization()
Determine if attribute listeners should be executed if the same instance
of a session attribute is being replaced in the session.
|
boolean |
isEnableSessionAccessDebugLogging()
Determines if the Session Access Debug Logging is enabled, i.e.
|
boolean |
isEnableSuspectAttributes()
Determine if suspect attributes need special treatment.
|
boolean |
isLogInvalidationExceptions()
Determine if Coherence*Web should log exceptions thrown by session
attribute listeners during invalidation.
|
boolean |
isMemberLockingEnforced()
Determine whether or not two or more JVMs should be prevented from
accessing the same session simultaneously.
|
boolean |
isOwnershipSticky()
Determine if the sticky session ownership option is on.
|
boolean |
isReaperAssumeLocality()
Determine if the reaper reaper assumes that session data is stored only
on nodes that are running the session reaper reaper thread.
|
boolean |
isReaperCheckCoordinated()
Determine if the reaper coordinates the check across the
cluster instead of just doing its own "local" scan.
|
boolean |
isReapingParallel()
Flag to indicate whether to use parallel session reaping or not.
|
boolean |
isServletContextClustered()
Determine if the Servlet context clusters attributes.
|
boolean |
isSessionContextEnabled()
Determine if the session context should disobey the deprecation and
allow an application to enumerate sessions.
|
boolean |
isSessionIdCookieEnabled()
Determine if a cookie may be used to hold the session ID.
|
boolean |
isSessionIdCookieHttpOnly()
Determine if the session cookie will only be sent from the client using
the initial http/https connection.
|
boolean |
isSessionIdCookieSecure()
Determine if the session cookie will only be sent from the client over a
SSL connection.
|
boolean |
isSessionIdEncodingEnabled()
Determine if a cookie may be used to hold the session ID.
|
boolean |
isSessionLazyAccess()
True if access to the session is lazy rather than on entry to service method
|
boolean |
isSessionLockingEnforced()
Determine whether concurrent access to a session is permitted.
|
boolean |
isStrict()
Determine if the Servlet specification is being followed strictly.
|
boolean |
isThreadLockingEnforced()
Determine whether a session should be single threaded (only one request
per session accessing the session at a time) or multithreaded (any
number of requests accessing the session at a time).
|
boolean |
isUseDefaultSessionIdDecoding()
Determine if the session ID decoding (from a URL) performed by the
application server's request object is sufficient.
|
boolean |
isUseDefaultSessionIdEncoding()
Determine if the session ID encoding (into a URL) performed by the
application server's response object is sufficient.
|
boolean |
logThreadsHoldingLock()
When a member fails to obtain a lock on a session, execute an invocation
service on the member holding the session lock to log the threads that are
holding the lock.
|
String |
toString()
Returns a string representation of the object.
|
public String toString()
public int getServletContextVersionMajor()
public int getServletContextVersionMinor()
public String getApplicationName()
public String getCacheConfigurationPath()
public boolean isClusterOwned()
public boolean isServletContextClustered()
public boolean isSessionContextEnabled()
public int getAsyncExitDelayMillis()
public boolean isSessionIdCookieEnabled()
public String getSessionIdCookieName()
public String getSessionIdCookieDomain()
public String getSessionIdCookiePath()
public int getSessionIdCookieMaxAgeSeconds()
public boolean isSessionIdCookieSecure()
public boolean isSessionIdCookieHttpOnly()
public boolean isSessionIdEncodingEnabled()
public String getSessionIdEncodingName()
public boolean isUseDefaultSessionIdDecoding()
public boolean isUseDefaultSessionIdEncoding()
public String getSessionIdAffinityToken()
public boolean getSessionIdReplaceAffinityToken()
public boolean isLogInvalidationExceptions()
public boolean isStrict()
public int getReaperPriority()
public int getReaperCycleSeconds()
public boolean isReaperCheckCoordinated()
public int getReaperCheckCollectionModulo()
public boolean isReaperAssumeLocality()
public int getShutdownDelaySeconds()
public boolean isSessionLazyAccess()
public String getManagementCacheName()
protected boolean isApplicationNameGenerated()
public boolean isConfigurationConsistencyRequired()
public int getDaemonMaxThreads()
public int getDaemonMinThreads()
public boolean isReapingParallel()
public String getHttpSessionCollectionClassName()
public boolean isOwnershipSticky()
This is available only if an Enterprise Edition or Grid Edition license is available.
public String getOwnershipServiceName()
public String getSessionCacheName()
public String getDistControllerClassName()
public String getScopeControllerClassName()
public String getLocalSessionCacheName()
public String getLocalAttributesCacheName()
public boolean isAllowLocalAttributes()
This feature is available only if the sticky session ownership option is on and is enforced if a distribution controller is specified.
public boolean isEnableSuspectAttributes()
public boolean isEnableAttributeListenerOptimization()
public int getMaxInactiveSeconds()
public int getSessionIdLength()
public String getSessionIdGeneratorClassName()
public String getCacheDelegatorClassName()
public boolean isSessionLockingEnforced()
isMemberLockingEnforced()
or isAppLockingEnforced()
or
isMemberLockingEnforced()
return true, then so will this
method.
If this is set to false, then concurrent access is permitted and the last update wins.
public boolean isMemberLockingEnforced()
public boolean isAppLockingEnforced()
Note that application-level locking requires that member-level session
locking is enabled. In other words, if this method returns true, the
value of isMemberLockingEnforced()
will also be true.
public boolean isThreadLockingEnforced()
Note that a single threaded session requires that both member-level and
application-level session locking are enabled. In other words, if this
method returns true, the value of isMemberLockingEnforced()
and isAppLockingEnforced()
will also be true.
public int getLockTimeout()
public String getSessionExpiryFilterFactoryClassName()
public int getOverflowThreshold()
SplitSessionCollectionConfiguration
getOverflowThreshold
in interface SplitSessionCollectionConfiguration
public String getOverflowCacheName()
SplitSessionCollectionConfiguration
getOverflowCacheName
in interface SplitSessionCollectionConfiguration
public boolean logThreadsHoldingLock()
This is available only if an Enterprise Edition or Grid Edition license is available.
public int getDaemonQueueSize()
public Level getLoggerLevel()
public boolean isEnableSessionAccessDebugLogging()
public String getSessionAccessDebugLoggingFilter()
public String getSessionReapingMechanism()
protected static String getStringValue(XmlElement xml, String param, String defaultValue)
public String checkCompatible(com.tangosol.coherence.servlet.ValidatingConfiguration configuration)
configuration
- the new configuration.protected static boolean getBooleanValue(XmlElement xml, String param, boolean defaultValue)
protected static int getIntValue(XmlElement xml, String param, int defaultValue)