|
CoherenceTM v3.3 Copyright© 2000-2007 by Oracle Corporation |
|||||||
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
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
This interface is used by the SessionHelper to obtain objects that implement various important parts of the Servlet specification, and by doing so, can be placed in front of the application in lieu of the application server's own objects, thus changing the "apparent implementation" of the application server itself (e.g. |
class |
SessionHelper.SessionReaperDaemon
A daemon thread class that will clean up expired sessions. |
protected static interface |
SessionHelper.Task
Interface for detecting when a Runnable Task has completed. |
Field Summary | |
---|---|
static String |
CACHE_CONFIGURATION_PATH
The name of the resource that will be used to configure the session management module's own ConfigurableCacheFactory. |
static String |
CFG_KEY_REAPER
The key in the configuration cache for coordating cluster-wide session reaping. |
static String |
CTX_ATTR_CONTEXT
The name of the application server context's attribute that Coherence stores its servlet context object under. |
static String |
CTX_ATTR_HELPER
The name of the application server context's attribute that Coherence stores its session helper object under. |
static String |
CTX_INIT_ALLOW_LOCAL_ATTRIBUTES
The configuration property that specifies whether non-serializable attributes should be preserved as local. |
static String |
CTX_INIT_ATTR_OVERFLOW_THRESHOLD
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
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
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
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
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
The configuration property that overrides the name of the clustered cache that stores the sessions management configuration data. |
static String |
CTX_INIT_CACHENAME_OVERFLOW
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
The configuration property that overrides the name of the clustered cache that stores the sessions. |
static String |
CTX_INIT_CLUSTER
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
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
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_CONTROLLER_CLASS
The configuration property that specifies an implementation of the SessionDistributionController interface to use. |
static String |
CTX_INIT_COOKIE_DOMAIN
The domain of the session cookie. |
static String |
CTX_INIT_COOKIE_MAX_AGE
The maximum age in seconds of the session cookie. |
static String |
CTX_INIT_COOKIE_NAME
The name of the session cookie. |
static String |
CTX_INIT_COOKIE_PATH
The path of the session cookie. |
static String |
CTX_INIT_COOKIES_ENABLED
True to enable session cookies. |
static String |
CTX_INIT_DAEMON_ASSUME_LOCALITY
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
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
The number of seconds that the daemon rests between reaping. |
static String |
CTX_INIT_DAEMON_PRIORITY
The priority for the session reaper daemon. |
static String |
CTX_INIT_DAEMON_SWEEP_MODULO
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_FACTORY
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
In the filter's configuration, the name of the filter class that is wrapped by the Coherence filter. |
static String |
CTX_INIT_LISTENS
The comma-delimited list of names of application classes that wish to receive events from the web container. |
static String |
CTX_INIT_SERVICENAME_OWNERSHIP
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
In the servlet's configuration, the name of the servlet class that is wrapped by the Coherence servlet. |
static String |
CTX_INIT_SESSION_EXPIRE_SECS
The configuration property that overrides the session expirty time. |
static String |
CTX_INIT_SESSION_ID_LENGTH
The configuration property that overrides the session id length. |
static String |
CTX_INIT_SESSION_RETAIN_MILLIS
The length of time to defer async exit on a session that is accessed "out of context". |
static String |
CTX_INIT_SESSION_STICKY
The configuration property that specifies whether sticky sessions optimizations will be used. |
static String |
CTX_INIT_SESSION_STRICT_SPEC
The configuration property that specifies strict spec adherence. |
static String |
CTX_INIT_SESSION_THREAD_LOCK
The configuration property that specifies thread level session locking. |
static String |
CTX_INIT_SESSIONCONTEXT_ENABLED
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
The configuration property that overrides the shutdown delay time. |
static String |
CTX_INIT_UNWRAP_REQUEST
True to force the request dispatcher to unwrap the servlet request before forwarding or including. |
static String |
CTX_INIT_UNWRAP_RESPONSE
True to force the request dispatcher to unwrap the servlet response before forwarding or including. |
static String |
CTX_INIT_URLDECODE_DEFAULT
True to use the container's decoding of the URL session ID. |
static String |
CTX_INIT_URLENCODE_DEFAULT
True to use the container's encoding of the URL session ID. |
static String |
CTX_INIT_URLENCODE_ENABLED
True to enable URL encoding of session ids. |
static String |
CTX_INIT_URLENCODE_NAME
The parameter name to encode the session id into the URL with. |
static String |
DEFAULT_CTXNAME
The default cache name for the ServletContext attribute map. |
static String |
DEFAULT_FACTORY
The default class name for the SessionHelper factory implementation. |
static String |
DEFAULT_MGTNAME
The default cache name for the session management configuration data. |
static Object |
DISPATCH_FORWARD
The value of the REQ_ATTR_DISPATCH request attribute that
indicates the current request has been forwarded. |
static Object |
DISPATCH_INCLUDE
The value of the REQ_ATTR_DISPATCH request attribute that
indicates the current request has been included. |
static int |
EVT_ADDED
The internal enum for an attribute-added event. |
static int |
EVT_REMOVED
The internal enum for an attribute-removed event. |
static int |
EVT_REPLACED
The internal enum for an attribute-replaced event. |
protected static String |
KEY_REQUEST
|
static String |
KEY_REQUEST_RESOLVED
The key used to store the dispatchable Servlet request in the map returned by preDispatch . |
protected static String |
KEY_RESPONSE
|
static String |
KEY_RESPONSE_RESOLVED
The key used to store the dispatchable Servlet response in the map returned by preDispatch . |
protected static String |
KEY_SESSION_ID
|
static Filter |
NAME_FILTER
The Filter object that hides init param names for Coherence params. |
static String |
PRODUCT_BANNER
The product name banner. |
static String |
REQ_ATTR_CONTEXT
The name of the request attribute that Coherence stores the request context object in. |
static String |
REQ_ATTR_DISPATCH
The name of the request attribute that Coherence stores the current request dispatch method. |
static String |
REQ_ATTR_OK_WRAP
The name of the request attribute that indicates that wrapping is not required. |
static String |
REQ_ATTR_REQUEST
The name of the request attribute that Coherence stores the current request object in. |
static String |
REQ_ATTR_RESPONSE
The name of the request attribute that Coherence stores the original wrapped response object in. |
static String |
REQ_ATTR_TEST
The name of the request attribute that tests if the Coherence wrapper is in place. |
static String |
REQ_ATTR_WRAPPED
The name of the request attribute that Coherence stores its own request object in. |
protected static ConfigurableCacheFactory |
s_cachefactory
The session management module's own ConfigurableCacheFactory. |
Constructor Summary | |
---|---|
SessionHelper(SessionHelper.Factory factory,
ServletContext ctx)
Construct a Coherence SessionHelper that will support the implementation of clustered web container services. |
Method Summary | |
---|---|
protected void |
checkExpiredSessionId(String sId)
Check the specified session to see if it has expired. |
protected void |
checkForDeadSessions()
Discard the HttpSession objects that are no longer alive. |
protected void |
configure(int nVersionMajor,
int nVersionMinor)
Called immediately after construction. |
void |
contextDestroyed()
Called by the Coherence ServletContextListener on contextDestroyed() if an event listener is registered. |
void |
contextInitialized()
Called by the Coherence ServletContextListener on contextInitialized() if an event listener is registered. |
HttpSession |
createHttpSession()
Create a new HttpSession object. |
String |
decodeCookie(HttpServletRequest req)
Obtain a session ID from a request object by examining the cookies attached to the request. |
String |
decodeUrl(HttpServletRequest request)
Decodes the session ID from the URL represented by the passed request. |
void |
encodeCookie(HttpServletRequest req,
HttpServletResponse resp,
String sId,
boolean fNew)
Encode a session ID into a cookie and attach it to the response object. |
String |
encodeUrl(String sUrl,
HttpServletRequest request)
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)
Encodes the specified URL by including the given session ID in it. |
protected NamedCache |
ensureConfigurationCache()
Get the NamedCache used to store configuration and management information for the session management implementation if it exists, otherwise create it. |
RequestContext |
ensureRequestContext(ServletRequest req,
ServletResponse res)
Given the specified request and response, provide a request context. |
RequestContext |
ensureRequestContext(ServletRequest req,
ServletResponse res,
boolean fExternal)
Given the specified request and response, provide a request context. |
protected NamedCache |
ensureServletContextAttributeCache()
Get the clustered attribute map if it exists, otherwise create it (if the ServletContext is supposed to be clustered). |
static SessionHelper |
ensureSessionHelper(ServletContext ctx)
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()
Get the daemon thread that is used for scheduled tasks, creating it if necessary. |
static ServletContext |
ensureWrappedServletContext(ServletContext ctx)
Make sure that there is a ServletContext wrapper for the specified servlet context for this application, creating one if necessary. |
void |
filter(Filter filter,
ServletRequest req,
ServletResponse resp,
FilterChain chain)
Issue the service call to the specified servlet, given the passed request and response objects. |
void |
filterDestroyed()
Called by each Coherence Filter wrapper on destroy(). |
void |
filterInitialized()
Called by each Coherence Filter wrapper on init(). |
static String |
formatCacheName(NamedCache cache)
Format a NamedCache object into a human readable string. |
static String |
formatListeners(Listeners listeners)
Format a Listeners object into a human readable string. |
static String |
formatMapKeys(Map map)
Format a map into a list of keys. |
static NamedCache |
getCache(String sCacheName)
Obtain a session management cache by name. |
XmlElement |
getConfig()
Determine the current configuration of the object. |
NamedCache |
getConfigurationCache()
Get the NamedCache used to store configuration and management information for the session management implementation. |
protected int |
getDaemonCheckCollectionModulo()
Determine how many times the daemon will perform its check before checking the session models that the collection considers "local". |
protected long |
getDaemonCycleMillis()
Determine the number of milliseconds per reap cycle. |
protected int |
getDaemonPriority()
Determine the configured priority for the session reaper daemon. |
protected String |
getDescription()
Returns a string representation of this object's attributes. |
SessionHelper.Factory |
getFactory()
Determine the factory to use to instantiate container-specific implementations of the Servlet specification interfaces. |
HttpSession |
getHttpSession(String sId)
Get the HttpSession object for the specified ID. |
HttpSessionCollection |
getHttpSessionCollection()
Get the HttpSessionCollection object that manages the HttpSessionModel objects. |
HttpSessionContext |
getHttpSessionContext()
Get the HttpSessionContext. |
protected Map |
getHttpSessionMap()
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)
Obtain a session management invocation service by name. |
Listeners |
getListeners()
Get the application listeners. |
protected String |
getMBeanObjectName()
Return a string representation of the ObjectName used to register the MBean instance for this SessionHelper. |
RequestContext |
getRequestContext(ServletRequest req)
Get the request context for the passed request, if one exists. |
ServletContext |
getServletContext()
Returns the Coherence ServletContext wrapper that this SessionHelper is helping with. |
NamedCache |
getServletContextAttributeCache()
Get the clustered attribute map. |
int |
getServletContextMajorVersion()
Returns the major version of the Java Servlet API that this servlet container supports. |
int |
getServletContextMinorVersion()
Returns the minor version of the Servlet API that this servlet container supports. |
ServletRequest |
getServletRequest(ServletRequest req)
If the passed ServletRequest has been wrapped, return the current request object that was wrapped. |
ServletRequest |
getServletRequestWrapper(ServletRequest req)
If the passed ServletRequest has been wrapped, return the request wrapper. |
String |
getSessionIdCookieDomain()
Determine the domain of the cookie for holding the session ID. |
int |
getSessionIdCookieMaxAge()
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. |
protected SessionHelper.SessionReaperDaemon |
getSessionReaperDaemon()
Get the daemon thread that cleans up expired sessions. |
protected TaskDaemon |
getSessionWorkerDaemon()
Get the daemon thread that is used for scheduled tasks. |
protected long |
getShutdownDelayMillis()
Determine the number of milliseconds to defer shutdown after the app appears to have stopped. |
protected static int[] |
getSupportedVersion(ServletContext ctx)
Determine the version of the spec to find the factory for based on the passed application server ServletContext object. |
ServletContext |
getWrappedServletContext()
Returns the application server's ServletContext that this SessionHelper is helping with. |
static ServletContext |
getWrappedServletContext(ServletContext ctx)
Determine the ServletContext wrapper for the specified application server context. |
protected HttpSessionCollection |
instantiateHttpSessionCollection()
Get the HttpSessionCollection object that manages the HttpSessionModel objects. |
protected Object |
instantiateMBean()
Factory Method: Instantiate a MBean implementation for this SessionHelper. |
protected SessionHelper.SessionReaperDaemon |
instantiateSessionReaperDaemon()
Factory method: Instantiate a daemon thread that will clean up expired sessions. |
protected TaskDaemon |
instantiateSessionWorkerDaemon()
Factory method: Instantiate a daemon thread that will be used for scheduled tasks. |
protected boolean |
isClusterOwned()
Determine if the responsibility for shutting down the cluster is owned by the application. |
protected boolean |
isDaemonAssumeLocality()
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()
Determine if the reaper daemon coordinates the check across the cluster instead of just doing its own "local" scan. |
boolean |
isRequestUnwrapRequired()
Determine if the custom servlet request wrapper needs to be unwrapped before including or forwarding to other content. |
boolean |
isResponseUnwrapRequired()
Determine if the custom servlet response wrapper needs to be unwrapped before including or forwarding to other content. |
boolean |
isServletContextClustered()
Determine if the context clusters attributes. |
boolean |
isServletRequestDispatched(ServletRequest req)
Test to see if the passed ServletRequest has been dispatched as a result of an include or forward. |
boolean |
isServletRequestForwarded(ServletRequest req)
Test to see if the passed ServletRequest has been dispatched as a result of a forward. |
boolean |
isServletRequestIncluded(ServletRequest req)
Test to see if the passed ServletRequest has been dispatched as a result of an include. |
boolean |
isServletRequestWrapped(ServletRequest req)
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()
Determine if the session context should disobey the deprecation and allow an application to enumerate sessions. |
boolean |
isSessionIdCookie(Cookie cookie)
Tests to see if the supplied cookie is a session ID cookie. |
boolean |
isSessionIdCookieEnabled()
Determine if a cookie may be used to hold the session ID. |
boolean |
isSessionIdEncodingEnabled()
Determine if URL encoding may be used to hold the session ID. |
boolean |
isStrict()
Determine if the Servlet specification is being followed strictly. |
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. |
void |
killSession(String sId)
Forcibly destroy a session. |
static void |
logEventException(RuntimeException e,
String sMethod,
boolean fContinue)
Log an event exception. |
static boolean |
parseBoolean(ServletContext ctx,
String sParam,
boolean fDefault)
Helper: Get a boolean init parameter from the context. |
static int |
parseInt(ServletContext ctx,
String sParam,
int nDefault)
Helper: Get an int init parameter from the context. |
static String |
parseString(ServletContext ctx,
String sParam,
String sDefault)
Helper: Get a String init parameter from the context. |
void |
postDispatch(ServletRequest req,
Map map)
Restores a Servlet request to the state it was in prior to being dispatched. |
void |
postService(RequestContext ctx)
Finish the request processing after the servlet/jsp is complete. |
Map |
preDispatch(ServletRequest req,
ServletResponse res)
Prepares a Servlet request to be dispatched by a RequestDispatcher. |
RequestContext |
preService(ServletRequest req,
ServletResponse res)
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()
Register an MBean instance for this SessionHelper. |
void |
requestAsyncOwnership(String sId)
Enter (obtain) and schedule an asynchronous call to exit (release) the specified session ID. |
ServletRequest |
resolveRequest(ServletRequest req)
Determine what request object should be sent to the application server's request dispatcher: the application server's request object, or the wrapper that we created. |
ServletResponse |
resolveResponse(ServletRequest req,
ServletResponse res)
Determine what response object should be sent to the application server's request dispatcher: the application server's response object, or the wrapper that we created. |
void |
service(Servlet servlet,
ServletRequest req,
ServletResponse resp)
Issue the service call to the specified servlet, given the passed request and response objects. |
void |
servletDestroyed()
Called by each Coherence Servlet wrapper on destroy(). |
void |
servletInitialized()
Called by each Coherence Servlet wrapper on init(). |
void |
setConfig(XmlElement xml)
Specify the configuration for the object. |
void |
setListeners(Listeners listeners)
Store the application listeners. |
protected void |
setSessionWorkerDaemon(TaskDaemon daemon)
Set the daemon thread that is used for scheduled tasks. |
protected void |
shutdown()
Shuts down the SessionHelper and any mess that it created. |
protected void |
shutdownConfigurationCache()
Shutdown the NamedCache used to store configuration and management information for the session management implementation. |
void |
shutdownHttpSessionCollection()
Shutdown the http session collection. |
protected void |
shutdownServletContextAttributeCache()
Shutdown the clustered attribute map. |
void |
shutdownSessionReaperDaemon()
Stop the daemon thread that is used for expiring sessions. |
void |
shutdownSessionWorkerDaemon()
Stop the daemon thread that is used for scheduled tasks. |
String |
toString()
Returns a string representation of the object. |
protected void |
unregisterMBean()
Unregister the MBean instance for this SessionHelper. |
FilterConfig |
unwrapFilterConfig(FilterConfig cfg)
Attempt to unwrap the passed FilterConfig wrapper to get the container's FilterConfig object back. |
ServletConfig |
unwrapServletConfig(ServletConfig cfg)
Attempt to unwrap the passed ServletConfig wrapper to get the container's ServletConfig object back. |
ServletRequest |
unwrapServletRequest(ServletRequest req)
Unwrap the specified request object. |
FilterConfig |
wrapFilterConfig(FilterConfig cfg)
Given the specified FilterConfig object, return a wrapper to use. |
RequestDispatcher |
wrapRequestDispatcher(RequestDispatcher disp)
Wrap the specified RequestDispatcher object from the container. |
ServletConfig |
wrapServletConfig(ServletConfig cfg)
Given the specified servlet config object, return a wrapper to use. |
ServletRequest |
wrapServletRequest(ServletRequest req)
Given the specified request, create a request wrapper. |
ServletRequest |
wrapServletRequest(ServletRequest req,
boolean fExternal)
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_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_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_UNWRAP_REQUEST
public static final String CTX_INIT_UNWRAP_RESPONSE
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_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_ATTR_OVERFLOW_THRESHOLD
public static final String CTX_INIT_SESSION_THREAD_LOCK
public static final String CTX_INIT_SESSION_STRICT_SPEC
public static final String CTX_INIT_SHUTDOWN_DELAY_SECS
public static final String CTX_INIT_SERVLET
This is used in a web-xml
element to designate the application servlet name that the Coherence
implementation is being wrapped around; this must be done for each
application servlet.
<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
element to designate the application filter name that the Coherence
implementation is being wrapped around; this must be done for each
application filter.
<filter>
public static final String CTX_INIT_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_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_CONTEXT
public static final String REQ_ATTR_DISPATCH
public static final String REQ_ATTR_REQUEST
public static final String REQ_ATTR_RESPONSE
public static final String REQ_ATTR_WRAPPED
public static final String REQ_ATTR_TEST
public static final String REQ_ATTR_OK_WRAP
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
public static final Object DISPATCH_FORWARD
REQ_ATTR_DISPATCH
request attribute that
indicates the current request has been forwarded.
public static final Object DISPATCH_INCLUDE
REQ_ATTR_DISPATCH
request attribute that
indicates the current request has been included.
public static final String KEY_REQUEST_RESOLVED
preDispatch
.
public static final String KEY_RESPONSE_RESOLVED
preDispatch
.
protected static final String KEY_REQUEST
protected static final String KEY_RESPONSE
protected static final String KEY_SESSION_ID
protected static ConfigurableCacheFactory s_cachefactory
Constructor Detail |
---|
public SessionHelper(SessionHelper.Factory factory, 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 numberpublic XmlElement getConfig()
public void setConfig(XmlElement xml)
xml
- the XML configuration for the object
IllegalStateException
- 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(ServletContext ctx)
ctx
- the application server's ServletContext objectprotected static int[] getSupportedVersion(ServletContext ctx)
Note: Hard-coded to support 2.2 through 2.4.
ctx
- the application server's ServletContext object
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 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 ServletContext getWrappedServletContext(ServletContext ctx)
ctx
- a ServletContext
public static ServletContext ensureWrappedServletContext(ServletContext ctx)
ctx
- this application's ServletContext
public ServletContext getServletContext()
public NamedCache getServletContextAttributeCache()
protected NamedCache ensureServletContextAttributeCache()
protected void shutdownServletContextAttributeCache()
public int getServletContextMajorVersion()
public int getServletContextMinorVersion()
public ServletContext getWrappedServletContext()
public boolean isServletContextClustered()
public boolean isStrict()
public static String parseString(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 blank
public static boolean parseBoolean(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 value
public static int parseInt(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 value
public Listeners getListeners()
public void setListeners(Listeners listeners)
listeners
- a Listeners object containing all EventListener
objects for the applicationpublic FilterConfig wrapFilterConfig(FilterConfig cfg)
cfg
- the container's FilterConfig object
public FilterConfig unwrapFilterConfig(FilterConfig cfg)
public void filter(Filter filter, ServletRequest req, ServletResponse resp, FilterChain chain) throws 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
Servlet
ServletException
IOException
public ServletConfig wrapServletConfig(ServletConfig cfg)
cfg
- the container's servlet config object
public ServletConfig unwrapServletConfig(ServletConfig cfg)
public ServletRequest getServletRequest(ServletRequest req)
req
- a ServletRequest object
public ServletRequest getServletRequestWrapper(ServletRequest req)
req
- a ServletRequest object
public boolean isServletRequestWrapped(ServletRequest req)
req
- a ServletRequest object
public boolean isServletRequestDispatched(ServletRequest req)
req
- a ServletRequest object
public boolean isServletRequestForwarded(ServletRequest req)
req
- a ServletRequest object
public boolean isServletRequestIncluded(ServletRequest req)
req
- a ServletRequest object
public ServletRequest wrapServletRequest(ServletRequest req)
req
- a ServletRequest object that might need wrapping or might
have already been wrapped
public ServletRequest wrapServletRequest(ServletRequest req, boolean fExternal)
req
- a ServletRequest object that might need wrapping or might
have already been wrappedfExternal
- if true, the ServletRequest will be treated as an
"external" request, that is, one originating from a web
application with a different ServletContext.
public ServletRequest unwrapServletRequest(ServletRequest req)
req
- a ServletRequest object
public String decodeCookie(HttpServletRequest req)
req
- an HttpServletRequest object that may have a session cookie
attached to it
public void encodeCookie(HttpServletRequest req, HttpServletResponse resp, String sId, boolean fNew)
req
- the HttpServletRequest object for the current requestresp
- 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(Cookie cookie)
cookie
- the cookie to test
public RequestContext getRequestContext(ServletRequest req)
req
- a container, Coherence or application ServletRequest object
public RequestContext ensureRequestContext(ServletRequest req, 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 wrapped
public RequestContext ensureRequestContext(ServletRequest req, ServletResponse res, boolean fExternal)
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 wrappedfExternal
- if true, the ServletRequest will be treated as an
"external" request, that is, one originating from a web
application with a different ServletContext
public void service(Servlet servlet, ServletRequest req, ServletResponse resp) throws 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 wrapped
ServletException
IOException
public RequestContext preService(ServletRequest req, ServletResponse res) throws ServletException, IOException
req
- the servlet response object (could already be wrapped)res
- the servlet response object (could already be wrapped)
ServletException
IOException
public void postService(RequestContext ctx) throws ServletException, IOException
ctx
- the request context returned by
preService()
ServletException
IOException
public RequestDispatcher wrapRequestDispatcher(RequestDispatcher disp)
disp
- the request dispatcher object from the container
public boolean isRequestUnwrapRequired()
public boolean isResponseUnwrapRequired()
public Map preDispatch(ServletRequest req, ServletResponse res)
KEY_REQUEST_RESOLVED
and KEY_RESPONSE_RESOLVED
keys.
After the request has been dispatched
postDispatch
must be called
with the Map returned from this method.
This method prepares the Servlet request by calling
saveRequestState
on the
request context. If the dispatch request was made from an "external" web
application (a web application with a different ServetContext), it is
possible that the class of the request context object was loaded by a
different ClassLoader than that of the request context class referenced
here. In this case, reflection is used to invoke
saveRequestState
and a
new request context is created for the request.
req
- a ServletRequest object that contains the client's requestres
- a ServletResponse object that contains the servlet's response
public void postDispatch(ServletRequest req, Map map)
restoreRequestState
on the request context. If the dispatch request was
made from an "external" web application (a web application with a
different ServetContext), it is possible that the class of the
request context object was loaded by a different ClassLoader than that
of the request context class referenced here. In this case, reflection is
used to invoke
restoreRequestState
.
req
- the dispatched Servlet requestmap
- the Map returned from a call to
preDispatch
public ServletRequest resolveRequest(ServletRequest req)
req
- the ServletRequest object that the application passed to
the request dispatcher wrapper
public ServletResponse resolveResponse(ServletRequest req, ServletResponse res)
req
- the ServletRequest object that the application passed to
the request dispatcher wrapperres
- the ServletResponse object that the application passed to
the request dispatcher wrapper
protected HttpSessionCollection instantiateHttpSessionCollection()
public HttpSessionCollection getHttpSessionCollection()
protected Map getHttpSessionMap()
public HttpSession createHttpSession()
public HttpSession getHttpSession(String sId)
sId
- the session ID
public boolean isSessionContextEnabled()
public HttpSessionContext getHttpSessionContext()
public boolean isSessionIdCookieEnabled()
public String getSessionIdCookieName()
public String getSessionIdCookieDomain()
public String getSessionIdCookiePath()
public int getSessionIdCookieMaxAge()
public boolean isSessionIdEncodingEnabled()
public String getSessionIdEncodingName()
public boolean isUseDefaultSessionIdDecoding()
public boolean isUseDefaultSessionIdEncoding()
public String decodeUrl(HttpServletRequest request)
request
- the current HttpServletRequest
public String encodeUrl(String sUrl, HttpServletRequest request)
sUrl
- the URL to be encodedrequest
- the current HttpServletRequest
protected String encodeUrl(String sUrl, String sId)
sUrl
- the URL to be encodedsId
- the session ID to encode in the URL
public 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 void checkForDeadSessions()
protected void checkExpiredSessionId(String sId)
sId
- a session idpublic 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 object
public static String formatCacheName(NamedCache cache)
cache
- a NamedCache object
public static String formatMapKeys(Map map)
map
- a Map object
public 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
|
CoherenceTM v3.3 Copyright© 2000-2007 by Oracle Corporation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |