Skip navigation links

Oracle® Coherence Java API Reference
Release 3.7.0.0

E18683-01


com.tangosol.coherence.servlet
Class ConfigurationImpl

java.lang.Object
  extended by com.tangosol.coherence.servlet.ConfigurationImpl

All Implemented Interfaces:
java.io.Serializable

Deprecated. In releases following 3.6 customization will be declarative.

public class ConfigurationImpl
extends java.lang.Object
implements java.io.Serializable

Class implementing the SessionHelperConfiguration and HttpSessionCollectionConfiguration interfaces.

Since:
Coherence 3.6
Author:
yc 2009.11.13

Constructor Summary
ConfigurationImpl()
          Deprecated.  

 

Method Summary
 java.lang.String checkCompatible(com.tangosol.coherence.servlet.ValidatingConfiguration configuration)
          Deprecated. Compares an existing configuration with a new one.
 java.lang.String getApplicationName()
          Deprecated. Return the name of the web application.
 int getAsyncExitDelayMillis()
          Deprecated. The length of time to defer async exit on a session that is accessed "out of context".
protected static boolean getBooleanValue(XmlElement xml, java.lang.String param, boolean defaultValue)
          Deprecated.  
 int getDaemonMaxThreads()
          Deprecated. The maximum number of threads used by the session reaper daemon.
 int getDaemonMinThreads()
          Deprecated. The minimum number of threads used by the session reaper daemon.
 int getDaemonQueueSize()
          Deprecated. The queue size of the session reaper daemon work manager.
 java.lang.String getDeathCertCacheName()
          Deprecated. The name of the clustered cache that stores the IDs of "recently departed" sessions.
 java.lang.String getDistControllerClassName()
          Deprecated. The name of an implementation of the SessionDistributionController interface to use.
 java.lang.String getHttpSessionCollectionClassName()
          Deprecated. The name of the class implementing HttpSessionCollection.
protected static int getIntValue(XmlElement xml, java.lang.String param, int defaultValue)
          Deprecated.  
 java.lang.String getLocalAttributesCacheName()
          Deprecated. The name of the local cache that stores non-distributed session attributes (if allowed.)
 java.lang.String getLocalSessionCacheName()
          Deprecated. The name of the local cache that stores non-distributed sessions when the SessionDistributionController option is implemented.
 int getLockTimeout()
          Deprecated. The maximum time (in seconds) that Coherence*Web will wait attempting to aquire a lock on a session.
 java.lang.String getManagementCacheName()
          Deprecated. The name of the clustered cache that stores the sessions management configuration data.
 int getMaxInactiveSeconds()
          Deprecated. Determine the default maximum interval, in seconds, that a session will be kept alive without any activity.
 java.lang.String getOwnershipServiceName()
          Deprecated. The name of the invocation service that will be used to manage sticky session ownership.
 int getReaperCheckCollectionModulo()
          Deprecated. Determine how many times the reaper will perform its check before checking the session models that the collection considers "local".
 int getReaperCycleSeconds()
          Deprecated. Determine the number of seconds per reap cycle.
 int getReaperPriority()
          Deprecated. Determine the configured priority for the session reaper.
 java.lang.String getScopeControllerClassName()
          Deprecated. The name of an implementation of the AttributeScopeController interface to use.
 int getServletContextVersionMajor()
          Deprecated. Returns the major version of the Java Servlet API that the underlying servlet container.
 int getServletContextVersionMinor()
          Deprecated. Returns the minor version of the Servlet API that this servlet container supports.
 java.lang.String getSessionCacheName()
          Deprecated. The name of the clustered cache that stores the sessions.
 java.lang.String getSessionExpiryFilterFactoryClassName()
          Deprecated. A class name of a SessionExpiryFilterFactory implementation.
 java.lang.String getSessionIdAffinityToken()
          Deprecated. Retrieve the session id affinity suffix token if one is defined.
 java.lang.String getSessionIdCookieDomain()
          Deprecated. Determine the domain of the cookie for holding the session ID.
 int getSessionIdCookieMaxAgeSeconds()
          Deprecated. Determine the max age (in seconds) of the cookie for holding the session ID.
 java.lang.String getSessionIdCookieName()
          Deprecated. Determine the name of the cookie for holding the session ID.
 java.lang.String getSessionIdCookiePath()
          Deprecated. Determine the path of the cookie for holding the session ID.
 java.lang.String getSessionIdEncodingName()
          Deprecated. Determine the name of the URL parameter for session ID encoding and decoding.
 java.lang.String getSessionIdGeneratorClassName()
          Deprecated. The fully qualified class name of the HttpSessionIdGenerator implementation to use.
 int getSessionIdLength()
          Deprecated. Determine the length that session IDs will be created with.
 int getShutdownDelaySeconds()
          Deprecated. Determine the number of seconds to defer shutdown after the app appears to have stopped.
