|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.tangosol.util.Base
com.tangosol.coherence.servlet.SessionHelper
Deprecated. In releases following 3.6 customization will be declarative.
public class SessionHelper
A collection of methods that support the implementation of Coherence web container components used to replace the corresponding implementations provided by the application server vendor.
Must NOT be serializable just in case the application server implements clustering on the ServletContext level (because the session helper will be stored in the app server's ServletContext).
Nested Class Summary | |
---|---|
static interface |
SessionHelper.Factory Deprecated. In releases following 3.6 customization will be declarative. |
class |
SessionHelper.SessionReaperDaemon Deprecated. A daemon thread class that will clean up expired sessions. |
protected static interface |
SessionHelper.Task Deprecated. In releases following 3.6 customization will be declarative. |
Field Summary | |
---|---|
static String |
CACHE_CONFIGURATION_PATH Deprecated. The name of the resource that will be used to configure the session management module's own ConfigurableCacheFactory. |
static String |
CFG_KEY_REAPER Deprecated. The key in the configuration cache for coordating cluster-wide session reaping. |
static String |
CTX_ATTR_CONTEXT Deprecated. The name of the application server context's attribute that Coherence stores its servlet context object under. |
static String |
CTX_ATTR_HELPER Deprecated. The name of the application server context's attribute that Coherence stores its session helper object under. |
static String |
CTX_INIT_ALLOW_LOCAL_ATTRIBUTES Deprecated. The configuration property that specifies whether non-serializable attributes should be preserved as local. |
static String |
CTX_INIT_APPLICATION_NAME Deprecated. The configuration property that overrides the name of the web application. |
protected static String |
CTX_INIT_APPLICATION_NAME_GENERATED Deprecated. Whether the application name was generated by Coherence*Web |
static String |
CTX_INIT_ATTR_OVERFLOW_THRESHOLD Deprecated. The configuration property for the "split" model that overrides the length that attributes must be below to be stored inside a session ("embedded") or above which they will be stored in the separated "overflow" cache ("external"). |
static String |
CTX_INIT_CACHENAME_CONTEXT Deprecated. The name of the Coherence cache that will be used to hold the servlet context data if the servlet context is clustered by Coherence. |
static String |
CTX_INIT_CACHENAME_DEATHCERTS Deprecated. The configuration property that overrides the name of the clustered cache that stores the IDs of "recently departed" sessions. |
static String |
CTX_INIT_CACHENAME_LOCAL_ATTRIBUTES Deprecated. The configuration property that overrides the name of the local cache that stores non-distributed session attributes (if allowed.) |
static String |
CTX_INIT_CACHENAME_LOCAL_SESSIONS Deprecated. The configuration property that overrides the name of the local cache that stores non-distributed sessions when the SessionDistributionController option is implemented. |
static String |
CTX_INIT_CACHENAME_MANAGEMENT Deprecated. The configuration property that overrides the name of the clustered cache that stores the sessions management configuration data. |
static String |
CTX_INIT_CACHENAME_OVERFLOW Deprecated. The configuration property that overrides the name of the clustered cache that stores the "overflowing" (split-out due to size) session attributes. |
static String |
CTX_INIT_CACHENAME_SESSIONS Deprecated. The configuration property that overrides the name of the clustered cache that stores the sessions. |
static String |
CTX_INIT_CLUSTER Deprecated. The name of the application server context's initialization parameter that specifies whether the ServletContext attribute values will be clustered. |
static String |
CTX_INIT_CLUSTER_OWNED Deprecated. True if the cluster software is deployed as part of the application and thus must be shut down fully by the application when it shuts down. |
static String |
CTX_INIT_COLLECTION Deprecated. The name of the application server context's initialization parameter that specifies the fully qualified class name of the HttpSessionCollection implementation to use. |
static String |
CTX_INIT_CONFIGURATION_CONSISTENCY Deprecated. The configuration property that indicates whether configuration consistency should be checked. |
static String |
CTX_INIT_COOKIE_DOMAIN Deprecated. The domain of the session cookie. |
static String |
CTX_INIT_COOKIE_MAX_AGE Deprecated. The maximum age in seconds of the session cookie. |
static String |
CTX_INIT_COOKIE_NAME Deprecated. The name of the session cookie. |
static String |
CTX_INIT_COOKIE_PATH Deprecated. The path of the session cookie. |
static String |
CTX_INIT_COOKIE_SECURE Deprecated. True to ensure that the session cookie is only sent from a web client over a SSL connection. |
static String |
CTX_INIT_COOKIES_ENABLED Deprecated. True to enable session cookies. |
static String |
CTX_INIT_DAEMON_ASSUME_LOCALITY Deprecated. True to assume that the sessions in the cache are split across only the servers that are doing reaping. |
static String |
CTX_INIT_DAEMON_COORDINATED Deprecated. True to coordinate reaping in the cluster such that only one server will perform reaping within a given reaping cycle, and it will check all session ids in the cluster. |
static String |
CTX_INIT_DAEMON_CYCLE_SECS Deprecated. The number of seconds that the daemon rests between reaping. |
static String |
CTX_INIT_DAEMON_MAX_THREADS Deprecated. Configuration parameter for setting the minimum number of threads for the session reaper daemon. |
static String |
CTX_INIT_DAEMON_MIN_THREADS Deprecated. Configuration parameter for setting the maximum number of threads for the session reaper daemon. |
static String |
CTX_INIT_DAEMON_PARALLEL Deprecated. Configuration parameter for enabling parallel session reaping. |
static String |
CTX_INIT_DAEMON_PRIORITY Deprecated. The priority for the session reaper daemon. |
static String |
CTX_INIT_DAEMON_QUEUE_SIZE Deprecated. Configuration parameter for setting the queue size of the session reaper work manager. |
static String |
CTX_INIT_DAEMON_SWEEP_MODULO Deprecated. The number of times that the reaper reaps the sessions that are being used locally before it will check sessions that may be orphaned or expired elsewhere in the cluster. |
static String |
CTX_INIT_DIST_CONTROLLER_CLASS Deprecated. The configuration property that specifies an implementation of the SessionDistributionController interface to use. |
static String |
CTX_INIT_ENABLE_ATTR_LISTENER_OPTIMIZATION Deprecated. Determines if attribute listeners should be executed if the same instance of a session attribute is being replaced in the session. |
static String |
CTX_INIT_ENABLE_SUSPECT_ATTRIBUTES Deprecated. Whether we try to determine suspect attributes. |
static String |
CTX_INIT_FACTORY Deprecated. The name of the application server context's initialization parameter that specifies the fully qualified class name of the SessionHelper Factory to use. |
static String |
CTX_INIT_FILTER Deprecated. In the filter's configuration, the name of the filter class that is wrapped by the Coherence filter. |
static String |
CTX_INIT_LISTENS Deprecated. The comma-delimited list of names of application classes that wish to receive events from the web container. |
static String |
CTX_INIT_LOG_THREADS_HOLDING_LOCK Deprecated. The configuration property that specifies whether an diagnostic invocation service is executed when a member is unable to acquire the cluster lock for a session. |
static String |
CTX_INIT_SCOPE_CONTROLLER_CLASS Deprecated. The configuration property that specifies an implementation of the AttributeScopeController interface to use. |
static String |
CTX_INIT_SERVICENAME_OWNERSHIP Deprecated. The configuration property that specifies the name of the invocation service that will be used to manage sticky session ownership. |
static String |
CTX_INIT_SERVLET Deprecated. In the servlet's configuration, the name of the servlet class that is wrapped by the Coherence servlet. |
static String |
CTX_INIT_SESSION_APP_LOCK Deprecated. The configuration property that specifies application level session locking. |
static String |
CTX_INIT_SESSION_EXPIRE_SECS Deprecated. The configuration property that overrides the session expirty time. |
protected static String |
CTX_INIT_SESSION_EXPIRY_FILTER_FACTORY Deprecated. Parameter name for specifying a custom session expiry filter factory |
static String |
CTX_INIT_SESSION_GET_LOCK_TIMEOUT Deprecated. The configuration property that specifies session lock acquisition timeout. |
static String |
CTX_INIT_SESSION_ID_GENERATOR_CLASS Deprecated. The configuration property that specifies the fully qualified class name of the HttpSessionIdGenerator implementation to use. |
static String |
CTX_INIT_SESSION_ID_LENGTH Deprecated. The configuration property that overrides the session id length. |
static String |
CTX_INIT_SESSION_LAZY_ACCESS Deprecated. The configuration property that allows lazy access to a session. |
static String |
CTX_INIT_SESSION_LOCK Deprecated. The configuration property that specifies that session locking is enabled. |
static String |
CTX_INIT_SESSION_MEMBER_LOCK Deprecated. The configuration property that specifies member level session locking. |
static String |
CTX_INIT_SESSION_RETAIN_MILLIS Deprecated. The length of time to defer async exit on a session that is accessed "out of context". |
static String |
CTX_INIT_SESSION_STICKY Deprecated. The configuration property that specifies whether sticky sessions optimizations will be used. |
static String |
CTX_INIT_SESSION_STRICT_SPEC Deprecated. The configuration property that specifies strict spec adherence. |
static String |
CTX_INIT_SESSION_THREAD_LOCK Deprecated. The configuration property that specifies thread level session locking. |
static String |
CTX_INIT_SESSIONCONTEXT_ENABLED Deprecated. True to allow the application to iterate sessions from the session context, thus disobeying the deprecation in the servlet spec. |
static String |
CTX_INIT_SHUTDOWN_DELAY_SECS Deprecated. The configuration property that overrides the shutdown delay time. |
static String |
CTX_INIT_URLDECODE_DEFAULT Deprecated. True to use the container's decoding of the URL session ID. |
static String |
CTX_INIT_URLENCODE_DEFAULT Deprecated. True to use the container's encoding of the URL session ID. |
static String |
CTX_INIT_URLENCODE_ENABLED Deprecated. True to enable URL encoding of session ids. |
static String |
CTX_INIT_URLENCODE_NAME Deprecated. The parameter name to encode the session id into the URL with. |
static String |
DEFAULT_CTXNAME Deprecated. The default cache name for the ServletContext attribute map. |
static String |
DEFAULT_FACTORY Deprecated. The default class name for the SessionHelper factory implementation. |
static String |
DEFAULT_MGTNAME Deprecated. The default cache name for the session management configuration data. |
static int |
EVT_ADDED Deprecated. The internal enum for an attribute-added event. |
static int |
EVT_REMOVED Deprecated. The internal enum for an attribute-removed event. |
static int |
EVT_REPLACED Deprecated. The internal enum for an attribute-replaced event. |
static Filter |
NAME_FILTER Deprecated. The Filter object that hides init param names for Coherence params. |
static String |
PRODUCT_BANNER Deprecated. The product name banner. |
static String |
REQ_ATTR_COUNT Deprecated. The name of the request attribute that stores a request reference counter. |
static String |
REQ_ATTR_SESSION Deprecated. The name of the request attribute that stores the current Coherence HttpSession instance. |
static String |
REQ_ATTR_TEST Deprecated. The name of the request attribute that tests if the Coherence wrapper is in place. |
protected static ConfigurableCacheFactory |
s_cachefactory Deprecated. The session management module's own ConfigurableCacheFactory. |
Constructor Summary | |
---|---|
SessionHelper(SessionHelper.Factory factory, javax.servlet.ServletContext ctx) Deprecated. Construct a Coherence SessionHelper that will support the implementation of clustered web container services. |
Method Summary | |
---|---|
void |
addIgnoreAttributeName(String sName) Deprecated. Register a name to ignore events for. |
protected void |
checkConfigConsistency(com.tangosol.coherence.servlet.ValidatingConfiguration configuration) Deprecated. Check that configuration is consistent with that of existing members. |
protected void |
checkForDeadSessions() Deprecated. Discard the HttpSession objects that are no longer alive. |
void |
clearStoredConfiguration() Deprecated. Removes the storeSessd configuration. |
protected void |
configure(int nVersionMajor, int nVersionMinor) Deprecated. Called immediately after construction. |
void |
contextDestroyed() Deprecated. Called by the Coherence ServletContextListener on contextDestroyed() if an event listener is registered. |
void |
contextInitialized() Deprecated. Called by the Coherence ServletContextListener on contextInitialized() if an event listener is registered. |
javax.servlet.http.HttpSession |
createHttpSession() Deprecated. Create a new HttpSession object. |
RequestContext |
createRequestContext(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) Deprecated. Given the specified request and response, provide a request context. |
protected com.tangosol.coherence.servlet.ServiceHelper |
createServiceHelper() Deprecated. Create a ServiceHelper. |
String |
decodeCookie(javax.servlet.http.HttpServletRequest req) Deprecated. Obtain a session ID from a request object by examining the cookies attached to the request. |
String |
decodeUrl(javax.servlet.http.HttpServletRequest request) Deprecated. Decodes the session ID from the URL represented by the passed request. |
void |
dispatchAttributeEvent(int nEvent, javax.servlet.ServletContextAttributeEvent evt) Deprecated. Dispatch a wrapped event to the application listeners. |
void |
dispatchInternalAttributeEvent(int nEvent, javax.servlet.ServletContextAttributeEvent evt) Deprecated. Dispatch a wrapped event to the application listeners. |
void |
encodeCookie(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String sId, boolean fNew) Deprecated. Encode a session ID into a cookie and attach it to the response object. |
String |
encodeUrl(String sUrl, javax.servlet.http.HttpServletRequest request) Deprecated. Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. |
protected String |
encodeUrl(String sUrl, String sId) Deprecated. Encodes the specified URL by including the given session ID in it. |
protected NamedCache |
ensureConfigurationCache() Deprecated. Get the NamedCache used to store configuration and management information for the session management implementation if it exists, otherwise create it. |
javax.servlet.http.HttpSession |
ensureHttpSession(String sId) Deprecated. Get the HttpSession object for the specified ID. |
protected NamedCache |
ensureServletContextAttributeCache() Deprecated. Get the clustered attribute map if it exists, otherwise create it (if the ServletContext is supposed to be clustered). |
static SessionHelper |
ensureSessionHelper(javax.servlet.ServletContext ctx) Deprecated. Find the existing (or create new) Coherence SessionHelper that will act as a coordinator to manage the creation and lookup of container objects, fake container objects (the Coherence implementation of the Servlet spec interfaces), and helper classes (such as the SessionHelper itself, the servlet model collection, etc.). |
TaskDaemon |
ensureSessionWorkerDaemon() Deprecated. Get the daemon thread that is used for scheduled tasks, creating it if necessary. |
static javax.servlet.ServletContext |
ensureWrappedServletContext(javax.servlet.ServletContext ctx) Deprecated. Make sure that there is a ServletContext wrapper for the specified servlet context for this application, creating one if necessary. |
void |
enterSession(String sId) Deprecated. Obtain any necessary ownership for the specified session. |
void |
exitSession(String sId, boolean fNew) Deprecated. Release ownership for the specified session. |
void |
filter(javax.servlet.Filter filter, javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp, javax.servlet.FilterChain chain) Deprecated. Issue the service call to the specified servlet, given the passed request and response objects. |
void |
filterDestroyed() Deprecated. Called by each Coherence Filter wrapper on destroy(). |
void |
filterInitialized() Deprecated. Called by each Coherence Filter wrapper on init(). |
static String |
formatCacheName(NamedCache cache) Deprecated. Format a NamedCache object into a human readable string. |
static String |
formatListeners(Listeners listeners) Deprecated. Format a Listeners object into a human readable string. |
static String |
formatMapKeys(Map map) Deprecated. Format a map into a list of keys. |
protected String |
getApplicationName() Deprecated. Return the name of the web application. |
static NamedCache |
getCache(String sCacheName) Deprecated. Obtain a session management cache by name. |
XmlElement |
getConfig() Deprecated. Determine the current configuration of the object. |
static ConfigurableCacheFactory |
getConfigurableCacheFactory() Deprecated. Obtain the ConfigurableCacheFactory used by the SessionHelper. |
NamedCache |
getConfigurationCache() Deprecated. Get the NamedCache used to store configuration and management information for the session management implementation. |
protected com.tangosol.coherence.servlet.ConfigurationConsistencyVerifier |
getConfigurationConsistencyVerifier() Deprecated. Get a ConfigurationConsistencyVerifier instance. |
protected Listeners |
getContextAttributeListeners() Deprecated. Get the application listeners that listen to servlet context attribute events. |
protected int |
getDaemonCheckCollectionModulo() Deprecated. Determine how many times the daemon will perform its check before checking the session models that the collection considers "local". |
protected long |
getDaemonCycleMillis() Deprecated. Determine the number of milliseconds per reap cycle. |
protected int |
getDaemonPriority() Deprecated. Determine the configured priority for the session reaper daemon. |
protected String |
getDescription() Deprecated. Returns a string representation of this object's attributes. |
SessionHelper.Factory |
getFactory() Deprecated. Determine the factory to use to instantiate container-specific implementations of the Servlet specification interfaces. |
javax.servlet.http.HttpSession |
getHttpSession(javax.servlet.http.HttpServletRequest req) Deprecated. Return the HttpSession associated with the given request. |
javax.servlet.http.HttpSession |
getHttpSession(String sId) Deprecated. Get the HttpSession object for the specified ID. |
HttpSessionCollection |
getHttpSessionCollection() Deprecated. Get the HttpSessionCollection object that manages the HttpSessionModel objects. |
javax.servlet.http.HttpSessionContext |
getHttpSessionContext() Deprecated. Get the HttpSessionContext. |
protected Map |
getHttpSessionMap() Deprecated. Get the map of session ID to session object for HttpSession objects managed in this application within this JVM/classloader. |
static InvocationService |
getInvocationService(String sService) Deprecated. Obtain a session management invocation service by name. |
Listeners |
getListeners() Deprecated. Get the application listeners. |
Set |
getLocalSessionIds() Deprecated. Gets session ids for all sessions that are in the local map, i.e. has been accessed by this node. |
protected String |
getMBeanObjectName() Deprecated. Return a string representation of the ObjectName used to register the MBean instance for this SessionHelper. |
protected com.tangosol.coherence.servlet.SessionHelper.ReapTaskFactory |
getReapTaskFactory() Deprecated. Getter for reap task factory. |
javax.servlet.ServletContext |
getServletContext() Deprecated. Returns the Coherence ServletContext wrapper that this SessionHelper is helping with. |
NamedCache |
getServletContextAttributeCache() Deprecated. Get the clustered attribute map. |
int |
getServletContextMajorVersion() Deprecated. Returns the major version of the Java Servlet API that this servlet container supports. |
int |
getServletContextMinorVersion() Deprecated. Returns the minor version of the Servlet API that this servlet container supports. |
String |
getSessionIdCookieDomain() Deprecated. Determine the domain of the cookie for holding the session ID. |
int |
getSessionIdCookieMaxAge() Deprecated. Determine the max age (in seconds) of the cookie for holding the session ID. |
String |
getSessionIdCookieName() Deprecated. Determine the name of the cookie for holding the session ID. |
String |
getSessionIdCookiePath() Deprecated. Determine the path of the cookie for holding the session ID. |
boolean |
getSessionIdCookieSecure() Deprecated. Determine if a web client will only send the session cookie over a SSL connection. |
String |
getSessionIdEncodingName() Deprecated. Determine the name of the URL parameter for session ID encoding and decoding. |
protected SessionHelper.SessionReaperDaemon |
getSessionReaperDaemon() Deprecated. Get the daemon thread that cleans up expired sessions. |
protected TaskDaemon |
getSessionWorkerDaemon() Deprecated. Get the daemon thread that is used for scheduled tasks. |
protected long |
getShutdownDelayMillis() Deprecated. Determine the number of milliseconds to defer shutdown after the app appears to have stopped. |
protected static int[] |
getSupportedVersion(javax.servlet.ServletContext ctx) Deprecated. Determine the version of the spec to find the factory for based on the passed application server ServletContext object. |
protected WorkManager |
getWorkManager() Deprecated. Gets a WorkManager for use by the parallel reap task. |
protected int |
getWorkManagerMaxThreads() Deprecated. Returns the maximum number of threads used by the work manager. |
protected int |
getWorkManagerMinThreads() Deprecated. Returns the minimum number of threads used by the work manager. |
javax.servlet.ServletContext |
getWrappedServletContext() Deprecated. Returns the application server's ServletContext that this SessionHelper is helping with. |
static javax.servlet.ServletContext |
getWrappedServletContext(javax.servlet.ServletContext ctx) Deprecated. Determine the ServletContext wrapper for the specified application server context. |
protected HttpSessionCollection |
instantiateHttpSessionCollection() Deprecated. Get the HttpSessionCollection object that manages the HttpSessionModel objects. |
protected Object |
instantiateMBean() Deprecated. Factory Method: Instantiate a MBean implementation for this SessionHelper. |
protected SessionHelper.SessionReaperDaemon |
instantiateSessionReaperDaemon() Deprecated. Factory method: Instantiate a daemon thread that will clean up expired sessions. |
protected TaskDaemon |
instantiateSessionWorkerDaemon() Deprecated. Factory method: Instantiate a daemon thread that will be used for scheduled tasks. |
protected boolean |
isAttributeNameIgnored(String sName) Deprecated. Test to see if events for the specified name should be ignored. |
protected boolean |
isClusterOwned() Deprecated. Determine if the responsibility for shutting down the cluster is owned by the application. |
protected boolean |
isDaemonAssumeLocality() Deprecated. Determine if the reaper daemon assumes that session data is stored only on nodes that are running the session reaper daemon thread. |
protected boolean |
isDaemonCheckCoordinated() Deprecated. Determine if the reaper daemon coordinates the check across the cluster instead of just doing its own "local" scan. |
boolean |
isServletContextClustered() Deprecated. Determine if the context clusters attributes. |
boolean |
isServletRequestWrapped(javax.servlet.ServletRequest req) Deprecated. Test to see if the passed ServletRequest is wrapped, which means that invoking a method on the passed ServletRequest object will invoke the Coherence implementation, and will do so before the container implementation is invoked. |
boolean |
isSessionContextEnabled() Deprecated. Determine if the session context should disobey the deprecation and allow an application to enumerate sessions. |
boolean |
isSessionIdCookie(javax.servlet.http.Cookie cookie) Deprecated. Tests to see if the supplied cookie is a session ID cookie. |
boolean |
isSessionIdCookieEnabled() Deprecated. Determine if a cookie may be used to hold the session ID. |
boolean |
isSessionIdEncodingEnabled() Deprecated. Determine if URL encoding may be used to hold the session ID. |
boolean |
isStrict() Deprecated. Determine if the Servlet specification is being followed strictly. |
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. |
void |
killSession(String sId) Deprecated. Forcibly destroy a session. |
static void |
logEventException(RuntimeException e, String sMethod, boolean fContinue) Deprecated. Log an event exception. |
void |
onGetHttpSession(javax.servlet.http.HttpServletRequest req) Deprecated. Allow service helper to perform actions on getSession calls. |
static boolean |
parseBoolean(javax.servlet.ServletContext ctx, String sParam, boolean fDefault) Deprecated. Helper: Get a boolean init parameter from the context. |
static int |
parseInt(javax.servlet.ServletContext ctx, String sParam, int nDefault) Deprecated. Helper: Get an int init parameter from the context. |
static String |
parseString(javax.servlet.ServletContext ctx, String sParam, String sDefault) Deprecated. Helper: Get a String init parameter from the context. |
void |
postService(RequestContext ctx) Deprecated. Finish the request processing after the servlet/jsp is complete. |
RequestContext |
preService(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) Deprecated. Wrap the passed request and response (if necessary) and build a request context that contains all the pertinent information about the request. |
protected void |
registerMBean() Deprecated. Register an MBean instance for this SessionHelper. |
void |
removeIgnoreAttributeName(String sName) Deprecated. Unregister a name to ignore events for. |
void |
requestAsyncOwnership(String sId) Deprecated. Enter (obtain) and schedule an asynchronous call to exit (release) the specified session ID. |
void |
service(javax.servlet.Servlet servlet, javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp) Deprecated. Issue the service call to the specified servlet, given the passed request and response objects. |
void |
servletDestroyed() Deprecated. Called by each Coherence Servlet wrapper on destroy(). |
void |
servletInitialized() Deprecated. Called by each Coherence Servlet wrapper on init(). |
void |
setConfig(XmlElement xml) Deprecated. Specify the configuration for the object. |
void |
setHttpSession(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpSession session) Deprecated. Associate the supplied HttpSession with the given request. |
void |
setListeners(Listeners listeners) Deprecated. Store the application listeners. |
protected void |
setSessionWorkerDaemon(TaskDaemon daemon) Deprecated. Set the daemon thread that is used for scheduled tasks. |
protected void |
shutdown() Deprecated. Shuts down the SessionHelper and any mess that it created. |
protected void |
shutdownConfigurationCache() Deprecated. Shutdown the NamedCache used to store configuration and management information for the session management implementation. |
void |
shutdownHttpSessionCollection() Deprecated. Shutdown the http session collection. |
protected void |
shutdownServletContextAttributeCache() Deprecated. Shutdown the clustered attribute map. |
void |
shutdownSessionReaperDaemon() Deprecated. Stop the daemon thread that is used for expiring sessions. |
void |
shutdownSessionWorkerDaemon() Deprecated. Stop the daemon thread that is used for scheduled tasks. |
String |
toString() Deprecated. Returns a string representation of the object. |
protected void |
unregisterMBean() Deprecated. Unregister the MBean instance for this SessionHelper. |
javax.servlet.FilterConfig |
unwrapFilterConfig(javax.servlet.FilterConfig cfg) Deprecated. Attempt to unwrap the passed FilterConfig wrapper to get the container's FilterConfig object back. |
javax.servlet.ServletConfig |
unwrapServletConfig(javax.servlet.ServletConfig cfg) Deprecated. Attempt to unwrap the passed ServletConfig wrapper to get the container's ServletConfig object back. |
javax.servlet.ServletRequest |
unwrapServletRequest(javax.servlet.ServletRequest req) Deprecated. Fully unwrap the specified request object. |
javax.servlet.FilterConfig |
wrapFilterConfig(javax.servlet.FilterConfig cfg) Deprecated. Given the specified FilterConfig object, return a wrapper to use. |
javax.servlet.ServletConfig |
wrapServletConfig(javax.servlet.ServletConfig cfg) Deprecated. Given the specified servlet config object, return a wrapper to use. |
javax.servlet.ServletRequest |
wrapServletRequest(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) Deprecated. Given the specified request, create a request wrapper. |
Field Detail |
---|
public static final String PRODUCT_BANNER
public static final String CACHE_CONFIGURATION_PATH
public static final int EVT_ADDED
public static final int EVT_REMOVED
public static final int EVT_REPLACED
public static final String CTX_INIT_CONFIGURATION_CONSISTENCY
public static final String CTX_INIT_APPLICATION_NAME
public static final String CTX_INIT_FACTORY
public static final String CTX_INIT_COLLECTION
public static final String CTX_INIT_CLUSTER_OWNED
public static final String CTX_INIT_CLUSTER
public static final String CTX_INIT_CACHENAME_CONTEXT
public static final String CTX_INIT_LISTENS
public static final String CTX_INIT_SESSIONCONTEXT_ENABLED
public static final String CTX_INIT_SESSION_RETAIN_MILLIS
public static final String CTX_INIT_COOKIES_ENABLED
public static final String CTX_INIT_COOKIE_NAME
public static final String CTX_INIT_COOKIE_DOMAIN
public static final String CTX_INIT_COOKIE_PATH
public static final String CTX_INIT_COOKIE_MAX_AGE
public static final String CTX_INIT_COOKIE_SECURE
public static final String CTX_INIT_URLENCODE_ENABLED
public static final String CTX_INIT_URLENCODE_NAME
public static final String CTX_INIT_URLDECODE_DEFAULT
public static final String CTX_INIT_URLENCODE_DEFAULT
public static final String CTX_INIT_DAEMON_PRIORITY
public static final String CTX_INIT_DAEMON_CYCLE_SECS
public static final String CTX_INIT_DAEMON_COORDINATED
public static final String CTX_INIT_DAEMON_ASSUME_LOCALITY
public static final String CTX_INIT_DAEMON_SWEEP_MODULO
public static final String CTX_INIT_DAEMON_PARALLEL
public static final String CTX_INIT_DAEMON_MIN_THREADS
public static final String CTX_INIT_DAEMON_MAX_THREADS
public static final String CTX_INIT_DAEMON_QUEUE_SIZE
public static final String CTX_INIT_CACHENAME_MANAGEMENT
public static final String CTX_INIT_CACHENAME_SESSIONS
public static final String CTX_INIT_CACHENAME_DEATHCERTS
public static final String CTX_INIT_CACHENAME_OVERFLOW
public static final String CTX_INIT_CACHENAME_LOCAL_SESSIONS
public static final String CTX_INIT_CACHENAME_LOCAL_ATTRIBUTES
public static final String CTX_INIT_SESSION_EXPIRE_SECS
public static final String CTX_INIT_SESSION_ID_LENGTH
public static final String CTX_INIT_SESSION_ID_GENERATOR_CLASS
public static final String CTX_INIT_ATTR_OVERFLOW_THRESHOLD
public static final String CTX_INIT_SESSION_LOCK
public static final String CTX_INIT_SESSION_MEMBER_LOCK
public static final String CTX_INIT_SESSION_APP_LOCK
public static final String CTX_INIT_SESSION_THREAD_LOCK
public static final String CTX_INIT_SESSION_GET_LOCK_TIMEOUT
public static final String CTX_INIT_LOG_THREADS_HOLDING_LOCK
public static final String CTX_INIT_SESSION_STRICT_SPEC
public static final String CTX_INIT_SESSION_LAZY_ACCESS
public static final String CTX_INIT_SHUTDOWN_DELAY_SECS
public static final String CTX_INIT_SERVLET
This is used in a web-xml
<servlet>
element to designate the application servlet name that the Coherence implementation is being wrapped around; this must be done for each application servlet.
Before:
<servlet>
<servlet-name>MyServlet</servlet-name>
<display-name>MyServlet</display-name>
<description>this servlet is part of my app</description>
<servlet-class>com.mypkg.MyServlet</servlet-class>
<init-param>
<param-name>ContextPath</param-name>
<param-value>/tomcat</param-value>
</init-param>
</servlet>
After:
<servlet>
<servlet-name>MyServlet</servlet-name>
<display-name>MyServlet</display-name>
<description>this servlet is part of my app</description>
<servlet-class>com.tangosol.coherence.servlet.api22.HttpServletWrapper</servlet-class>
<init-param>
<param-name>ContextPath</param-name>
<param-value>/tomcat</param-value>
</init-param>
<init-param>
<param-name>coherence-servlet-class</param-name>
<param-value>com.mypkg.MyServlet</param-value>
</init-param>
</servlet>
public static final String CTX_INIT_FILTER
This is used in a web-xml
<filter>
element to designate the application filter name that the Coherence implementation is being wrapped around; this must be done for each application filter.
public static final String CTX_INIT_DIST_CONTROLLER_CLASS
public static final String CTX_INIT_SCOPE_CONTROLLER_CLASS
public static final String CTX_INIT_SESSION_STICKY
public static final String CTX_INIT_SERVICENAME_OWNERSHIP
public static final String CTX_INIT_ALLOW_LOCAL_ATTRIBUTES
public static final String CTX_INIT_ENABLE_SUSPECT_ATTRIBUTES
public static final String CTX_INIT_ENABLE_ATTR_LISTENER_OPTIMIZATION
protected static final String CTX_INIT_APPLICATION_NAME_GENERATED
protected static final String CTX_INIT_SESSION_EXPIRY_FILTER_FACTORY
public static final String CTX_ATTR_HELPER
public static final String CTX_ATTR_CONTEXT
Also, the name of the request attribute used to store the request context.
public static final String REQ_ATTR_COUNT
public static final String REQ_ATTR_SESSION
public static final String REQ_ATTR_TEST
public static final String DEFAULT_FACTORY
public static final String DEFAULT_CTXNAME
public static final String DEFAULT_MGTNAME
public static final String CFG_KEY_REAPER
public static final Filter NAME_FILTER
protected static ConfigurableCacheFactory s_cachefactory
Constructor Detail |
---|
public SessionHelper(SessionHelper.Factory factory, javax.servlet.ServletContext ctx)
factory
- the object that will instantiate the container-specific (or servlet spec specific) implementationsctx
- the application server's ServletContext objectMethod Detail |
---|
protected void configure(int nVersionMajor, int nVersionMinor)
nVersionMajor
- the servlet specification major version numbernVersionMinor
- the servlet specification minor version numberprotected void checkConfigConsistency(com.tangosol.coherence.servlet.ValidatingConfiguration configuration)
IllegalStateException
- if configuration is inconsistentprotected com.tangosol.coherence.servlet.ConfigurationConsistencyVerifier getConfigurationConsistencyVerifier()
public void clearStoredConfiguration()
public XmlElement getConfig()
public void setConfig(XmlElement xml)
xml
- the XML configuration for the objectIllegalStateException
- if the object is not in a state that allows the configuration to be set; for example, if the object has already been configured and cannot be reconfiguredpublic static SessionHelper ensureSessionHelper(javax.servlet.ServletContext ctx)
ctx
- the application server's ServletContext objectprotected static int[] getSupportedVersion(javax.servlet.ServletContext ctx)
Note: Hard-coded to support 2.3 through 2.5.
ctx
- the application server's ServletContext objectpublic static ConfigurableCacheFactory getConfigurableCacheFactory()
public static NamedCache getCache(String sCacheName)
sCacheName
- the name of the cache to obtainpublic static InvocationService getInvocationService(String sService)
sService
- the name of the invocation service to obtainprotected String getApplicationName()
protected String getMBeanObjectName()
protected Object instantiateMBean()
protected void registerMBean()
protected void unregisterMBean()
public void contextInitialized()
public void contextDestroyed()
public void servletInitialized()
public void servletDestroyed()
public void filterInitialized()
public void filterDestroyed()
protected void shutdown()
protected boolean isClusterOwned()
protected long getShutdownDelayMillis()
public static javax.servlet.ServletContext getWrappedServletContext(javax.servlet.ServletContext ctx)
ctx
- a ServletContextpublic static javax.servlet.ServletContext ensureWrappedServletContext(javax.servlet.ServletContext ctx)
ctx
- this application's ServletContextpublic javax.servlet.ServletContext getServletContext()
public NamedCache getServletContextAttributeCache()
protected NamedCache ensureServletContextAttributeCache()
protected void shutdownServletContextAttributeCache()
public int getServletContextMajorVersion()
public int getServletContextMinorVersion()
public javax.servlet.ServletContext getWrappedServletContext()
public boolean isServletContextClustered()
public boolean isStrict()
public static String parseString(javax.servlet.ServletContext ctx, String sParam, String sDefault)
ctx
- the ServletContextsParam
- the init parameter namesDefault
- the default to return if the init parameter is not present or is blankpublic static boolean parseBoolean(javax.servlet.ServletContext ctx, String sParam, boolean fDefault)
ctx
- the ServletContextsParam
- the init parameter namefDefault
- the default to return if the init parameter is not present or is not a boolean valuepublic static int parseInt(javax.servlet.ServletContext ctx, String sParam, int nDefault)
ctx
- the ServletContextsParam
- the init parameter namenDefault
- the default to return if the init parameter is not present or is not an int valuepublic Listeners getListeners()
public void setListeners(Listeners listeners)
listeners
- a Listeners object containing all EventListener objects for the applicationprotected Listeners getContextAttributeListeners()
public void addIgnoreAttributeName(String sName)
sName
- the name to ignore events forpublic void removeIgnoreAttributeName(String sName)
sName
- the name to no longer ignore events forprotected boolean isAttributeNameIgnored(String sName)
sName
- the name to test whether events are being ignored forpublic void dispatchAttributeEvent(int nEvent, javax.servlet.ServletContextAttributeEvent evt)
nEvent
- the internal enum that identifies the event nameevt
- the application server's ServletContextAttributeEventpublic void dispatchInternalAttributeEvent(int nEvent, javax.servlet.ServletContextAttributeEvent evt)
nEvent
- the internal enum that identifies the event nameevt
- the application server's ServletContextAttributeEventpublic javax.servlet.FilterConfig wrapFilterConfig(javax.servlet.FilterConfig cfg)
cfg
- the container's FilterConfig objectpublic javax.servlet.FilterConfig unwrapFilterConfig(javax.servlet.FilterConfig cfg)
public void filter(javax.servlet.Filter filter, javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp, javax.servlet.FilterChain chain) throws javax.servlet.ServletException, IOException
filter
- the application's filter to invokereq
- the ServletRequest
object that contains the client's requestresp
- the ServletResponse
object that contains the servlet's responsechain
- the FilterChain to use to invoke the next filter or the Servletjavax.servlet.ServletException
IOException
public javax.servlet.ServletConfig wrapServletConfig(javax.servlet.ServletConfig cfg)
cfg
- the container's servlet config objectpublic javax.servlet.ServletConfig unwrapServletConfig(javax.servlet.ServletConfig cfg)
public boolean isServletRequestWrapped(javax.servlet.ServletRequest req)
req
- a ServletRequest objectpublic javax.servlet.ServletRequest wrapServletRequest(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
req
- a ServletRequest object that might need wrappingres
- the associated ServletResponsepublic javax.servlet.ServletRequest unwrapServletRequest(javax.servlet.ServletRequest req)
req
- a ServletRequest objectpublic String decodeCookie(javax.servlet.http.HttpServletRequest req)
req
- an HttpServletRequest object that may have a session cookie attached to itpublic void encodeCookie(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String sId, boolean fNew)
req
- the HttpServletRequest object for the current requestres
- the HttpServletResponse object for the current request that the session cookie should be attached tosId
- the session IDfNew
- true if the session was just createdpublic boolean isSessionIdCookie(javax.servlet.http.Cookie cookie)
cookie
- the cookie to testpublic RequestContext createRequestContext(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
req
- a ServletRequest object that might need wrapping or might have already been wrappedres
- a ServletResponse object that might need wrapping or might have already been wrappedprotected com.tangosol.coherence.servlet.ServiceHelper createServiceHelper()
public RequestContext preService(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) throws javax.servlet.ServletException, IOException
req
- the servlet response object (could already be wrapped)res
- the servlet response object (could already be wrapped)javax.servlet.ServletException
IOException
public void postService(RequestContext ctx) throws javax.servlet.ServletException, IOException
ctx
- the request context returned by preService()
javax.servlet.ServletException
IOException
public void service(javax.servlet.Servlet servlet, javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp) throws javax.servlet.ServletException, IOException
servlet
- the servlet to invokereq
- a ServletRequest object that might need wrapping or might have already been wrappedresp
- might a ServletResponse object that might need wrapping or have already been wrappedjavax.servlet.ServletException
IOException
protected HttpSessionCollection instantiateHttpSessionCollection()
public HttpSessionCollection getHttpSessionCollection()
protected Map getHttpSessionMap()
public Set getLocalSessionIds()
public javax.servlet.http.HttpSession createHttpSession()
public javax.servlet.http.HttpSession getHttpSession(String sId)
sId
- the session IDpublic javax.servlet.http.HttpSession ensureHttpSession(String sId)
sId
- the session IDpublic javax.servlet.http.HttpSession getHttpSession(javax.servlet.http.HttpServletRequest req)
req
- the requestpublic void onGetHttpSession(javax.servlet.http.HttpServletRequest req)
HttpServletRequest.getSession(boolean)
method.req
- the requestcom.tangosol.coherence.servlet.api23.HttpServletRequestWrapper#getSession()
public void setHttpSession(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpSession session)
req
- the requestsession
- the session to associate with the given requestpublic boolean isSessionContextEnabled()
public javax.servlet.http.HttpSessionContext getHttpSessionContext()
public boolean isSessionIdCookieEnabled()
public String getSessionIdCookieName()
public String getSessionIdCookieDomain()
public String getSessionIdCookiePath()
public int getSessionIdCookieMaxAge()
public boolean getSessionIdCookieSecure()
public boolean isSessionIdEncodingEnabled()
public String getSessionIdEncodingName()
public boolean isUseDefaultSessionIdDecoding()
public boolean isUseDefaultSessionIdEncoding()
public String decodeUrl(javax.servlet.http.HttpServletRequest request)
request
- the current HttpServletRequestpublic String encodeUrl(String sUrl, javax.servlet.http.HttpServletRequest request)
sUrl
- the URL to be encodedrequest
- the current HttpServletRequestprotected String encodeUrl(String sUrl, String sId)
sUrl
- the URL to be encodedsId
- the session ID to encode in the URLpublic void enterSession(String sId)
If the session specified by the session ID does not exist, then this method has no effect; no exception is thrown.
sId
- the session idpublic void exitSession(String sId, boolean fNew)
enterSession(sId)
, with the only exceptions being:
enterSession(sId)
method was never invoked.If the session specified by the session ID does not exist, then this method has no effect; no exception is thrown.
sId
- the session idfNew
- true if the session was just createdpublic void requestAsyncOwnership(String sId)
sId
- the session ID to async enter and exitpublic void shutdownHttpSessionCollection()
public String toString()
public NamedCache getConfigurationCache()
protected NamedCache ensureConfigurationCache()
protected void shutdownConfigurationCache()
protected String getDescription()
public SessionHelper.Factory getFactory()
protected SessionHelper.SessionReaperDaemon instantiateSessionReaperDaemon()
protected SessionHelper.SessionReaperDaemon getSessionReaperDaemon()
protected int getDaemonPriority()
protected long getDaemonCycleMillis()
protected int getDaemonCheckCollectionModulo()
protected boolean isDaemonCheckCoordinated()
protected boolean isDaemonAssumeLocality()
protected int getWorkManagerMinThreads()
protected int getWorkManagerMaxThreads()
protected WorkManager getWorkManager()
protected com.tangosol.coherence.servlet.SessionHelper.ReapTaskFactory getReapTaskFactory()
protected void checkForDeadSessions()
public void killSession(String sId)
sId
- the session ID to destroypublic void shutdownSessionReaperDaemon()
protected TaskDaemon instantiateSessionWorkerDaemon()
protected TaskDaemon getSessionWorkerDaemon()
protected void setSessionWorkerDaemon(TaskDaemon daemon)
daemon
- the session worker daemonpublic TaskDaemon ensureSessionWorkerDaemon()
public void shutdownSessionWorkerDaemon()
public static String formatListeners(Listeners listeners)
listeners
- a Listeners objectpublic static String formatCacheName(NamedCache cache)
cache
- a NamedCache objectpublic static String formatMapKeys(Map map)
map
- a Map objectpublic static void logEventException(RuntimeException e, String sMethod, boolean fContinue)
e
- the exceptionsMethod
- the event method name etc.fContinue
- true if the execution will be continued; false if the exception has to be logged and re-thrown
|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |