org.springframework.security.core.AuthenticatedPrincipal Maven / Gradle / Ivy
/*
* Copyright 2002-2017 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
*
* 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;
import org.springframework.security.authentication.AuthenticationManager;
/**
* Representation of an authenticated Principal
once an
* {@link Authentication} request has been successfully authenticated by the
* {@link AuthenticationManager#authenticate(Authentication)} method.
*
* Implementors typically provide their own representation of a Principal
,
* which usually contains information describing the Principal
entity, such
* as, first/middle/last name, address, email, phone, id, etc.
*
* This interface allows implementors to expose specific attributes of their custom
* representation of Principal
in a generic way.
*
* @author Joe Grandja
* @since 5.0
* @see Authentication#getPrincipal()
* @see org.springframework.security.core.userdetails.UserDetails
*/
public interface AuthenticatedPrincipal {
/**
* Returns the name of the authenticated Principal
. Never
* null
.
* @return the name of the authenticated Principal
*/
String getName();
}