protected static java.lang.String getStringValue(XmlElement xml, java.lang.String param, java.lang.String defaultValue)
          Deprecated.  
 boolean isAllowLocalAttributes()
          Deprecated. Determine if non-serializable attributes should be preserved as local.
protected  boolean isApplicationNameGenerated()
          Deprecated.  
 boolean isAppLockingEnforced()
          Deprecated. Determine whether or not two or more applications should be prevented from accessing the same session simultaneously.
 boolean isClusterOwned()
          Deprecated. Determine if the responsibility for shutting down the cluster is owned by the application.
 boolean isConfigurationConsistencyRequired()
          Deprecated. Used to check if the configuration consistency check is required.
 boolean isEnableAttributeListenerOptimization()
          Deprecated. Determine if attribute listeners should be executed if the same instance of a session attribute is being replaced in the session.
 boolean isEnableSuspectAttributes()
          Deprecated. Determine if suspect attributes need special treatment.
 boolean isMemberLockingEnforced()
          Deprecated. Determine whether or not two or more JVMs should be prevented from accessing the same session simultaneously.
 boolean isOwnershipSticky()
          Deprecated. Determine if the sticky session ownership option is on.
 boolean isReaperAssumeLocality()
          Deprecated. Determine if the reaper reaper assumes that session data is stored only on nodes that are running the session reaper reaper thread.
 boolean isReaperCheckCoordinated()
          Deprecated. Determine if the reaper coordinates the check across the cluster instead of just doing its own "local" scan.
 boolean isReapingParallel()
          Deprecated. Flag to indicate whether to use parallel session reaping or not.
 boolean isServletContextClustered()
          Deprecated. Determine if the Servlet context clusters attributes.
 boolean isSessionContextEnabled()
          Deprecated. Determine if the session context should disobey the deprecation and allow an application to enumerate sessions.
 boolean isSessionIdCookieEnabled()
          Deprecated. Determine if a cookie may be used to hold the session ID.
 boolean isSessionIdCookieSecure()
          Deprecated. Determine if the session cookie will only be sent from the client over a SSL connection.
 boolean isSessionIdEncodingEnabled()
          Deprecated. Determine if a cookie may be used to hold the session ID.
 boolean isSessionLazyAccess()
          Deprecated. True if access to the session is lazy rather than on entry to service method
 boolean isSessionLockingEnforced()
          Deprecated. Determine whether concurrent access to a session is permitted.
 boolean isStrict()
          Deprecated. Determine if the Servlet specification is being followed strictly.
 boolean isThreadLockingEnforced()
          Deprecated. 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()
          Deprecated. Determine if the session ID decoding (from a URL) performed by the application server's request object is sufficient.
 boolean isUseDefaultSessionIdEncoding()
          Deprecated. Determine if the session ID encoding (into a URL) performed by the application server's response object is sufficient.
 boolean logThreadsHoldingLock()
          Deprecated. 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.
 java.lang.String toString()
          Deprecated. 

 

Constructor Detail

ConfigurationImpl

public ConfigurationImpl()
Deprecated. 

Method Detail

toString

public java.lang.String toString()
Deprecated. 

getServletContextVersionMajor

public int getServletContextVersionMajor()
Deprecated. 
Returns the major version of the Java Servlet API that the underlying servlet container.
Returns:
the major version of the Java Servlet API that the underlying servlet container supports.

getServletContextVersionMinor

public int getServletContextVersionMinor()
Deprecated. 
Returns the minor version of the Servlet API that this servlet container supports.
Returns:
the minor version of the Servlet API that this servlet container supports

