org.springframework.security.core.context.SecurityContext Maven / Gradle / Ivy
/*
* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
*
* 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
*
* https://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.core.context;
import java.io.Serializable;
import org.springframework.security.core.Authentication;
/**
* Interface defining the minimum security information associated with the current thread
* of execution.
*
*
* The security context is stored in a {@link SecurityContextHolder}.
*
*
* @author Ben Alex
*/
public interface SecurityContext extends Serializable {
/**
* Obtains the currently authenticated principal, or an authentication request token.
* @return the Authentication
or null
if no authentication
* information is available
*/
Authentication getAuthentication();
/**
* Changes the currently authenticated principal, or removes the authentication
* information.
* @param authentication the new Authentication
token, or
* null
if no further authentication information should be stored
*/
void setAuthentication(Authentication authentication);
}