Top Fields Constructors Methods
org.apache.catalina.manager

public Class DummyProxySession

extends Object
implements Session
Class Inheritance
All Implemented Interfaces
org.apache.catalina.Session
Imports
java.security.Principal, java.util.Iterator, jakarta.servlet.http.HttpSession, org.apache.catalina.Manager, .Session, .SessionListener

Field Summary

Modifier and TypeField and Description
private String
sessionId

Constructor Summary

AccessConstructor and Description
public
DummyProxySession(String sessionId)

Method Summary

Modifier and TypeMethod and Description
public void
access()

Implements org.apache.catalina.Session.access.

Update the accessed time information for this session.

public void
addSessionListener(SessionListener
the SessionListener instance that should be notified for session events
listener)

Implements org.apache.catalina.Session.addSessionListener.

Add a session event listener to this component.

public void
endAccess()

Implements org.apache.catalina.Session.endAccess.

End access to the session.

public void
expire()

Implements org.apache.catalina.Session.expire.

Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.

public String
getAuthType()

Implements org.apache.catalina.Session.getAuthType.

public long
getCreationTime()

Implements org.apache.catalina.Session.getCreationTime.

public long
getCreationTimeInternal()

Implements org.apache.catalina.Session.getCreationTimeInternal.

public String
getId()

Implements org.apache.catalina.Session.getId.

public String
getIdInternal()

Implements org.apache.catalina.Session.getIdInternal.

public long
getIdleTime()

Implements org.apache.catalina.Session.getIdleTime.

public long
getIdleTimeInternal()

Implements org.apache.catalina.Session.getIdleTimeInternal.

public long
getLastAccessedTime()

Implements org.apache.catalina.Session.getLastAccessedTime.

public long
getLastAccessedTimeInternal()

Implements org.apache.catalina.Session.getLastAccessedTimeInternal.

public Manager
getManager()

Implements org.apache.catalina.Session.getManager.

public int
getMaxInactiveInterval()

Implements org.apache.catalina.Session.getMaxInactiveInterval.

public Object
getNote(String
Name of the note to be returned
name)

Implements org.apache.catalina.Session.getNote.

public Iterator<String>
getNoteNames()

Implements org.apache.catalina.Session.getNoteNames.

public Principal
getPrincipal()

Implements org.apache.catalina.Session.getPrincipal.

public HttpSession
getSession()

Implements org.apache.catalina.Session.getSession.

public long
getThisAccessedTime()

Implements org.apache.catalina.Session.getThisAccessedTime.

public long
getThisAccessedTimeInternal()

Implements org.apache.catalina.Session.getThisAccessedTimeInternal.

public boolean
isAttributeDistributable(String
The attribute name
name, Object
The attribute value
value)

Implements org.apache.catalina.Session.isAttributeDistributable.

Does the session implementation support the distributing of the given attribute?

public boolean
isValid()

Implements org.apache.catalina.Session.isValid.

public void
recycle()

Implements org.apache.catalina.Session.recycle.

Release all object references, and initialize instance variables, in preparation for reuse of this object.

public void
removeNote(String
Name of the note to be removed
name)

Implements org.apache.catalina.Session.removeNote.

Remove any object bound to the specified name in the internal notes for this session.

public void
removeSessionListener(SessionListener
remove the session listener, which will no longer be notified
listener)

Implements org.apache.catalina.Session.removeSessionListener.

Remove a session event listener from this component.

public void
setAuthType(String
The new cached authentication type
authType)

Implements org.apache.catalina.Session.setAuthType.

Set the authentication type used to authenticate our cached Principal, if any.

public void
setCreationTime(long
The new creation time
time)

Implements org.apache.catalina.Session.setCreationTime.

Set the creation time for this session.

public void
setId(String
The new session identifier
id)

Implements org.apache.catalina.Session.setId.

Set the session identifier for this session and notifies any associated listeners that a new session has been created.

public void
setId(String
The new session identifier
id, boolean
Should any associated listeners be notified that a new session has been created?
notify)

Implements org.apache.catalina.Session.setId.

Set the session identifier for this session and optionally notifies any associated listeners that a new session has been created.