getApplicationName

public java.lang.String getApplicationName()
Deprecated. 
Return the name of the web application.
Returns:
the name of the web application; never null or empty

isClusterOwned

public boolean isClusterOwned()
Deprecated. 
Determine if the responsibility for shutting down the cluster is owned by the application.
Returns:
true if the cluster software is running within the domain of the application context, false if within the domain of the application server

isServletContextClustered

public boolean isServletContextClustered()
Deprecated. 
Determine if the Servlet context clusters attributes.
Returns:
true if the Servlet context clusters attributes; false otherwise

isSessionContextEnabled

public boolean isSessionContextEnabled()
Deprecated. 
Determine if the session context should disobey the deprecation and allow an application to enumerate sessions.
Returns:
true if the session context should allow the application to enumerate sessions

getAsyncExitDelayMillis

public int getAsyncExitDelayMillis()
Deprecated. 
The length of time to defer async exit on a session that is accessed "out of context".
Returns:
The length of time to defer async exit

isSessionIdCookieEnabled

public boolean isSessionIdCookieEnabled()
Deprecated. 
Determine if a cookie may be used to hold the session ID.
Returns:
true if a cookie may be used to hold the session ID

getSessionIdCookieName

public java.lang.String getSessionIdCookieName()
Deprecated. 
Determine the name of the cookie for holding the session ID.
Returns:
the name of the cookie for holding the session ID

getSessionIdCookieDomain

public java.lang.String getSessionIdCookieDomain()
Deprecated. 
Determine the domain of the cookie for holding the session ID.
Returns:
the domain of the cookie for holding the session ID

getSessionIdCookiePath

public java.lang.String getSessionIdCookiePath()
Deprecated. 
Determine the path of the cookie for holding the session ID.
Returns:
the path of the cookie for holding the session ID

getSessionIdCookieMaxAgeSeconds

public int getSessionIdCookieMaxAgeSeconds()
Deprecated. 
Determine the max age (in seconds) of the cookie for holding the session ID.
Returns:
the max age of the cookie for holding the session ID

isSessionIdCookieSecure

public boolean isSessionIdCookieSecure()
Deprecated. 
Determine if the session cookie will only be sent from the client over a SSL connection.
Returns:
true if the client will only send the session cookie over a SSL connection

isSessionIdEncodingEnabled

public boolean isSessionIdEncodingEnabled()
Deprecated. 
Determine if a cookie may be used to hold the session ID.
Returns:
true if a cookie may be used to hold the session ID

getSessionIdEncodingName

public java.lang.String getSessionIdEncodingName()
Deprecated. 
Determine the name of the URL parameter for session ID encoding and decoding.
Returns:
the name of the URL parameter that contains the session id

isUseDefaultSessionIdDecoding

public boolean isUseDefaultSessionIdDecoding()
Deprecated. 
Determine if the session ID decoding (from a URL) performed by the application server's request object is sufficient. Sometimes, it is necessary to use the application server's own decoding because it will "hide" the "jsessionid" parameter, making custom parsing impossible.
Returns:
true to use the session ID provided by the application server's request object

isUseDefaultSessionIdEncoding

public boolean isUseDefaultSessionIdEncoding()
Deprecated. 
Determine if the session ID encoding (into a URL) performed by the application server's response object is sufficient. This will be false for all known cases, since the container has no way of knowing the session ID of the custom session implementation.
Returns:
true to use the app server to URL encode the session ID; false to use the custom implementation to encode it

getSessionIdAffinityToken

public java.lang.String getSessionIdAffinityToken()
Deprecated. 
Retrieve the session id affinity suffix token if one is defined. The token along with all the characters to right of the token will be stripped off the session id.
Returns:
the session id affinity token

isStrict

public boolean isStrict()
Deprecated. 
Determine if the Servlet specification is being followed strictly.
Returns:
true if the Servlet specification is being followed strictly

getReaperPriority

public int getReaperPriority()
Deprecated. 
Determine the configured priority for the session reaper.
Returns:
the configured priority of the session reaper

getReaperCycleSeconds

public int getReaperCycleSeconds()
Deprecated. 
Determine the number of seconds per reap cycle. This means that a new cycle will not start until this many seconds has passed since the previous cycle started.
Returns:
the number of seconds per reap cycle

