Package io.getlime.security.powerauth.rest.api.spring.authentication.impl

Class PowerAuthApiAuthenticationImpl

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

io.getlime.security.powerauth.rest.api.spring.authentication.impl.PowerAuthApiAuthenticationImpl

All Implemented Interfaces:

PowerAuthApiAuthentication, Serializable, Principal, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer

public class PowerAuthApiAuthenticationImpl
extends org.springframework.security.authentication.AbstractAuthenticationToken
implements PowerAuthApiAuthentication, Serializable

PowerAuth API authentication object used between intermediate server application (such as mobile banking API) and core systems (such as banking core).

Author:

Petr Dvorak, petr@wultra.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PowerAuthApiAuthenticationImpl()	Default constructor
PowerAuthApiAuthenticationImpl(String activationId, String userId, Long applicationId, List<String> applicationRoles, List<String> activationFlags, AuthenticationContext authenticationContext)	Constructor for a new PowerAuthApiAuthenticationImpl.

Method Summary

Modifier and Type	Method	Description
PowerAuthActivation	getActivationContext()	Get the activation context.
List<String>	getActivationFlags()	Get activation flags.
String	getActivationId()	Get activation ID.
Long	getApplicationId()	Get related application ID.
List<String>	getApplicationRoles()	Get application roles.
AuthenticationContext	getAuthenticationContext()	Get PowerAuth authentication context.
Collection<org.springframework.security.core.GrantedAuthority>	getAuthorities()
Object	getCredentials()
io.getlime.security.powerauth.http.PowerAuthHttpHeader	getHttpHeader()	Get the PowerAuth HTTP header.
String	getName()
Object	getPrincipal()
io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes	getSignatureFactors()	Return authentication factors related to the signature that was used to produce this authentication object.
String	getUserId()	Get user ID.
String	getVersion()	Get PowerAuth protocol version.
void	setActivationContext(PowerAuthActivation activationContext)	Set the activation context.
void	setActivationFlags(List<String> activationFlags)	Set activation flags.
void	setActivationId(String activationId)	Set activation ID.
void	setApplicationId(Long id)	Set related application ID.
void	setApplicationRoles(List<String> applicationRoles)	Set application roles.
void	setAuthenticationContext(AuthenticationContext authenticationContext)	Set PowerAuth authentication context.
void	setHttpHeader(io.getlime.security.powerauth.http.PowerAuthHttpHeader httpHeader)	Set the PowerAuth HTTP header.
void	setSignatureFactors(io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes factors)	Set authentication factors related to the signature that was used to produce this authentication object.
void	setUserId(String userId)	Set user ID
void	setVersion(String version)	Set PowerAuth protocol version.

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

equals, eraseCredentials, getDetails, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Constructor Details

PowerAuthApiAuthenticationImpl

public PowerAuthApiAuthenticationImpl()

Default constructor

PowerAuthApiAuthenticationImpl

public PowerAuthApiAuthenticationImpl(String activationId,
String userId,
Long applicationId,
List<String> applicationRoles,
List<String> activationFlags,
AuthenticationContext authenticationContext)

Constructor for a new PowerAuthApiAuthenticationImpl.

Parameters:

activationId - Activation ID.

userId - User ID.

applicationId - Application ID.

applicationRoles - Application roles.

activationFlags - Activation flags.

authenticationContext - Authentication context.

Method Details

getName

public String getName()

Specified by:

getName in interface Principal

Overrides:

getName in class org.springframework.security.authentication.AbstractAuthenticationToken

getAuthorities

public Collection<org.springframework.security.core.GrantedAuthority> getAuthorities()

Specified by:

getAuthorities in interface org.springframework.security.core.Authentication

Overrides:

getAuthorities in class org.springframework.security.authentication.AbstractAuthenticationToken

getCredentials

public Object getCredentials()

Specified by:

getCredentials in interface org.springframework.security.core.Authentication

getPrincipal

public Object getPrincipal()

Specified by:

getPrincipal in interface org.springframework.security.core.Authentication

getUserId

public String getUserId()

Description copied from interface: PowerAuthApiAuthentication

Get user ID.

Specified by:

getUserId in interface PowerAuthApiAuthentication

Returns:

User ID.

setUserId

public void setUserId(String userId)

Description copied from interface: PowerAuthApiAuthentication

Set user ID

Specified by:

setUserId in interface PowerAuthApiAuthentication

Parameters:

userId - User ID

getActivationId

public String getActivationId()

Description copied from interface: PowerAuthApiAuthentication

Get activation ID. This method is deprecated, use PowerAuthApiAuthentication.getActivationContext() instead.

Specified by:

getActivationId in interface PowerAuthApiAuthentication

Returns:

Activation ID.

setActivationId

public void setActivationId(String activationId)

Description copied from interface: PowerAuthApiAuthentication

Set activation ID. This method is deprecated, use PowerAuthApiAuthentication.getActivationContext() instead.

