Class DummyProxySession
java.lang.Object
org.apache.catalina.manager.DummyProxySession
- All Implemented Interfaces:
Session
-
Field Summary
Fields inherited from interface org.apache.catalina.Session
SESSION_ACTIVATED_EVENT, SESSION_CREATED_EVENT, SESSION_DESTROYED_EVENT, SESSION_PASSIVATED_EVENT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaccess()Update the accessed time information for this session.voidaddSessionListener(SessionListener listener) Add a session event listener to this component.voidEnd access to the session.voidexpire()Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.longlonggetId()longlonglonglongintlonglongbooleanisAttributeDistributable(String name, Object value) Does the session implementation support the distributing of the given attribute?booleanisValid()voidrecycle()Release all object references, and initialize instance variables, in preparation for reuse of this object.voidremoveNote(String name) Remove any object bound to the specified name in the internal notes for this session.voidremoveSessionListener(SessionListener listener) Remove a session event listener from this component.voidsetAuthType(String authType) Set the authentication type used to authenticate our cached Principal, if any.voidsetCreationTime(long time) Set the creation time for this session.voidSet the session identifier for this session and notifies any associated listeners that a new session has been created.voidSet the session identifier for this session and optionally notifies any associated listeners that a new session has been created.voidsetManager(Manager manager) Set the Manager within which this Session is valid.voidsetMaxInactiveInterval(int interval) Set the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session.voidsetNew(boolean isNew) Set theisNewflag for this session.voidBind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.voidsetPrincipal(Principal principal) Set the authenticated Principal that is associated with this Session.voidsetValid(boolean isValid) Set theisValidflag for this session.voidtellChangedSessionId(String newId, String oldId, boolean notifySessionListeners, boolean notifyContainerListeners) Inform the listeners about the change session ID.
-
Constructor Details
-
DummyProxySession
-
-
Method Details
-
access
public void access()Description copied from interface:SessionUpdate the accessed time information for this session. This method should be called by the context when a request comes in for a particular session, even if the application does not reference it. -
addSessionListener
Description copied from interface:SessionAdd a session event listener to this component.- Specified by:
addSessionListenerin interfaceSession- Parameters:
listener- the SessionListener instance that should be notified for session events
-
endAccess
-
expire
-
getAuthType
- Specified by:
getAuthTypein interfaceSession- Returns:
- the authentication type used to authenticate our cached Principal, if any.
-
getCreationTime
public long getCreationTime()- Specified by:
getCreationTimein interfaceSession- Returns:
- the creation time for this session.
-
getCreationTimeInternal
public long getCreationTimeInternal()- Specified by:
getCreationTimeInternalin interfaceSession- Returns:
- the creation time for this session, bypassing the session validity checks.
-
getId
-
getIdInternal
- Specified by:
getIdInternalin interfaceSession- Returns:
- the session identifier for this session.
-
getLastAccessedTime
public long getLastAccessedTime()- Specified by:
getLastAccessedTimein interfaceSession- Returns:
- the last time the client sent a request associated with this session, as the number of milliseconds since midnight, January 1, 1970 GMT. Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time. This one gets updated whenever a request finishes.
-
getLastAccessedTimeInternal
public long getLastAccessedTimeInternal()- Specified by:
getLastAccessedTimeInternalin interfaceSession- Returns:
- the last client access time without invalidation check
- See Also:
-
getIdleTime
public long getIdleTime()- Specified by:
getIdleTimein interfaceSession- Returns:
- the idle time (in milliseconds) from last client access time.
-
getIdleTimeInternal
public long getIdleTimeInternal()- Specified by:
getIdleTimeInternalin interfaceSession- Returns:
- the idle time from last client access time without invalidation check
- See Also:
-
getManager
- Specified by:
getManagerin interfaceSession- Returns:
- the Manager within which this Session is valid.
-
getMaxInactiveInterval
public int getMaxInactiveInterval()- Specified by:
getMaxInactiveIntervalin interfaceSession- Returns:
- the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session. A negative time indicates that the session should never time out.
-
getNote
-
getNoteNames
- Specified by:
getNoteNamesin interfaceSession- Returns:
- an Iterator containing the String names of all notes bindings that exist for this session.
-
getPrincipal
- Specified by:
getPrincipalin interfaceSession- Returns:
- the authenticated Principal that is associated with this Session. This provides an
Authenticatorwith a means to cache a previously authenticated Principal, and avoid potentially expensiveRealm.authenticate()calls on every request. If there is no current associated Principal, returnnull.
-
getSession
- Specified by:
getSessionin interfaceSession- Returns:
- the
HttpSessionfor which this object is the facade.
-
getThisAccessedTime
public long getThisAccessedTime()- Specified by:
getThisAccessedTimein interfaceSession- Returns:
- the last time the client sent a request associated with this session, as the number of milliseconds since midnight, January 1, 1970 GMT. Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time. This one gets updated whenever a request starts.
-
getThisAccessedTimeInternal
public long getThisAccessedTimeInternal()- Specified by:
getThisAccessedTimeInternalin interfaceSession- Returns:
- the last client access time without invalidation check
- See Also:
-
isValid
-
recycle
-
removeNote
Description copied from interface:SessionRemove any object bound to the specified name in the internal notes for this session.- Specified by:
removeNotein interfaceSession- Parameters:
name- Name of the note to be removed
-
removeSessionListener
Description copied from interface:SessionRemove a session event listener from this component.- Specified by:
removeSessionListenerin interfaceSession- Parameters:
listener- remove the session listener, which will no longer be notified
-
setAuthType
Description copied from interface:SessionSet the authentication type used to authenticate our cached Principal, if any.- Specified by:
setAuthTypein interfaceSession- Parameters:
authType- The new cached authentication type
-
setCreationTime
public void setCreationTime(long time) Description copied from interface:SessionSet the creation time for this session. This method is called by the Manager when an existing Session instance is reused.- Specified by:
setCreationTimein interfaceSession- Parameters:
time- The new creation time
-
setId
-
setId
Description copied from interface:SessionSet the session identifier for this session and optionally notifies any associated listeners that a new session has been created. -
setManager
Description copied from interface:SessionSet the Manager within which this Session is valid.- Specified by:
setManagerin interfaceSession- Parameters:
manager- The new Manager
-
setMaxInactiveInterval
public void setMaxInactiveInterval(int interval) Description copied from interface:SessionSet the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session. A negative time indicates that the session should never time out.- Specified by:
setMaxInactiveIntervalin interfaceSession- Parameters:
interval- The new maximum interval
-
setNew
-
setNote
Description copied from interface:SessionBind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name. -
setPrincipal
Description copied from interface:SessionSet the authenticated Principal that is associated with this Session. This provides anAuthenticatorwith a means to cache a previously authenticated Principal, and avoid potentially expensiveRealm.authenticate()calls on every request.- Specified by:
setPrincipalin interfaceSession- Parameters:
principal- The new Principal, ornullif none
-
setValid
-
tellChangedSessionId
public void tellChangedSessionId(String newId, String oldId, boolean notifySessionListeners, boolean notifyContainerListeners) Description copied from interface:SessionInform the listeners about the change session ID.- Specified by:
tellChangedSessionIdin interfaceSession- Parameters:
newId- new session IDoldId- old session IDnotifySessionListeners- Should any associated sessionListeners be notified that session ID has been changed?notifyContainerListeners- Should any associated ContainerListeners be notified that session ID has been changed?
-
isAttributeDistributable
Description copied from interface:SessionDoes the session implementation support the distributing of the given attribute? If the Manager is marked as distributable, then this method must be used to check attributes before adding them to a session and anIllegalArgumentExceptionthrown if the proposed attribute is not distributable.Note that the
Managerimplementation may further restrict which attributes are distributed but aManagerlevel restriction should not trigger anIllegalArgumentExceptioninHttpSession.setAttribute(String, Object)- Specified by:
isAttributeDistributablein interfaceSession- Parameters:
name- The attribute namevalue- The attribute value- Returns:
trueif distribution is supported, otherwisefalse
-