Apache Tomcat 7.0.42

## org.apache.catalina.manager
Class DummyProxySession

    java.lang.Object
      org.apache.catalina.manager.DummyProxySession

All Implemented Interfaces:
  Session

    public class DummyProxySession

extends Object
implements 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
`DummyProxySession(String sessionId)`

Method Summary
`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.
`long` `getCreationTimeInternal()` Return the creation time for this session, bypassing the session validity checks.
`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<String>` `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.
`HttpSession` `getSession()` Return the `HttpSession` for which this object is the facade.
`long` `getThisAccessedTime()` 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` `getThisAccessedTimeInternal()` Return the last client access time without invalidation check
`boolean` `isValid()` Return the `isValid` flag for this session.
`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 and notifies any associated listeners that a new session has been created.
`void` `setId(String id, boolean notify)` Set the session identifier for this session and optionally notifies any associated listeners that a new session has been created.
`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.

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

Constructor Detail

### DummyProxySession

    public DummyProxySession(String sessionId)

Method Detail

### access

    public void access()

  Description copied from interface: `Session`
  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.

  Specified by:
    `access` in interface `Session`

### addSessionListener

    public void addSessionListener(SessionListener listener)

  Description copied from interface: `Session`
  Add a session event listener to this component.

  Specified by:
    `addSessionListener` in interface `Session`

### endAccess

    public void endAccess()

  Description copied from interface: `Session`
  End access to the session.

  Specified by:
    `endAccess` in interface `Session`

### expire

    public void expire()

  Description copied from interface: `Session`
  Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.

  Specified by:
    `expire` in interface `Session`

### getAuthType

    public String getAuthType()

  Description copied from interface: `Session`
  Return the authentication type used to authenticate our cached Principal, if any.

  Specified by:
    `getAuthType` in interface `Session`

### getCreationTime

    public long getCreationTime()

  Description copied from interface: `Session`
  Return the creation time for this session.

  Specified by:
    `getCreationTime` in interface `Session`

### getCreationTimeInternal

    public long getCreationTimeInternal()

  Description copied from interface: `Session`
  Return the creation time for this session, bypassing the session validity checks.

  Specified by:
    `getCreationTimeInternal` in interface `Session`

### getId

    public String getId()

  Description copied from interface: `Session`
  Return the session identifier for this session.

  Specified by:
    `getId` in interface `Session`

### getIdInternal

    public String getIdInternal()

  Description copied from interface: `Session`
  Return the session identifier for this session.

  Specified by:
    `getIdInternal` in interface `Session`

### getInfo

    public String getInfo()

  Description copied from interface: `Session`
  Return descriptive information about this Session implementation and the corresponding version number, in the format `<description>/<version>`.

  Specified by:
    `getInfo` in interface `Session`

### getLastAccessedTime

    public long getLastAccessedTime()

  Description copied from interface: `Session`
  Return 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.

  Specified by:
    `getLastAccessedTime` in interface `Session`

### getLastAccessedTimeInternal

    public long getLastAccessedTimeInternal()

  Description copied from interface: `Session`
  Return the last client access time without invalidation check

  Specified by:
    `getLastAccessedTimeInternal` in interface `Session`
  See Also:
    `Session.getLastAccessedTime()`

### getManager

    public Manager getManager()

  Description copied from interface: `Session`
  Return the Manager within which this Session is valid.

  Specified by:
    `getManager` in interface `Session`

### getMaxInactiveInterval

    public int getMaxInactiveInterval()

  Description copied from interface: `Session`
  Return 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:
    `getMaxInactiveInterval` in interface `Session`

### getNote

    public Object getNote(String name)

  Description copied from interface: `Session`
  Return the object bound with the specified name to the internal notes for this session, or `null` if no such binding exists.

  Specified by:
    `getNote` in interface `Session`
  Parameters:
    `name` - Name of the note to be returned

### getNoteNames

    public Iterator<String> getNoteNames()

  Description copied from interface: `Session`
  Return an Iterator containing the String names of all notes bindings that exist for this session.

  Specified by:
    `getNoteNames` in interface `Session`

### getPrincipal

    public Principal getPrincipal()

  Description copied from interface: `Session`
  Return 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`.

  Specified by:
    `getPrincipal` in interface `Session`