public void
setManager(Manager
The new Manager
manager)

Implements org.apache.catalina.Session.setManager.

Set the Manager within which this Session is valid.

public void
setMaxInactiveInterval(int
The new maximum interval
interval)

Implements org.apache.catalina.Session.setMaxInactiveInterval.

Set the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session.

public void
setNew(boolean
The new value for the isNew flag
isNew)

Implements org.apache.catalina.Session.setNew.

Set the isNew flag for this session.

public void
setNote(String
Name to which the object should be bound
name, Object
Object to be bound to the specified name
value)

Implements org.apache.catalina.Session.setNote.

Bind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.

public void
setPrincipal(Principal
The new Principal, or null if none
principal)

Implements org.apache.catalina.Session.setPrincipal.

Set the authenticated Principal that is associated with this Session.

public void
setValid(boolean
The new value for the isValid flag
isValid)

Implements org.apache.catalina.Session.setValid.

Set the isValid flag for this session.

public void
tellChangedSessionId(String
new session ID
newId, String
old session ID
oldId, boolean
Should any associated sessionListeners be notified that session ID has been changed?
notifySessionListeners, boolean
Should any associated ContainerListeners be notified that session ID has been changed?
notifyContainerListeners)

Implements org.apache.catalina.Session.tellChangedSessionId.

Inform the listeners about the change session ID.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

sessionIdback to summary
private String sessionId

Constructor Detail

DummyProxySessionback to summary
public DummyProxySession(String sessionId)

Method Detail

accessback to summary
public void access()

Implements org.apache.catalina.Session.access.

Doc from org.apache.catalina.Session.access.

Update 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.

Annotations
@Override
addSessionListenerback to summary
public void addSessionListener(SessionListener listener)

Implements org.apache.catalina.Session.addSessionListener.

Doc from org.apache.catalina.Session.addSessionListener.

Add a session event listener to this component.

Parameters
listener:SessionListener

the SessionListener instance that should be notified for session events

Annotations
@Override
endAccessback to summary
public void endAccess()

Implements org.apache.catalina.Session.endAccess.

Doc from org.apache.catalina.Session.endAccess.

End access to the session.

Annotations
@Override
expireback to summary
public void expire()

Implements org.apache.catalina.Session.expire.

Doc from org.apache.catalina.Session.expire.

Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.

Annotations
@Override
getAuthTypeback to summary
public String getAuthType()

Implements org.apache.catalina.Session.getAuthType.

Returns:String

Doc from org.apache.catalina.Session.getAuthType.

the authentication type used to authenticate our cached Principal, if any.

Annotations
@Override
getCreationTimeback to summary
public long getCreationTime()

Implements org.apache.catalina.Session.getCreationTime.

Returns:long

Doc from org.apache.catalina.Session.getCreationTime.

the creation time for this session.

Annotations
@Override
getCreationTimeInternalback to summary
public long getCreationTimeInternal()

Implements org.apache.catalina.Session.getCreationTimeInternal.

Returns:long

Doc from org.apache.catalina.Session.getCreationTimeInternal.

the creation time for this session, bypassing the session validity checks.

Annotations
@Override
getIdback to summary
public String getId()

Implements org.apache.catalina.Session.getId.

Returns:String

Doc from org.apache.catalina.Session.getId.

the session identifier for this session.

Annotations
@Override
getIdInternalback to summary
public String getIdInternal()

Implements org.apache.catalina.Session.getIdInternal.

Returns:String

Doc from org.apache.catalina.Session.getIdInternal.

the session identifier for this session.

Annotations
@Override
getIdleTimeback to summary
public long getIdleTime()

Implements org.apache.catalina.Session.getIdleTime.

Returns:long

Doc from org.apache.catalina.Session.getIdleTime.

the idle time (in milliseconds) from last client access time.

Annotations
@Override
getIdleTimeInternalback to summary
public long getIdleTimeInternal()

Implements org.apache.catalina.Session.getIdleTimeInternal.

Returns:long

Doc from org.apache.catalina.Session.getIdleTimeInternal.

the idle time from last client access time without invalidation check

Annotations
@Override
getLastAccessedTimeback to summary
public long getLastAccessedTime()

Implements org.apache.catalina.Session.getLastAccessedTime.

Returns:long

Doc from org.apache.catalina.Session.getLastAccessedTime.

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.

Annotations
@Override
getLastAccessedTimeInternalback to summary
public long getLastAccessedTimeInternal()

Implements org.apache.catalina.Session.getLastAccessedTimeInternal.

Returns:long

Doc from org.apache.catalina.Session.getLastAccessedTimeInternal.

the last client access time without invalidation check

Annotations
@Override
getManagerback to summary
public Manager getManager()

Implements org.apache.catalina.Session.getManager.

Returns:Manager

Doc from org.apache.catalina.Session.getManager.

the Manager within which this Session is valid.

Annotations
@Override
getMaxInactiveIntervalback to summary
public int getMaxInactiveInterval()

Implements org.apache.catalina.Session.getMaxInactiveInterval.

Returns:int

Doc from org.apache.catalina.Session.getMaxInactiveInterval.

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.

Annotations
@Override
getNoteback to summary
public Object getNote(String name)

Implements org.apache.catalina.Session.getNote.

Parameters
name:String

Doc from org.apache.catalina.Session.getNote.

Name of the note to be returned

Returns:Object

Doc from org.apache.catalina.Session.getNote.

the object bound with the specified name to the internal notes for this session, or null if no such binding exists.

Annotations
@Override
getNoteNamesback to summary
public Iterator<String> getNoteNames()

Implements org.apache.catalina.Session.getNoteNames.

Returns:Iterator<String>

Doc from org.apache.catalina.Session.getNoteNames.

an Iterator containing the String names of all notes bindings that exist for this session.

Annotations
@Override
getPrincipalback to summary
public Principal getPrincipal()

Implements org.apache.catalina.Session.getPrincipal.

Returns:Principal

Doc from org.apache.catalina.Session.getPrincipal.

the authenticated Principal that is associated with this Session. This provides an 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.

Annotations
@Override
getSessionback to summary
public HttpSession getSession()

Implements org.apache.catalina.Session.getSession.

Returns:HttpSession

Doc from org.apache.catalina.Session.getSession.

the HttpSession for which this object is the facade.

Annotations
@Override
getThisAccessedTimeback to summary
public long getThisAccessedTime()

Implements org.apache.catalina.Session.getThisAccessedTime.

Returns:long

Doc from org.apache.catalina.Session.getThisAccessedTime.

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.

Annotations
@Override
getThisAccessedTimeInternalback to summary
public long getThisAccessedTimeInternal()

Implements org.apache.catalina.Session.getThisAccessedTimeInternal.

Returns:long

Doc from org.apache.catalina.Session.getThisAccessedTimeInternal.

the last client access time without invalidation check

Annotations
@Override
isAttributeDistributableback to summary
public boolean isAttributeDistributable(String name, Object value)

Implements org.apache.catalina.Session.isAttributeDistributable.

Doc from org.apache.catalina.Session.isAttributeDistributable.

Does 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 an IllegalArgumentException thrown if the proposed attribute is not distributable.

Note that the Manager implementation may further restrict which attributes are distributed but a Manager level restriction should not trigger an IllegalArgumentException in HttpSession#setAttribute(String, Object)

Parameters
name:String

The attribute name

value:Object

The attribute value

Returns:boolean

true if distribution is supported, otherwise false

Annotations
@Override
isValidback to summary
public boolean isValid()

Implements org.apache.catalina.Session.isValid.

Returns:boolean

Doc from org.apache.catalina.Session.isValid.

true if the session is still valid

Annotations
@Override
recycleback to summary
public void recycle()

Implements org.apache.catalina.Session.recycle.

Doc from org.apache.catalina.Session.recycle.

Release all object references, and initialize instance variables, in preparation for reuse of this object.

Annotations
@Override
removeNoteback to summary
public void removeNote(String name)

Implements org.apache.catalina.Session.removeNote.

Doc from org.apache.catalina.Session.removeNote.

Remove any object bound to the specified name in the internal notes for this session.

Parameters
name:String

