HttpSessionContext (Servlet and Websocket Guice Scopes 14.0-jakarta API)

java.lang.Object
- pl.morgwai.base.guice.scopes.InjectionContext
- - pl.morgwai.base.servlet.guice.scopes.HttpSessionContext

All Implemented Interfaces:

HttpSessionActivationListener, Serializable, EventListener
```
public class HttpSessionContext
extends InjectionContext
implements HttpSessionActivationListener
```
Context of an HttpSession.
NOTE: If the servlet container being used, uses mechanism other than the standard Java Serialization to persist/replicate HttpSessions, then a deployment init-param named CUSTOM_SERIALIZATION_PARAM must be set to "true" either in web.xml or programmatically before any request is served (for example in ServletContextListener.contextInitialized(ServletContextEvent)).

See Also:

corresponding Scope, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HttpSessionContext.SessionContextCreator
Creates HttpSessionContexts for newly created HttpSessions.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CUSTOM_SERIALIZATION_PARAM`	Name of the `deployment init-param` indicating that the servlet container uses serialization mechanism other than the `standard Java Serialization` to persist/replicate `HttpSession`s.
`static String`	`CUSTOM_SERIALIZATION_PARAM_SUFFIX`	See `CUSTOM_SERIALIZATION_PARAM`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`HttpSession`	`getSession()`
`static HttpSessionContext`	`of(HttpSession session)`	Returns the `Context` of `session`.
`void`	`sessionDidActivate(HttpSessionEvent deserialization)`	Calls `InjectionContext.restoreAfterDeserialization()` if `init-param` named `CUSTOM_SERIALIZATION_PARAM` is `true`.
`void`	`sessionWillPassivate(HttpSessionEvent serialization)`	Calls `InjectionContext.prepareForSerialization()` if `init-param` named `CUSTOM_SERIALIZATION_PARAM` is `true`.

Methods inherited from class pl.morgwai.base.guice.scopes.InjectionContext
prepareForSerialization, produceIfAbsent, removeScopedObject, restoreAfterDeserialization

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CUSTOM_SERIALIZATION_PARAM_SUFFIX
```
public static final String CUSTOM_SERIALIZATION_PARAM_SUFFIX
```
    See CUSTOM_SERIALIZATION_PARAM.
    
    See Also:
    
    Constant Field Values
  - CUSTOM_SERIALIZATION_PARAM
```
public static final String CUSTOM_SERIALIZATION_PARAM
```
    Name of the deployment init-param indicating that the servlet container uses serialization mechanism other than the standard Java Serialization to persist/replicate HttpSessions. The value is a concatenation of the fully qualified name of this class and ".customSerialization".
- Method Detail
  - getSession
```
public HttpSession getSession()
```
  - of
```
public static HttpSessionContext of(HttpSession session)
```
    Returns the Context of session.
  - sessionWillPassivate
```
public void sessionWillPassivate(HttpSessionEvent serialization)
```
    Calls InjectionContext.prepareForSerialization() if init-param named CUSTOM_SERIALIZATION_PARAM is true.
    
    Specified by:
    
    sessionWillPassivate in interface HttpSessionActivationListener
  - sessionDidActivate
```
public void sessionDidActivate(HttpSessionEvent deserialization)
```
    Calls InjectionContext.restoreAfterDeserialization() if init-param named CUSTOM_SERIALIZATION_PARAM is true.
    
    Specified by:
    
    sessionDidActivate in interface HttpSessionActivationListener