public interface

RequestCache

org.springframework.security.web.savedrequest.RequestCache
Known Indirect Subclasses

Class Overview

Implements "saved request" logic, allowing a single request to be retrieved and restarted after redirecting to an authentication mechanism.

Summary

Public Methods
abstract HttpServletRequest getMatchingRequest(HttpServletRequest request, HttpServletResponse response)
Returns a wrapper around the saved request, if it matches the current request.
abstract SavedRequest getRequest(HttpServletRequest request, HttpServletResponse response)
Returns the saved request, leaving it cached.
abstract void removeRequest(HttpServletRequest request, HttpServletResponse response)
Removes the cached request.
abstract void saveRequest(HttpServletRequest request, HttpServletResponse response)
Caches the current request for later retrieval, once authentication has taken place.

Public Methods

public abstract HttpServletRequest getMatchingRequest (HttpServletRequest request, HttpServletResponse response)

Returns a wrapper around the saved request, if it matches the current request. The saved request should be removed from the cache.

Returns
  • the wrapped save request, if it matches the original, or null if there is no cached request or it doesn't match.

public abstract SavedRequest getRequest (HttpServletRequest request, HttpServletResponse response)

Returns the saved request, leaving it cached.

Parameters
request the current request
Returns
  • the saved request which was previously cached, or null if there is none.

public abstract void removeRequest (HttpServletRequest request, HttpServletResponse response)

Removes the cached request.

Parameters
request the current request, allowing access to the cache.

public abstract void saveRequest (HttpServletRequest request, HttpServletResponse response)

Caches the current request for later retrieval, once authentication has taken place. Used by ExceptionTranslationFilter.

Parameters
request the request to be stored