Package org.springframework.security.web.context

Class NullSecurityContextRepository

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean containsContext​(javax.servlet.http.HttpServletRequest request)
      Allows the repository to be queried as to whether it contains a security context for the current request.
      SecurityContext loadContext​(HttpRequestResponseHolder requestResponseHolder)
      Obtains the security context for the supplied request.
      void saveContext​(SecurityContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Stores the security context on completion of a request.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • NullSecurityContextRepository

        public NullSecurityContextRepository()

    • Method Detail

      • containsContext

        public boolean containsContext​(javax.servlet.http.HttpServletRequest request)
        Description copied from interface: SecurityContextRepository
        Allows the repository to be queried as to whether it contains a security context for the current request.
        Specified by:
        containsContext in interface SecurityContextRepository
        Parameters:
        request - the current request
        Returns:
        true if a context is found for the request, false otherwise

      • loadContext

        public SecurityContext loadContext​(HttpRequestResponseHolder requestResponseHolder)
        Description copied from interface: SecurityContextRepository
        Obtains the security context for the supplied request. For an unauthenticated user, an empty context implementation should be returned. This method should not return null.

        The use of the HttpRequestResponseHolder parameter allows implementations to return wrapped versions of the request or response (or both), allowing them to access implementation-specific state for the request. The values obtained from the holder will be passed on to the filter chain and also to the saveContext method when it is finally called to allow implicit saves of the SecurityContext. Implementations may wish to return a subclass of SaveContextOnUpdateOrErrorResponseWrapper as the response object, which guarantees that the context is persisted when an error or redirect occurs. Implementations may allow passing in the original request response to allow explicit saves.

        Specified by:
        loadContext in interface SecurityContextRepository
        Parameters:
        requestResponseHolder - holder for the current request and response for which the context should be loaded.
        Returns:
        The security context which should be used for the current request, never null.

      • saveContext

        public void saveContext​(SecurityContext context,
                        javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
        Description copied from interface: SecurityContextRepository
        Stores the security context on completion of a request.
        Specified by:
        saveContext in interface SecurityContextRepository
        Parameters:
        context - the non-null context which was obtained from the holder.