Class MockHttpSession

java.lang.Object
org.springframework.mock.web.MockHttpSession
All Implemented Interfaces:
jakarta.servlet.http.HttpSession
public class MockHttpSession extends Object implements jakarta.servlet.http.HttpSession
Mock implementation of the HttpSession interface.

As of Spring 7.0, this set of mocks is designed on a Servlet 6.1 baseline.

Since:
1.0.2
Author:
Juergen Hoeller, Rod Johnson, Mark Fisher, Sam Brannen, Vedran Pavic

  • Field Details

  • Constructor Details

    • MockHttpSession

      public MockHttpSession()
      Create a new MockHttpSession with a default MockServletContext.
      See Also:

    • MockHttpSession

      public MockHttpSession(@Nullable jakarta.servlet.ServletContext servletContext)
      Create a new MockHttpSession.
      Parameters:
      servletContext - the ServletContext that the session runs in

    • MockHttpSession

      public MockHttpSession(@Nullable jakarta.servlet.ServletContext servletContext, @Nullable String id)
      Create a new MockHttpSession.
      Parameters:
      servletContext - the ServletContext that the session runs in
      id - a unique identifier for this session

  • Method Details

    • getCreationTime

      public long getCreationTime()
      Specified by:
      getCreationTime in interface jakarta.servlet.http.HttpSession

    • getId

      public String getId()
      Specified by:
      getId in interface jakarta.servlet.http.HttpSession

    • 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 interface jakarta.servlet.http.HttpSession

    • getServletContext

      public jakarta.servlet.ServletContext getServletContext()
      Specified by:
      getServletContext in interface jakarta.servlet.http.HttpSession

    • setMaxInactiveInterval

      public void setMaxInactiveInterval(int interval)
      Specified by:
      setMaxInactiveInterval in interface jakarta.servlet.http.HttpSession

    • getMaxInactiveInterval

      public int getMaxInactiveInterval()
      Specified by:
      getMaxInactiveInterval in interface jakarta.servlet.http.HttpSession

    • getAttribute

      public @Nullable Object getAttribute(String name)
      Specified by:
      getAttribute in interface jakarta.servlet.http.HttpSession

    • getAttributeNames

      public Enumeration<String> getAttributeNames()
      Specified by:
      getAttributeNames in interface jakarta.servlet.http.HttpSession

    • setAttribute

      public void setAttribute(String name, @Nullable Object value)
      Specified by:
      setAttribute in interface jakarta.servlet.http.HttpSession

    • removeAttribute

      public void removeAttribute(String name)
      Specified by:
      removeAttribute in interface jakarta.servlet.http.HttpSession

    • 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 interface jakarta.servlet.http.HttpSession
      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 interface jakarta.servlet.http.HttpSession

    • getAccessor

      public jakarta.servlet.http.HttpSession.Accessor getAccessor()
      Specified by:
      getAccessor in interface jakarta.servlet.http.HttpSession

    • 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 by serializeState().
      Parameters:
      state - a representation of this session's serialized state