Name of the note to be removed

Annotations
@Override
removeSessionListenerback to summary
public void removeSessionListener(SessionListener listener)

Implements org.apache.catalina.Session.removeSessionListener.

Doc from org.apache.catalina.Session.removeSessionListener.

Remove a session event listener from this component.

Parameters
listener:SessionListener

remove the session listener, which will no longer be notified

Annotations
@Override
setAuthTypeback to summary
public void setAuthType(String authType)

Implements org.apache.catalina.Session.setAuthType.

Doc from org.apache.catalina.Session.setAuthType.

Set the authentication type used to authenticate our cached Principal, if any.

Parameters
authType:String

The new cached authentication type

Annotations
@Override
setCreationTimeback to summary
public void setCreationTime(long time)

Implements org.apache.catalina.Session.setCreationTime.

Doc from org.apache.catalina.Session.setCreationTime.

Set the creation time for this session. This method is called by the Manager when an existing Session instance is reused.

Parameters
time:long

The new creation time

Annotations
@Override
setIdback to summary
public void setId(String id)

Implements org.apache.catalina.Session.setId.

Doc from org.apache.catalina.Session.setId.

Set the session identifier for this session and notifies any associated listeners that a new session has been created.

Parameters
id:String

The new session identifier

Annotations
@Override
setIdback to summary
public void setId(String id, boolean notify)

Implements org.apache.catalina.Session.setId.

Doc from org.apache.catalina.Session.setId.

Set the session identifier for this session and optionally notifies any associated listeners that a new session has been created.

Parameters
id:String

The new session identifier

notify:boolean

Should any associated listeners be notified that a new session has been created?

Annotations
@Override
setManagerback to summary
public void setManager(Manager manager)

Implements org.apache.catalina.Session.setManager.

Doc from org.apache.catalina.Session.setManager.

Set the Manager within which this Session is valid.

Parameters
manager:Manager

The new Manager

Annotations
@Override
setMaxInactiveIntervalback to summary
public void setMaxInactiveInterval(int interval)

Implements org.apache.catalina.Session.setMaxInactiveInterval.

Doc from org.apache.catalina.Session.setMaxInactiveInterval.

Set 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.

Parameters
interval:int

The new maximum interval

Annotations
@Override
setNewback to summary
public void setNew(boolean isNew)

Implements org.apache.catalina.Session.setNew.

Doc from org.apache.catalina.Session.setNew.

Set the isNew flag for this session.

Parameters
isNew:boolean

The new value for the isNew flag

Annotations
@Override
setNoteback to summary
public void setNote(String name, Object value)

Implements org.apache.catalina.Session.setNote.

Doc from org.apache.catalina.Session.setNote.

Bind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.

Parameters
name:String

Name to which the object should be bound

value:Object

Object to be bound to the specified name

Annotations
@Override
setPrincipalback to summary
public void setPrincipal(Principal principal)

Implements org.apache.catalina.Session.setPrincipal.

Doc from org.apache.catalina.Session.setPrincipal.

Set the authenticated Principal that is associated with this Session. This provides an Authenticator with a means to cache a previously authenticated Principal, and avoid potentially expensive Realm.authenticate() calls on every request.

Parameters
principal:Principal

The new Principal, or null if none

Annotations
@Override
setValidback to summary
public void setValid(boolean isValid)

Implements org.apache.catalina.Session.setValid.

Doc from org.apache.catalina.Session.setValid.

Set the isValid flag for this session.

Parameters
isValid:boolean

The new value for the isValid flag

Annotations
@Override
tellChangedSessionIdback to summary
public void tellChangedSessionId(String newId, String oldId, boolean notifySessionListeners, boolean notifyContainerListeners)

Implements org.apache.catalina.Session.tellChangedSessionId.

Doc from org.apache.catalina.Session.tellChangedSessionId.

Inform the listeners about the change session ID.

Parameters
newId:String

new session ID

oldId:String

old session ID

notifySessionListeners:boolean

Should any associated sessionListeners be notified that session ID has been changed?

notifyContainerListeners:boolean

Should any associated ContainerListeners be notified that session ID has been changed?

Annotations
@Override