Class StandardSessionFacade
- java.lang.Object
-
- org.apache.catalina.session.StandardSessionFacade
-
- All Implemented Interfaces:
HttpSession
public class StandardSessionFacade extends Object implements HttpSession
Facade for the StandardSession object.- Author:
- Remy Maucherat
-
-
Constructor Summary
Constructors Constructor Description StandardSessionFacade(HttpSession session)Construct a new session facade.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ObjectgetAttribute(String name)Returns the object bound with the specified name in this session, ornullif no object is bound under the name.Enumeration<String>getAttributeNames()Returns anEnumerationofStringobjects containing the names of all the objects bound to this session.longgetCreationTime()Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.StringgetId()Returns a string containing the unique identifier assigned to this session.longgetLastAccessedTime()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.intgetMaxInactiveInterval()Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.ServletContextgetServletContext()Returns the ServletContext to which this session belongs.HttpSessionContextgetSessionContext()Deprecated.As of Version 2.1, this method is deprecated and has no replacement.ObjectgetValue(String name)Deprecated.As of Version 2.2, this method is replaced bygetAttribute(java.lang.String).String[]getValueNames()Deprecated.As of Version 2.2, this method is replaced bygetAttributeNames()voidinvalidate()Invalidates this session then unbinds any objects bound to it.booleanisNew()Returnstrueif the client does not yet know about the session or if the client chooses not to join the session.voidputValue(String name, Object value)Deprecated.As of Version 2.2, this method is replaced bysetAttribute(java.lang.String, java.lang.Object)voidremoveAttribute(String name)Removes the object bound with the specified name from this session.voidremoveValue(String name)Deprecated.As of Version 2.2, this method is replaced byremoveAttribute(java.lang.String)voidsetAttribute(String name, Object value)Binds an object to this session, using the name specified.voidsetMaxInactiveInterval(int interval)Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
-
-
-
Constructor Detail
-
StandardSessionFacade
public StandardSessionFacade(HttpSession session)
Construct a new session facade.- Parameters:
session- The session instance to wrap
-
-
Method Detail
-
getCreationTime
public long getCreationTime()
Description copied from interface:javax.servlet.http.HttpSessionReturns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.- Specified by:
getCreationTimein interfaceHttpSession- Returns:
- a
longspecifying when this session was created, expressed in milliseconds since 1/1/1970 GMT
-
getId
public String getId()
Description copied from interface:javax.servlet.http.HttpSessionReturns a string containing the unique identifier assigned to this session. The identifier is assigned by the servlet container and is implementation dependent.- Specified by:
getIdin interfaceHttpSession- Returns:
- a string specifying the identifier assigned to this session
-
getLastAccessedTime
public long getLastAccessedTime()
Description copied from interface:javax.servlet.http.HttpSessionReturns 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:
getLastAccessedTimein interfaceHttpSession- Returns:
- a
longrepresenting the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT
-
getServletContext
public ServletContext getServletContext()
Description copied from interface:javax.servlet.http.HttpSessionReturns the ServletContext to which this session belongs.- Specified by:
getServletContextin interfaceHttpSession- Returns:
- The ServletContext object for the web application
-
setMaxInactiveInterval
public void setMaxInactiveInterval(int interval)
Description copied from interface:javax.servlet.http.HttpSessionSpecifies the time, in seconds, between client requests before the servlet container will invalidate this session. A zero or negative time indicates that the session should never timeout.- Specified by:
setMaxInactiveIntervalin interfaceHttpSession- Parameters:
interval- An integer specifying the number of seconds
-
getMaxInactiveInterval
public int getMaxInactiveInterval()
Description copied from interface:javax.servlet.http.HttpSessionReturns 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 thesetMaxInactiveIntervalmethod. A zero or negative time indicates that the session should never timeout.- Specified by:
getMaxInactiveIntervalin interfaceHttpSession- Returns:
- an integer specifying the number of seconds this session remains open between client requests
- See Also:
HttpSession.setMaxInactiveInterval(int)
-
getSessionContext
@Deprecated public HttpSessionContext getSessionContext()
Deprecated.As of Version 2.1, this method is deprecated and has no replacement.Description copied from interface:javax.servlet.http.HttpSessionDo not use.- Specified by:
getSessionContextin interfaceHttpSession- Returns:
- A dummy implementation of HttpSessionContext
-
getAttribute
public Object getAttribute(String name)
Description copied from interface:javax.servlet.http.HttpSessionReturns the object bound with the specified name in this session, ornullif no object is bound under the name.- Specified by:
getAttributein interfaceHttpSession- Parameters:
name- a string specifying the name of the object- Returns:
- the object with the specified name
-
getValue
@Deprecated public Object getValue(String name)
Deprecated.As of Version 2.2, this method is replaced bygetAttribute(java.lang.String).- Specified by:
getValuein interfaceHttpSession- Parameters:
name- a string specifying the name of the object- Returns:
- the object with the specified name
-
getAttributeNames
public Enumeration<String> getAttributeNames()
Description copied from interface:javax.servlet.http.HttpSessionReturns anEnumerationofStringobjects containing the names of all the objects bound to this session.- Specified by:
getAttributeNamesin interfaceHttpSession- Returns:
- an
EnumerationofStringobjects specifying the names of all the objects bound to this session
-
getValueNames
@Deprecated public String[] getValueNames()
Deprecated.As of Version 2.2, this method is replaced bygetAttributeNames()- Specified by:
getValueNamesin interfaceHttpSession- Returns:
- an array of
Stringobjects specifying the names of all the objects bound to this session
-
setAttribute
public void setAttribute(String name, Object value)
Description copied from interface:javax.servlet.http.HttpSessionBinds 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 implements
HttpSessionBindingListener, the container callsHttpSessionBindingListener.valueBound. The container then notifies anyHttpSessionAttributeListeners in the web application.If an object was already bound to this session of this name that implements
HttpSessionBindingListener, itsHttpSessionBindingListener.valueUnboundmethod is called.If the value passed in is null, this has the same effect as calling
removeAttribute().- Specified by:
setAttributein interfaceHttpSession- Parameters:
name- the name to which the object is bound; cannot be nullvalue- the object to be bound
-
putValue
@Deprecated public void putValue(String name, Object value)
Deprecated.As of Version 2.2, this method is replaced bysetAttribute(java.lang.String, java.lang.Object)- Specified by:
putValuein interfaceHttpSession- Parameters:
name- the name to which the object is bound; cannot be nullvalue- the object to be bound; cannot be null
-
removeAttribute
public void removeAttribute(String name)
Description copied from interface:javax.servlet.http.HttpSessionRemoves 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 implements
HttpSessionBindingListener, the container callsHttpSessionBindingListener.valueUnbound. The container then notifies anyHttpSessionAttributeListeners in the web application.- Specified by:
removeAttributein interfaceHttpSession- Parameters:
name- the name of the object to remove from this session
-
removeValue
@Deprecated public void removeValue(String name)
Deprecated.As of Version 2.2, this method is replaced byremoveAttribute(java.lang.String)- Specified by:
removeValuein interfaceHttpSession- Parameters:
name- the name of the object to remove from this session
-
invalidate
public void invalidate()
Description copied from interface:javax.servlet.http.HttpSessionInvalidates this session then unbinds any objects bound to it.- Specified by:
invalidatein interfaceHttpSession
-
isNew
public boolean isNew()
Description copied from interface:javax.servlet.http.HttpSessionReturnstrueif 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:
isNewin interfaceHttpSession- Returns:
trueif the server has created a session, but the client has not yet joined
-
-