org.assistments.service.security.authentication.core

Class BaseAuthenticationData

java.lang.Object

org.assistments.service.security.authentication.core.BaseAuthenticationData

All Implemented Interfaces:

AuthenticationData

Direct Known Subclasses:

BasicAuthenticationData, CookieAuthenticationData, CookieRestAuthenticationData, LegacyBaseAuthenticationData, RestAuthenticationData

public abstract class BaseAuthenticationData
extends java.lang.Object
implements AuthenticationData

BaseAuthenticationData contains certain authentication-related data:

• The current Partner's credentials
• The authentication state: authenticated or not
• For an authenticated requester, the principal that was authenticated and their granted authorities

Implementing classes are expected to hold the requestor's credentials such as a user's login name and password, or a partner's reference identifier. That is to say each super class covers a different authentication mechanism.

Nested Class Summary

Nested classes/interfaces inherited from interface org.assistments.service.security.authentication.core.AuthenticationData

AuthenticationData.AuthDataType

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.springframework.context.ApplicationContext	ac
static AccessTokenManager	accessTokenMgr
static PartnerDao	partnerDao
static RolesManager	rolesMgr
static UserManager	userMgr

Constructor Summary

Constructors

Constructor and Description
BaseAuthenticationData(AuthenticationData.AuthDataType type)

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()
static void	initManagerBeans(org.springframework.context.ApplicationContext ac)
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)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ac

protected static org.springframework.context.ApplicationContext ac

accessTokenMgr

public static AccessTokenManager accessTokenMgr

userMgr

public static UserManager userMgr

rolesMgr

public static RolesManager rolesMgr

partnerDao

public static PartnerDao partnerDao

Constructor Detail

BaseAuthenticationData

public BaseAuthenticationData(AuthenticationData.AuthDataType type)

Method Detail

getAuthDataType

public AuthenticationData.AuthDataType getAuthDataType()

Specified by:

getAuthDataType in interface AuthenticationData

isAuthDataType

public boolean isAuthDataType(AuthenticationData.AuthDataType type)

Specified by:

isAuthDataType in interface AuthenticationData

initManagerBeans

public static void initManagerBeans(org.springframework.context.ApplicationContext ac)

setRequestorCredentials

public void setRequestorCredentials(RequestorCredentials rCreds)

Specified by:

setRequestorCredentials in interface AuthenticationData

getRequestorCredentials

public RequestorCredentials getRequestorCredentials()

Specified by:

getRequestorCredentials in interface AuthenticationData

setPrincipalName

public void setPrincipalName(java.lang.String name)

Specified by:

setPrincipalName in interface AuthenticationData

getPrincipalName

public java.lang.String getPrincipalName()

Specified by:

getPrincipalName in interface AuthenticationData

getAuthorities

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

Description copied from interface: AuthenticationData

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

Specified by:

getAuthorities in interface AuthenticationData

Returns:

the set of GrantedAuthority objects.

getPrincipal

public User getPrincipal()

Description copied from interface: AuthenticationData

Access the identity (username) for this Authentication.

Specified by:

getPrincipal in interface AuthenticationData

Returns:

the identity, implementing java.security.Principal

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: AuthenticationData

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

Specified by:

isAuthenticated in interface AuthenticationData

setAuthorities

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

Specified by:

setAuthorities in interface AuthenticationData

setAuthenticated

public void setAuthenticated(boolean authenticated)

Specified by:

setAuthenticated in interface AuthenticationData

getAuthenticationError

public AuthenticationException getAuthenticationError()

Specified by:

getAuthenticationError in interface AuthenticationData

Returns:

the authenticationError

setAuthenticationError

public void setAuthenticationError(AuthenticationException authenticationError)

Specified by:

setAuthenticationError in interface AuthenticationData

Parameters:

authenticationError - the authenticationError to set

setPrincipal

public void setPrincipal(java.security.Principal principal)

Specified by:

setPrincipal in interface AuthenticationData

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object