public interface Session
HttpSession
that is used to maintain state information
between requests for a particular user of a web application.Modifier and Type | Field and Description |
---|---|
static String |
SESSION_ACTIVATED_EVENT
The SessionEvent event type when a session is activated.
|
static String |
SESSION_CREATED_EVENT
The SessionEvent event type when a session is created.
|
static String |
SESSION_DESTROYED_EVENT
The SessionEvent event type when a session is destroyed.
|
static String |
SESSION_ID_CHANGED_EVENT
The SessionEvent event type when a session is created.
|
static String |
SESSION_PASSIVATED_EVENT
The SessionEvent event type when a session is passivated.
|
Modifier and Type | Method and Description |
---|---|
void |
access()
Update the accessed time information for this session.
|
void |
addSessionListener(SessionListener listener)
Add a session event listener to this component.
|
void |
endAccess()
End access to the session.
|
void |
expire()
Perform the internal processing required to invalidate this session,
without triggering an exception if the session has already expired.
|
String |
getAuthType()
Return the authentication type used to authenticate our cached
Principal, if any.
|
long |
getCreationTime()
Return the creation time for this session.
|
String |
getId()
Return the session identifier for this session.
|
String |
getIdInternal()
Return the session identifier for this session.
|
String |
getInfo()
Return descriptive information about this Session implementation and
the corresponding version number, in the format
<description>/<version> . |
long |
getLastAccessedTime()
Return the last time the client sent a request associated with this
session, as the number of milliseconds since midnight, January 1, 1970
GMT.
|
long |
getLastAccessedTimeInternal()
Return the last client access time without invalidation check
|
Manager |
getManager()
Return the Manager within which this Session is valid.
|
int |
getMaxInactiveInterval()
Return the maximum time interval, in seconds, between client requests
before the servlet container will invalidate the session.
|
Object |
getNote(String name)
Return the object bound with the specified name to the internal notes
for this session, or
null if no such binding exists. |
Iterator |
getNoteNames()
Return an Iterator containing the String names of all notes bindings
that exist for this session.
|
Principal |
getPrincipal()
Return the authenticated Principal that is associated with this Session.
|
javax.servlet.http.HttpSession |
getSession()
Return the
HttpSession for which this object
is the facade. |
boolean |
isValid()
Return the
isValid flag for this session. |
boolean |
isValidInternal()
Return the
isValid flag for this session without doing any
validity check. |
void |
recycle()
Release all object references, and initialize instance variables, in
preparation for reuse of this object.
|
void |
removeNote(String name)
Remove any object bound to the specified name in the internal notes
for this session.
|
void |
removeSessionListener(SessionListener listener)
Remove a session event listener from this component.
|
void |
setAuthType(String authType)
Set the authentication type used to authenticate our cached
Principal, if any.
|
void |
setCreationTime(long time)
Set the creation time for this session.
|
void |
setId(String id)
Set the session identifier for this session.
|
void |
setManager(Manager manager)
Set the Manager within which this Session is valid.
|
void |
setMaxInactiveInterval(int interval)
Set the maximum time interval, in seconds, between client requests
before the servlet container will invalidate the session.
|
void |
setNew(boolean isNew)
Set the
isNew flag for this session. |
void |
setNote(String name,
Object value)
Bind an object to a specified name in the internal notes associated
with this session, replacing any existing binding for this name.
|
void |
setPrincipal(Principal principal)
Set the authenticated Principal that is associated with this Session.
|
void |
setValid(boolean isValid)
Set the
isValid flag for this session. |
static final String SESSION_CREATED_EVENT
static final String SESSION_DESTROYED_EVENT
static final String SESSION_ACTIVATED_EVENT
static final String SESSION_PASSIVATED_EVENT
static final String SESSION_ID_CHANGED_EVENT
String getAuthType()
void setAuthType(String authType)
authType
- The new cached authentication typelong getCreationTime()
void setCreationTime(long time)
time
- The new creation timeString getId()
String getIdInternal()
void setId(String id)
id
- The new session identifierString getInfo()
<description>/<version>
.long getLastAccessedTime()
long getLastAccessedTimeInternal()
getLastAccessedTime().
Manager getManager()
void setManager(Manager manager)
manager
- The new Managerint getMaxInactiveInterval()
void setMaxInactiveInterval(int interval)
interval
- The new maximum intervalvoid setNew(boolean isNew)
isNew
flag for this session.isNew
- The new value for the isNew
flagPrincipal getPrincipal()
Authenticator
with a means to cache a
previously authenticated Principal, and avoid potentially expensive
Realm.authenticate()
calls on every request. If there
is no current associated Principal, return null
.void setPrincipal(Principal principal)
Authenticator
with a means to cache a
previously authenticated Principal, and avoid potentially expensive
Realm.authenticate()
calls on every request.principal
- The new Principal, or null
if nonejavax.servlet.http.HttpSession getSession()
HttpSession
for which this object
is the facade.void setValid(boolean isValid)
isValid
flag for this session.isValid
- The new value for the isValid
flagboolean isValid()
isValid
flag for this session.boolean isValidInternal()
isValid
flag for this session without doing any
validity check.void access()
void addSessionListener(SessionListener listener)
void endAccess()
void expire()
Object getNote(String name)
null
if no such binding exists.name
- Name of the note to be returnedIterator getNoteNames()
void recycle()
void removeNote(String name)
name
- Name of the note to be removedvoid removeSessionListener(SessionListener listener)
Copyright © 2013 JBoss by Red Hat. All rights reserved.