Interface HttpSessionContext
-
- All Superinterfaces:
jakarta.enterprise.context.spi.AlterableContext
,BoundContext<jakarta.servlet.http.HttpServletRequest>
,jakarta.enterprise.context.spi.Context
,ManagedContext
,SessionContext
,WeldAlterableContext
public interface HttpSessionContext extends BoundContext<jakarta.servlet.http.HttpServletRequest>, SessionContext
A session context which can be bound to the
HttpServletRequest
. The context is automatically attached to the map on activation, and detached wheninvalidate()
is called.This context is not thread safe, and provides no thread safety for the underlying map.
- Author:
- Pete Muir
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
destroy(jakarta.servlet.http.HttpSession session)
Destroy the session and all conversations stored in the session.void
invalidate()
Mark the Session Context for destruction; the Session Context will be detached from the underling Http Session, and instances marked for destruction when the Http Request is destroyed.boolean
isValid()
Returns false if the session has been invalidated (usinginvalidate()
).-
Methods inherited from interface org.jboss.weld.context.BoundContext
associate, dissociate
-
Methods inherited from interface jakarta.enterprise.context.spi.Context
get, get, getScope, isActive
-
Methods inherited from interface org.jboss.weld.context.ManagedContext
activate, deactivate
-
Methods inherited from interface org.jboss.weld.context.WeldAlterableContext
clearAndSet, getAllContextualInstances
-
-
-
-
Method Detail
-
invalidate
void invalidate()
Mark the Session Context for destruction; the Session Context will be detached from the underling Http Session, and instances marked for destruction when the Http Request is destroyed.
- Specified by:
invalidate
in interfaceManagedContext
-
isValid
boolean isValid()
Returns false if the session has been invalidated (using
invalidate()
). Returns true otherwise.- Returns:
- true if
invalidate()
has been called on this context
-
destroy
boolean destroy(jakarta.servlet.http.HttpSession session)
Destroy the session and all conversations stored in the session.
If the context is not currently associated with a
HttpServletRequest
, then the context will be associated with the specifiedHttpSession
(for this thread), activated, destroyed, and then deactivated.If the context is already associated with a
HttpServletRequest
then this call will detach the context from the underlying Http Session, and mark the context for destruction when the request is destroyed.- Parameters:
session
- theHttpSession
in which to store the bean instances- Returns:
- true if the context was destroyed immediately
-
-