类 MockHttpSession
- java.lang.Object
- org.springframework.mock.web.MockHttpSession
- 所有已实现的接口:
HttpSession
public class MockHttpSession extends Object implements HttpSession
Mock implementation of theHttpSession
interface.As of Spring 5.0, this set of mocks is designed on a Servlet 4.0 baseline.
- 从以下版本开始:
- 1.0.2
- 作者:
- Juergen Hoeller, Rod Johnson, Mark Fisher, Sam Brannen, Vedran Pavic
字段概要
字段 修饰符和类型 字段 说明 static String
SESSION_COOKIE_NAME
The session cookie name.
构造器概要
构造器 构造器 说明 MockHttpSession()
Create a new MockHttpSession with a defaultMockServletContext
.MockHttpSession(ServletContext servletContext)
Create a new MockHttpSession.MockHttpSession(ServletContext servletContext, String id)
Create a new MockHttpSession.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
access()
String
changeSessionId()
As of Servlet 3.1, the id of a session can be changed.void
clearAttributes()
Clear all of this session's attributes.void
deserializeState(Serializable state)
Deserialize the attributes of this session from a state object created byserializeState()
.Object
getAttribute(String name)
Returns the object bound with the specified name in this session, ornull
if no object is bound under the name.Enumeration<String>
getAttributeNames()
Returns anEnumeration
ofString
objects containing the names of all the objects bound to this session.long
getCreationTime()
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.String
getId()
Returns a string containing the unique identifier assigned to this session.long
getLastAccessedTime()
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.int
getMaxInactiveInterval()
Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.ServletContext
getServletContext()
Returns the ServletContext to which this session belongs.HttpSessionContext
getSessionContext()
Object
getValue(String name)
String[]
getValueNames()
void
invalidate()
Invalidates this session then unbinds any objects bound to it.boolean
isInvalid()
boolean
isNew()
Returnstrue
if the client does not yet know about the session or if the client chooses not to join the session.void
putValue(String name, Object value)
void
removeAttribute(String name)
Removes the object bound with the specified name from this session.void
removeValue(String name)
Serializable
serializeState()
Serialize the attributes of this session into an object that can be turned into a byte array with standard Java serialization.void
setAttribute(String name, Object value)
Binds an object to this session, using the name specified.void
setMaxInactiveInterval(int interval)
Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.void
setNew(boolean value)
字段详细资料
SESSION_COOKIE_NAME
public static final String SESSION_COOKIE_NAME
The session cookie name.- 另请参阅:
- 常量字段值
构造器详细资料
MockHttpSession
public MockHttpSession()
Create a new MockHttpSession with a defaultMockServletContext
.- 另请参阅:
MockServletContext
MockHttpSession
public MockHttpSession(@Nullable ServletContext servletContext)
Create a new MockHttpSession.- 参数:
servletContext
- the ServletContext that the session runs in
MockHttpSession
public MockHttpSession(@Nullable ServletContext servletContext, @Nullable String id)
Create a new MockHttpSession.- 参数:
servletContext
- the ServletContext that the session runs inid
- a unique identifier for this session
方法详细资料
getCreationTime
public long getCreationTime()
从接口复制的说明:javax.servlet.http.HttpSession
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.- 指定者:
getCreationTime
在接口中HttpSession
- 返回:
- a
long
specifying when this session was created, expressed in milliseconds since 1/1/1970 GMT
getId
public String getId()
从接口复制的说明:javax.servlet.http.HttpSession
Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the servlet container and is implementation dependent.- 指定者:
getId
在接口中HttpSession
- 返回:
- a string specifying the identifier assigned to this session
changeSessionId
public String changeSessionId()
As of Servlet 3.1, the id of a session can be changed.- 返回:
- the new session id
- 从以下版本开始:
- 4.0.3
access
public void access()
getLastAccessedTime
public long getLastAccessedTime()
从接口复制的说明:javax.servlet.http.HttpSession
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.
- 指定者:
getLastAccessedTime
在接口中HttpSession
- 返回:
- a
long
representing the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT
getServletContext
public ServletContext getServletContext()
从接口复制的说明:javax.servlet.http.HttpSession
Returns the ServletContext to which this session belongs.- 指定者:
getServletContext
在接口中HttpSession
- 返回:
- The ServletContext object for the web application
setMaxInactiveInterval
public void setMaxInactiveInterval(int interval)
从接口复制的说明:javax.servlet.http.HttpSession
Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.An interval value of zero or less indicates that the session should never timeout.
- 指定者:
setMaxInactiveInterval
在接口中HttpSession
- 参数:
interval
- An integer specifying the number of seconds
getMaxInactiveInterval
public int getMaxInactiveInterval()
从接口复制的说明:javax.servlet.http.HttpSession
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 return value of zero or less indicates that the session will never timeout.
- 指定者:
getMaxInactiveInterval
在接口中HttpSession
- 返回:
- an integer specifying the number of seconds this session remains open between client requests
- 另请参阅:
HttpSession.setMaxInactiveInterval(int)
getSessionContext
public HttpSessionContext getSessionContext()
- 指定者:
getSessionContext
在接口中HttpSession
- 返回:
- the
HttpSessionContext
for this session.
getAttribute
public Object getAttribute(String name)
从接口复制的说明:javax.servlet.http.HttpSession
Returns the object bound with the specified name in this session, ornull
if no object is bound under the name.- 指定者:
getAttribute
在接口中HttpSession
- 参数:
name
- a string specifying the name of the object- 返回:
- the object with the specified name
getValue
public Object getValue(String name)
- 指定者:
getValue
在接口中HttpSession
- 参数:
name
- a string specifying the name of the object- 返回:
- the object with the specified name
getAttributeNames
public Enumeration<String> getAttributeNames()
从接口复制的说明:javax.servlet.http.HttpSession
Returns anEnumeration
ofString
objects containing the names of all the objects bound to this session.- 指定者:
getAttributeNames
在接口中HttpSession
- 返回:
- an
Enumeration
ofString
objects specifying the names of all the objects bound to this session
getValueNames
public String[] getValueNames()
- 指定者:
getValueNames
在接口中HttpSession
- 返回:
- an array of
String
objects specifying the names of all the objects bound to this session
setAttribute
public void setAttribute(String name, @Nullable Object value)
从接口复制的说明:javax.servlet.http.HttpSession
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 implements
HttpSessionBindingListener
, 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 implements
HttpSessionBindingListener
, itsHttpSessionBindingListener.valueUnbound
method is called.If the value passed in is null, this has the same effect as calling
removeAttribute()
.- 指定者:
setAttribute
在接口中HttpSession
- 参数:
name
- the name to which the object is bound; cannot be nullvalue
- the object to be bound
putValue
public void putValue(String name, Object value)
- 指定者:
putValue
在接口中HttpSession
- 参数:
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)
从接口复制的说明:javax.servlet.http.HttpSession
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 implements
HttpSessionBindingListener
, the container callsHttpSessionBindingListener.valueUnbound
. The container then notifies anyHttpSessionAttributeListener
s in the web application.- 指定者:
removeAttribute
在接口中HttpSession
- 参数:
name
- the name of the object to remove from this session
removeValue
public void removeValue(String name)
- 指定者:
removeValue
在接口中HttpSession
- 参数:
name
- the name of the object to remove from this session
clearAttributes
public void clearAttributes()
Clear all of this session's attributes.
invalidate
public void invalidate()
Invalidates this session then unbinds any objects bound to it.- 指定者:
invalidate
在接口中HttpSession
- 抛出:
IllegalStateException
- if this method is called on an already invalidated session
isInvalid
public boolean isInvalid()
setNew
public void setNew(boolean value)
isNew
public boolean isNew()
从接口复制的说明:javax.servlet.http.HttpSession
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.- 指定者:
isNew
在接口中HttpSession
- 返回:
true
if the server has created a session, but the client has not yet joined
serializeState
public Serializable serializeState()
Serialize the attributes of this session into an object that can be turned into a byte array with standard Java serialization.- 返回:
- a representation of this session's serialized state
deserializeState
public void deserializeState(Serializable state)
Deserialize the attributes of this session from a state object created byserializeState()
.- 参数:
state
- a representation of this session's serialized state