isReaperCheckCoordinated

public boolean isReaperCheckCoordinated()
Deprecated. 
Determine if the reaper coordinates the check across the cluster instead of just doing its own "local" scan.
Returns:
true if the reaper coordinates a global scan with other nodes in the cluster

getReaperCheckCollectionModulo

public int getReaperCheckCollectionModulo()
Deprecated. 
Determine how many times the reaper will perform its check before checking the session models that the collection considers "local".
Returns:
the modulo on which the reaper will check the session models that the collection considers "local"

isReaperAssumeLocality

public boolean isReaperAssumeLocality()
Deprecated. 
Determine if the reaper reaper assumes that session data is stored only on nodes that are running the session reaper reaper thread.
Returns:
true if the reaper can assume that all cluster nodes that store sessions are also running a reaper

getShutdownDelaySeconds

public int getShutdownDelaySeconds()
Deprecated. 
Determine the number of seconds to defer shutdown after the app appears to have stopped.
Returns:
the length of time in seconds to defer shutdown after the app is stopped

isSessionLazyAccess

public boolean isSessionLazyAccess()
Deprecated. 
True if access to the session is lazy rather than on entry to service method
Returns:
true if access to the session is lazy rather than on entry to service method

getManagementCacheName

public java.lang.String getManagementCacheName()
Deprecated. 
The name of the clustered cache that stores the sessions management configuration data.
Returns:
the cache name

isApplicationNameGenerated

protected boolean isApplicationNameGenerated()
Deprecated. 

isConfigurationConsistencyRequired

public boolean isConfigurationConsistencyRequired()
Deprecated. 
Used to check if the configuration consistency check is required.
Returns:
true if consistency should be cchecked against grid, false otherwise

getDaemonMaxThreads

public int getDaemonMaxThreads()
Deprecated. 
The maximum number of threads used by the session reaper daemon.
Returns:
the maximum number of threads.

getDaemonMinThreads

public int getDaemonMinThreads()
Deprecated. 
The minimum number of threads used by the session reaper daemon.
Returns:
the minimum number of threads.

isReapingParallel

public boolean isReapingParallel()
Deprecated. 
Flag to indicate whether to use parallel session reaping or not.
Returns:
true if parallel reaping is enabled, false otherwise.

getHttpSessionCollectionClassName

public java.lang.String getHttpSessionCollectionClassName()
Deprecated. 
The name of the class implementing HttpSessionCollection.
Returns:
The name of the class implementing HttpSessionCollection.

isOwnershipSticky

public boolean isOwnershipSticky()
Deprecated. 
Determine if the sticky session ownership option is on.

This is available only if an Enterprise Edition or Grid Edition license is available.

Returns:
true if the sticky session ownership option is on

getOwnershipServiceName

public java.lang.String getOwnershipServiceName()
Deprecated. 
The name of the invocation service that will be used to manage sticky session ownership.
Returns:
the invocation service

getSessionCacheName

public java.lang.String getSessionCacheName()
Deprecated. 
The name of the clustered cache that stores the sessions.
Returns:
The name of the cache

getDeathCertCacheName

public java.lang.String getDeathCertCacheName()
Deprecated. 
The name of the clustered cache that stores the IDs of "recently departed" sessions.
Returns:
The name of the cache

getDistControllerClassName

public java.lang.String getDistControllerClassName()
Deprecated. 
The name of an implementation of the SessionDistributionController interface to use.
Returns:
The name of the class

getScopeControllerClassName

public java.lang.String getScopeControllerClassName()
Deprecated. 
The name of an implementation of the AttributeScopeController interface to use.
Returns:
The name of the class

getLocalSessionCacheName

public java.lang.String getLocalSessionCacheName()
Deprecated. 
The name of the local cache that stores non-distributed sessions when the SessionDistributionController option is implemented.
Returns:
The name of the cash

getLocalAttributesCacheName

public java.lang.String getLocalAttributesCacheName()
Deprecated. 
The name of the local cache that stores non-distributed session attributes (if allowed.)
Returns:
The name of the cash

isAllowLocalAttributes

public boolean isAllowLocalAttributes()
Deprecated. 
Determine if non-serializable attributes should be preserved as local.

This feature is available only if the sticky session ownership option is on and is enforced if a distribution controller is specified.

Returns:
true iff non-serializable attributes should be preserved

isEnableSuspectAttributes

public boolean isEnableSuspectAttributes()
Deprecated. 
Determine if suspect attributes need special treatment.
Returns:
true if suspect attributes need special treatment

isEnableAttributeListenerOptimization

public boolean isEnableAttributeListenerOptimization()
Deprecated. 
Determine if attribute listeners should be executed if the same instance of a session attribute is being replaced in the session.
Returns:
true if optimization should be used

getMaxInactiveSeconds

public int getMaxInactiveSeconds()
Deprecated. 
Determine the default maximum interval, in seconds, that a session will be kept alive without any activity.
Returns:
the default number of seconds to keep an inactive session

getSessionIdLength

public int getSessionIdLength()
Deprecated. 
Determine the length that session IDs will be created with.
Returns:
the length, in characters, for session IDs

getSessionIdGeneratorClassName

public java.lang.String getSessionIdGeneratorClassName()
Deprecated. 
The fully qualified class name of the HttpSessionIdGenerator implementation to use.
Returns:
the class name

isSessionLockingEnforced

public boolean isSessionLockingEnforced()
Deprecated. 
Determine whether concurrent access to a session is permitted. If 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.

Returns:
true if concurrent access to a session is limited.

isMemberLockingEnforced

public boolean isMemberLockingEnforced()
Deprecated. 
Determine whether or not two or more JVMs should be prevented from accessing the same session simultaneously.
Returns:
true to limit the access to a session to one JVM at a time

isAppLockingEnforced

public boolean isAppLockingEnforced()
Deprecated. 
Determine whether or not two or more applications should be prevented from accessing the same session simultaneously.

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.

Returns:
true to limit the access to a session to one application at a time

isThreadLockingEnforced

public boolean isThreadLockingEnforced()
Deprecated. 
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).

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.

Returns:
true to limit the access to a session to one thread at a time

getLockTimeout

public int getLockTimeout()
Deprecated. 
The maximum time (in seconds) that Coherence*Web will wait attempting to aquire a lock on a session.
Returns:
the timeout (in seconds) for aquiring a lock on a session

getSessionExpiryFilterFactoryClassName

public java.lang.String getSessionExpiryFilterFactoryClassName()
Deprecated. 
A class name of a SessionExpiryFilterFactory implementation. This factory can be used to customize/extend the current filter for selecting what sessions to reap. An example is push replication that needs to make sure that only sessions in this cluster is invalidated. The factory should extend the current behavior by adding its own filter before or after the default filter provided by the HttpSessionCollection class.
Returns:
The SessionExpiryFilterFactory implementation class name to use, if any.

logThreadsHoldingLock

public boolean logThreadsHoldingLock()
Deprecated. 
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. This would be used for diagnostic purposes.

This is available only if an Enterprise Edition or Grid Edition license is available.

Returns:
true if the diagnostic invocation service should be executed

getDaemonQueueSize

public int getDaemonQueueSize()
Deprecated. 
The queue size of the session reaper daemon work manager. This is only used when the parallel reaper is enabled and not using the SPI. Default is unlimited (Integer.MAX_VALUE).
Returns:
the queue size of the session reaper daemon work manager

getStringValue

protected static java.lang.String getStringValue(XmlElement xml,
                                                 java.lang.String param,
                                                 java.lang.String defaultValue)
Deprecated. 

checkCompatible

public java.lang.String checkCompatible(com.tangosol.coherence.servlet.ValidatingConfiguration configuration)
Deprecated. 
Compares an existing configuration with a new one. In the case of incompatibility optionally returns an explanation.
Parameters:
configuration - the new configuration.
Returns:
null if compatible, explanation of incompatibility otherwise

getBooleanValue

protected static boolean getBooleanValue(XmlElement xml,
                                         java.lang.String param,
                                         boolean defaultValue)
Deprecated. 

getIntValue

protected static int getIntValue(XmlElement xml,
                                 java.lang.String param,
                                 int defaultValue)
Deprecated. 

Skip navigation links

Oracle® Coherence Java API Reference
Release 3.7.0.0

E18683-01


Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.