### getSession

    public HttpSession getSession()

  Description copied from interface: `Session`
  Return the `HttpSession` for which this object is the facade.

  Specified by:
    `getSession` in interface `Session`

### getThisAccessedTime

    public long getThisAccessedTime()

  Description copied from interface: `Session`
  Return 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.

  Specified by:
    `getThisAccessedTime` in interface `Session`

### getThisAccessedTimeInternal

    public long getThisAccessedTimeInternal()

  Description copied from interface: `Session`
  Return the last client access time without invalidation check

  Specified by:
    `getThisAccessedTimeInternal` in interface `Session`
  See Also:
    `Session.getThisAccessedTime()`

### isValid

    public boolean isValid()

  Description copied from interface: `Session`
  Return the `isValid` flag for this session.

  Specified by:
    `isValid` in interface `Session`

### recycle

    public void recycle()

  Description copied from interface: `Session`
  Release all object references, and initialize instance variables, in preparation for reuse of this object.

  Specified by:
    `recycle` in interface `Session`

### removeNote

    public void removeNote(String name)

  Description copied from interface: `Session`
  Remove any object bound to the specified name in the internal notes for this session.

  Specified by:
    `removeNote` in interface `Session`
  Parameters:
    `name` - Name of the note to be removed

### removeSessionListener

    public void removeSessionListener(SessionListener listener)

  Description copied from interface: `Session`
  Remove a session event listener from this component.

  Specified by:
    `removeSessionListener` in interface `Session`

### setAuthType

    public void setAuthType(String authType)

  Description copied from interface: `Session`
  Set the authentication type used to authenticate our cached Principal, if any.

  Specified by:
    `setAuthType` in interface `Session`
  Parameters:
    `authType` - The new cached authentication type

### setCreationTime

    public void setCreationTime(long time)

  Description copied from interface: `Session`
  Set the creation time for this session. This method is called by the Manager when an existing Session instance is reused.

  Specified by:
    `setCreationTime` in interface `Session`
  Parameters:
    `time` - The new creation time

### setId

    public void setId(String id)

  Description copied from interface: `Session`
  Set the session identifier for this session and notifies any associated listeners that a new session has been created.

  Specified by:
    `setId` in interface `Session`
  Parameters:
    `id` - The new session identifier

### setId

    public void setId(String id,
                      boolean notify)

  Description copied from interface: `Session`
  Set the session identifier for this session and optionally notifies any associated listeners that a new session has been created.

  Specified by:
    `setId` in interface `Session`
  Parameters:
    `id` - The new session identifier
    `notify` - Should any associated listeners be notified that a new session has been created?

### setManager

    public void setManager(Manager manager)

  Description copied from interface: `Session`
  Set the Manager within which this Session is valid.

  Specified by:
    `setManager` in interface `Session`
  Parameters:
    `manager` - The new Manager

### setMaxInactiveInterval

    public void setMaxInactiveInterval(int interval)

  Description copied from interface: `Session`
  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.

  Specified by:
    `setMaxInactiveInterval` in interface `Session`
  Parameters:
    `interval` - The new maximum interval

### setNew

    public void setNew(boolean isNew)

  Description copied from interface: `Session`
  Set the `isNew` flag for this session.

  Specified by:
    `setNew` in interface `Session`
  Parameters:
    `isNew` - The new value for the `isNew` flag

### setNote

    public void setNote(String name,
                        Object value)

  Description copied from interface: `Session`
  Bind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.

  Specified by:
    `setNote` in interface `Session`
  Parameters:
    `name` - Name to which the object should be bound
    `value` - Object to be bound to the specified name

### setPrincipal

    public void setPrincipal(Principal principal)

  Description copied from interface: `Session`
  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.

  Specified by:
    `setPrincipal` in interface `Session`
  Parameters:
    `principal` - The new Principal, or `null` if none

### setValid

    public void setValid(boolean isValid)

  Description copied from interface: `Session`
  Set the `isValid` flag for this session.

  Specified by:
    `setValid` in interface `Session`
  Parameters:
    `isValid` - The new value for the `isValid` flag

Apache Tomcat 7.0.42

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.