Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.mortbay.jetty.servlet.AbstractSessionManager.Session
public abstract class AbstractSessionManager.Session
extends java.lang.Object
implements SessionManager.Session
Constructor Summary | |
|
Method Summary | |
void |
|
Object |
|
Enumeration |
|
long |
|
String |
|
long |
|
int |
|
ServletContext |
|
HttpSessionContext |
|
Object |
|
String[] |
|
void |
|
boolean |
|
boolean |
|
protected abstract Map | |
void |
|
void |
|
void |
|
void |
|
void |
|
public Object getAttribute(String name)
Returns the object bound with the specified name in this session, ornull
if no object is bound under the name.
- Specified by:
- getAttribute in interface HttpSession
- Parameters:
name
- a string specifying the name of the object
- Returns:
- the object with the specified name
public Enumeration getAttributeNames()
Returns anEnumeration
ofString
objects containing the names of all the objects bound to this session.
- Specified by:
- getAttributeNames in interface HttpSession
- Returns:
- an
Enumeration
ofString
objects specifying the names of all the objects bound to this session
public long getCreationTime() throws IllegalStateException
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
- Specified by:
- getCreationTime in interface HttpSession
- Returns:
- a
long
specifying when this session was created, expressed in milliseconds since 1/1/1970 GMT
public String getId() throws IllegalStateException
Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the servlet container and is implementation dependent.
- Specified by:
- getId in interface HttpSession
- Returns:
- a string specifying the identifier assigned to this session
public long getLastAccessedTime() throws IllegalStateException
Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request. Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.
- Specified by:
- getLastAccessedTime in interface HttpSession
- Returns:
- a
long
representing the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT
public int getMaxInactiveInterval()
Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses. After this interval, the servlet container will invalidate the session. The maximum time interval can be set with thesetMaxInactiveInterval
method. A negative time indicates the session should never timeout.
- Specified by:
- getMaxInactiveInterval in interface HttpSession
- Returns:
- an integer specifying the number of seconds this session remains open between client requests
public ServletContext getServletContext()
Returns the ServletContext to which this session belongs.
- Specified by:
- getServletContext in interface HttpSession
- Returns:
- The ServletContext object for the web application
- Since:
- Servlet 2.3
public HttpSessionContext getSessionContext() throws IllegalStateException
Deprecated.
- Specified by:
- getSessionContext in interface HttpSession
public Object getValue(String name) throws IllegalStateException
Deprecated. As of Version 2.2, this method is replaced by
getAttribute(String)
- Specified by:
- getValue in interface HttpSession
public String[] getValueNames() throws IllegalStateException
Deprecated. As of Version 2.2, this method is replaced by
getAttributeNames()
- Specified by:
- getValueNames in interface HttpSession
public void invalidate() throws IllegalStateException
Invalidates this session then unbinds any objects bound to it.
- Specified by:
- invalidate in interface HttpSession
public boolean isNew() throws IllegalStateException
Returnstrue
if the client does not yet know about the session or if the client chooses not to join the session. For example, if the server used only cookie-based sessions, and the client had disabled the use of cookies, then a session would be new on each request.
- Specified by:
- isNew in interface HttpSession
- Returns:
true
if the server has created a session, but the client has not yet joined
protected abstract Map newAttributeMap()
public void putValue(java.lang.String name, java.lang.Object value) throws IllegalStateException
Deprecated. As of Version 2.2, this method is replaced by
setAttribute(String,Object)
public void removeAttribute(String name)
Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing. After this method executes, and if the object implementsHttpSessionBindingListener
, the container callsHttpSessionBindingListener.valueUnbound
. The container then notifies anyHttpSessionAttributeListener
s in the web application.
- Specified by:
- removeAttribute in interface HttpSession
- Parameters:
name
- the name of the object to remove from this session
public void removeValue(java.lang.String name) throws IllegalStateException
Deprecated. As of Version 2.2, this method is replaced by
removeAttribute(String)
public void setAttribute(String name, Object value)
Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced. After this method executes, and if the new object implementsHttpSessionBindingListener
, the container callsHttpSessionBindingListener.valueBound
. The container then notifies anyHttpSessionAttributeListener
s in the web application. If an object was already bound to this session of this name that implementsHttpSessionBindingListener
, itsHttpSessionBindingListener.valueUnbound
method is called. If the value passed in is null, this has the same effect as callingremoveAttribute()
.
- Specified by:
- setAttribute in interface HttpSession
- Parameters:
name
- the name to which the object is bound; cannot be nullvalue
- the object to be bound
public void setMaxInactiveInterval(int secs)
Specifies the time, in seconds, between client requests before the servlet container will invalidate this session. A negative time indicates the session should never timeout.
- Specified by:
- setMaxInactiveInterval in interface HttpSession
- Parameters: