org.springframework.security.web.context.SecurityContextRepository Maven / Gradle / Ivy
/*
* Copyright 2002-2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.web.context;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.security.core.context.SecurityContext;
/**
* Strategy used for persisting a {@link SecurityContext} between requests.
*
* Used by {@link SecurityContextPersistenceFilter} to obtain the context which should be
* used for the current thread of execution and to store the context once it has been
* removed from thread-local storage and the request has completed.
*
* The persistence mechanism used will depend on the implementation, but most commonly the
* HttpSession will be used to store the context.
*
* @author Luke Taylor
* @since 3.0
*
* @see SecurityContextPersistenceFilter
* @see HttpSessionSecurityContextRepository
* @see SaveContextOnUpdateOrErrorResponseWrapper
*/
public 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. Implementations may wish to return a subclass of
* {@link SaveContextOnUpdateOrErrorResponseWrapper} as the response object, which
* guarantees that the context is persisted when an error or redirect occurs.
*
* @param requestResponseHolder holder for the current request and response for which
* the context should be loaded.
*
* @return The security context which should be used for the current request, never
* null.
*/
SecurityContext loadContext(HttpRequestResponseHolder requestResponseHolder);
/**
* Stores the security context on completion of a request.
*
* @param context the non-null context which was obtained from the holder.
* @param request
* @param response
*/
void saveContext(SecurityContext context, HttpServletRequest request,
HttpServletResponse response);
/**
* Allows the repository to be queried as to whether it contains a security context
* for the current request.
*
* @param request the current request
* @return true if a context is found for the request, false otherwise
*/
boolean containsContext(HttpServletRequest request);
}