org.assistments.service.security.authentication.core

Interface AuthenticationData

All Known Implementing Classes:

BaseAuthenticationData, BasicAuthenticationData, CookieAuthenticationData, CookieRestAuthenticationData, LegacyBaseAuthenticationData, LegacyBasicAuthenticationData, LegacyCookieAuthenticationData, LegacyRestAuthenticationData, RestAuthenticationData

public interface AuthenticationData

An Authentication represents the identity of someone using the application. Authentications can be requests for authentication or fully verified (distinguished by isAuthenticated()). Each Authentication has a principal (Object) that represents their identity, credentials (Object) that proves the identity is valid, and a set of roles (GrantedAuthority) that are used in access decision making.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthenticationData.AuthDataType

Method Summary

Modifier and Type	Method and Description
AuthenticationData.AuthDataType	getAuthDataType()
AuthenticationException	getAuthenticationError()
java.util.Set<? extends GrantedAuthority>	getAuthorities() Access the set of authorities (roles) for this Authentication.
User	getPrincipal() Access the identity (username) for this Authentication.
java.lang.String	getPrincipalName()
RequestorCredentials	getRequestorCredentials()
boolean	isAuthDataType(AuthenticationData.AuthDataType type)
boolean	isAuthenticated() Indicate whether this Authentication has been verified by the AuthenticationManager yet.
void	setAuthenticated(boolean authenticated)
void	setAuthenticationError(AuthenticationException authenticationError)
void	setAuthorities(java.util.Set<GrantedAuthority> authorities)
void	setPrincipal(java.security.Principal principal)
void	setPrincipalName(java.lang.String name)
void	setRequestorCredentials(RequestorCredentials rCreds)

Method Detail

getAuthDataType

AuthenticationData.AuthDataType getAuthDataType()

isAuthDataType

boolean isAuthDataType(AuthenticationData.AuthDataType type)

setRequestorCredentials

void setRequestorCredentials(RequestorCredentials rCreds)

getRequestorCredentials

RequestorCredentials getRequestorCredentials()

getAuthorities

java.util.Set<? extends GrantedAuthority> getAuthorities()

Access the set of authorities (roles) for this Authentication.

Returns:

the set of GrantedAuthority objects.

setAuthorities

void setAuthorities(java.util.Set<GrantedAuthority> authorities)

getPrincipal

User getPrincipal()

Access the identity (username) for this Authentication.

Returns:

the identity, implementing java.security.Principal

setPrincipal

void setPrincipal(java.security.Principal principal)

setPrincipalName

void setPrincipalName(java.lang.String name)

getPrincipalName

java.lang.String getPrincipalName()

isAuthenticated

boolean isAuthenticated()

Indicate whether this Authentication has been verified by the AuthenticationManager yet.

setAuthenticated

void setAuthenticated(boolean authenticated)

getAuthenticationError

AuthenticationException getAuthenticationError()

setAuthenticationError

void setAuthenticationError(AuthenticationException authenticationError)