Specified by:

setActivationId in interface PowerAuthApiAuthentication

Parameters:

activationId - Activation ID.

getApplicationId

public Long getApplicationId()

Description copied from interface: PowerAuthApiAuthentication

Get related application ID.

Specified by:

getApplicationId in interface PowerAuthApiAuthentication

Returns:

Application ID.

setApplicationId

public void setApplicationId(Long id)

Description copied from interface: PowerAuthApiAuthentication

Set related application ID.

Specified by:

setApplicationId in interface PowerAuthApiAuthentication

Parameters:

id - Application ID.

getApplicationRoles

public List<String> getApplicationRoles()

Description copied from interface: PowerAuthApiAuthentication

Get application roles.

Specified by:

getApplicationRoles in interface PowerAuthApiAuthentication

Returns:

Application roles.

setApplicationRoles

public void setApplicationRoles(List<String> applicationRoles)

Description copied from interface: PowerAuthApiAuthentication

Set application roles.

Specified by:

setApplicationRoles in interface PowerAuthApiAuthentication

Parameters:

applicationRoles - Application roles.

getActivationFlags

public List<String> getActivationFlags()

Description copied from interface: PowerAuthApiAuthentication

Get activation flags. This method is deprecated, use PowerAuthApiAuthentication.getActivationContext() instead.

Specified by:

getActivationFlags in interface PowerAuthApiAuthentication

Returns:

Activation flags.

setActivationFlags

public void setActivationFlags(List<String> activationFlags)

Description copied from interface: PowerAuthApiAuthentication

Set activation flags. This method is deprecated, use PowerAuthApiAuthentication.getActivationContext() instead.

Specified by:

setActivationFlags in interface PowerAuthApiAuthentication

Parameters:

activationFlags - Activation flags.

getSignatureFactors

public io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes getSignatureFactors()

Description copied from interface: PowerAuthApiAuthentication

Return authentication factors related to the signature that was used to produce this authentication object. This method is deprecated, use PowerAuthApiAuthentication.getAuthenticationContext() ()} instead.

Specified by:

getSignatureFactors in interface PowerAuthApiAuthentication

Returns:

Signature type (signature factors).

setSignatureFactors

public void setSignatureFactors(io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes factors)

Description copied from interface: PowerAuthApiAuthentication

Set authentication factors related to the signature that was used to produce this authentication object. This method is deprecated, use PowerAuthApiAuthentication.getAuthenticationContext() ()} instead.

Specified by:

setSignatureFactors in interface PowerAuthApiAuthentication

Parameters:

factors - Signature type (signature factors).

getAuthenticationContext

public AuthenticationContext getAuthenticationContext()

Description copied from interface: PowerAuthApiAuthentication

Get PowerAuth authentication context.

Specified by:

getAuthenticationContext in interface PowerAuthApiAuthentication

Returns:

PowerAuth authentication context.

setAuthenticationContext

public void setAuthenticationContext(AuthenticationContext authenticationContext)

Description copied from interface: PowerAuthApiAuthentication

Set PowerAuth authentication context.

Specified by:

setAuthenticationContext in interface PowerAuthApiAuthentication

Parameters:

authenticationContext - PowerAuth authentication context.

getVersion

public String getVersion()

Description copied from interface: PowerAuthApiAuthentication

Get PowerAuth protocol version.

Specified by:

getVersion in interface PowerAuthApiAuthentication

Returns:

PowerAuth protocol version.

setVersion

public void setVersion(String version)

Description copied from interface: PowerAuthApiAuthentication

Set PowerAuth protocol version.

Specified by:

setVersion in interface PowerAuthApiAuthentication

Parameters:

version - PowerAuth protocol version.

getHttpHeader

public io.getlime.security.powerauth.http.PowerAuthHttpHeader getHttpHeader()

Description copied from interface: PowerAuthApiAuthentication

Get the PowerAuth HTTP header.

Specified by:

getHttpHeader in interface PowerAuthApiAuthentication

Returns:

PowerAuth HTTP header.

setHttpHeader

public void setHttpHeader(io.getlime.security.powerauth.http.PowerAuthHttpHeader httpHeader)

Description copied from interface: PowerAuthApiAuthentication

Set the PowerAuth HTTP header.

Specified by:

setHttpHeader in interface PowerAuthApiAuthentication

Parameters:

httpHeader - PowerAuth HTTP header.

getActivationContext

public PowerAuthActivation getActivationContext()

Description copied from interface: PowerAuthApiAuthentication

Get the activation context.

Specified by:

getActivationContext in interface PowerAuthApiAuthentication

Returns:

Activation context.

setActivationContext

public void setActivationContext(PowerAuthActivation activationContext)

Description copied from interface: PowerAuthApiAuthentication

Set the activation context.

Specified by:

setActivationContext in interface PowerAuthApiAuthentication

Parameters:

activationContext - Activation context.