Package org.springframework.mock.web
Class MockHttpSession
- java.lang.Object
- org.springframework.mock.web.MockHttpSession
- All Implemented Interfaces:
HttpSession
public class MockHttpSession extends Object implements HttpSession
Mock implementation of theHttpSession
interface.As of Spring 4.0, this set of mocks is designed on a Servlet 3.0 baseline.
Used for testing the web framework; also useful for testing application controllers.
- Since:
- 1.0.2
- Author:
- Juergen Hoeller, Rod Johnson, Mark Fisher, Sam Brannen
Field Summary
Fields Modifier and Type Field Description static String
SESSION_COOKIE_NAME
Constructor Summary
Constructors Constructor Description MockHttpSession()
Create a new MockHttpSession with a defaultMockServletContext
.MockHttpSession(ServletContext servletContext)
Create a new MockHttpSession.MockHttpSession(ServletContext servletContext, String id)
Create a new MockHttpSession.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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)
Enumeration<String>
getAttributeNames()
long
getCreationTime()
String
getId()
long
getLastAccessedTime()
int
getMaxInactiveInterval()
ServletContext
getServletContext()
HttpSessionContext
getSessionContext()
Object
getValue(String name)
String[]
getValueNames()
void
invalidate()
Invalidates this session then unbinds any objects bound to it.boolean
isInvalid()
boolean
isNew()
void
putValue(String name, Object value)
void
removeAttribute(String name)
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)
void
setMaxInactiveInterval(int interval)
void
setNew(boolean value)
Field Detail
SESSION_COOKIE_NAME
public static final String SESSION_COOKIE_NAME
- See Also:
- Constant Field Values
Constructor Detail
MockHttpSession
public MockHttpSession()
Create a new MockHttpSession with a defaultMockServletContext
.- See Also:
MockServletContext
MockHttpSession
public MockHttpSession(ServletContext servletContext)
Create a new MockHttpSession.- Parameters:
servletContext
- the ServletContext that the session runs in
MockHttpSession
public MockHttpSession(ServletContext servletContext, String id)
Create a new MockHttpSession.- Parameters:
servletContext
- the ServletContext that the session runs inid
- a unique identifier for this session
Method Detail
getCreationTime
public long getCreationTime()
- Specified by:
getCreationTime
in interfaceHttpSession
getId
public String getId()
- Specified by:
getId
in interfaceHttpSession
changeSessionId
public String changeSessionId()
As of Servlet 3.1, the id of a session can be changed.- Returns:
- the new session id
- Since:
- 4.0.3
access
public void access()
getLastAccessedTime
public long getLastAccessedTime()
- Specified by:
getLastAccessedTime
in interfaceHttpSession
getServletContext
public ServletContext getServletContext()
- Specified by:
getServletContext
in interfaceHttpSession
setMaxInactiveInterval
public void setMaxInactiveInterval(int interval)
- Specified by:
setMaxInactiveInterval
in interfaceHttpSession
getMaxInactiveInterval
public int getMaxInactiveInterval()
- Specified by:
getMaxInactiveInterval
in interfaceHttpSession
getSessionContext
public HttpSessionContext getSessionContext()
- Specified by:
getSessionContext
in interfaceHttpSession
getAttribute
public Object getAttribute(String name)
- Specified by:
getAttribute
in interfaceHttpSession
getValue
public Object getValue(String name)
- Specified by:
getValue
in interfaceHttpSession
getAttributeNames
public Enumeration<String> getAttributeNames()
- Specified by:
getAttributeNames
in interfaceHttpSession
getValueNames
public String[] getValueNames()
- Specified by:
getValueNames
in interfaceHttpSession
setAttribute
public void setAttribute(String name, Object value)
- Specified by:
setAttribute
in interfaceHttpSession
putValue
public void putValue(String name, Object value)
- Specified by:
putValue
in interfaceHttpSession
removeAttribute
public void removeAttribute(String name)
- Specified by:
removeAttribute
in interfaceHttpSession
removeValue
public void removeValue(String name)
- Specified by:
removeValue
in interfaceHttpSession
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.- Specified by:
invalidate
in interfaceHttpSession
- Throws:
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()
- Specified by:
isNew
in interfaceHttpSession
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.- Returns:
- 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()
.- Parameters:
state
- a representation of this session's serialized state