Interface PowerAuthApiAuthentication
- All Known Implementing Classes:
PowerAuthApiAuthenticationImpl
public interface PowerAuthApiAuthentication
Interface for 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
-
Method Summary
Modifier and Type Method Description PowerAuthActivationgetActivationContext()Get the activation context.List<String>getActivationFlags()Deprecated.StringgetActivationId()Deprecated.LonggetApplicationId()Get related application ID.List<String>getApplicationRoles()Get application roles.AuthenticationContextgetAuthenticationContext()Get PowerAuth authentication context.io.getlime.security.powerauth.http.PowerAuthHttpHeadergetHttpHeader()Get the PowerAuth HTTP header.io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypesgetSignatureFactors()Deprecated.StringgetUserId()Get user ID.StringgetVersion()Get PowerAuth protocol version.voidsetActivationContext(PowerAuthActivation activationContext)Set the activation context.voidsetActivationFlags(List<String> activationFlags)Deprecated.voidsetActivationId(String activationId)Deprecated.voidsetApplicationId(Long id)Set related application ID.voidsetApplicationRoles(List<String> applicationRoles)Set application roles.voidsetAuthenticationContext(AuthenticationContext authenticationContext)Set PowerAuth authentication context.voidsetHttpHeader(io.getlime.security.powerauth.http.PowerAuthHttpHeader httpHeader)Set the PowerAuth HTTP header.voidsetSignatureFactors(io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes factors)Deprecated.voidsetUserId(String userId)Set user IDvoidsetVersion(String version)Set PowerAuth protocol version.
-
Method Details
-
getUserId
String getUserId()Get user ID.- Returns:
- User ID.
-
setUserId
Set user ID- Parameters:
userId- User ID
-
getActivationId
Deprecated.Get activation ID. This method is deprecated, usegetActivationContext()instead.- Returns:
- Activation ID.
-
setActivationId
Deprecated.Set activation ID. This method is deprecated, usegetActivationContext()instead.- Parameters:
activationId- Activation ID.
-
getApplicationId
Long getApplicationId()Get related application ID.- Returns:
- Application ID.
-
setApplicationId
Set related application ID.- Parameters:
id- Application ID.
-
getApplicationRoles
Get application roles.- Returns:
- Application roles.
-
setApplicationRoles
Set application roles.- Parameters:
applicationRoles- Application roles.
-
getActivationFlags
Deprecated.Get activation flags. This method is deprecated, usegetActivationContext()instead.- Returns:
- Activation flags.
-
setActivationFlags
Deprecated.Set activation flags. This method is deprecated, usegetActivationContext()instead.- Parameters:
activationFlags- Activation flags.
-
getSignatureFactors
@Deprecated io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes getSignatureFactors()Deprecated.Return authentication factors related to the signature that was used to produce this authentication object. This method is deprecated, usegetAuthenticationContext()()} instead.- Returns:
- Signature type (signature factors).
-
setSignatureFactors
@Deprecated void setSignatureFactors(io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes factors)Deprecated.Set authentication factors related to the signature that was used to produce this authentication object. This method is deprecated, usegetAuthenticationContext()()} instead.- Parameters:
factors- Signature type (signature factors).
-
getAuthenticationContext
AuthenticationContext getAuthenticationContext()Get PowerAuth authentication context.- Returns:
- PowerAuth authentication context.
-
setAuthenticationContext
Set PowerAuth authentication context.- Parameters:
authenticationContext- PowerAuth authentication context.
-
getVersion
String getVersion()Get PowerAuth protocol version.- Returns:
- PowerAuth protocol version.
-
setVersion
Set PowerAuth protocol version.- Parameters:
version- PowerAuth protocol version.
-
getHttpHeader
io.getlime.security.powerauth.http.PowerAuthHttpHeader getHttpHeader()Get the PowerAuth HTTP header.- Returns:
- PowerAuth HTTP header.
-
setHttpHeader
void setHttpHeader(io.getlime.security.powerauth.http.PowerAuthHttpHeader httpHeader)Set the PowerAuth HTTP header.- Parameters:
httpHeader- PowerAuth HTTP header.
-
getActivationContext
PowerAuthActivation getActivationContext()Get the activation context.- Returns:
- Activation context.
-
setActivationContext
Set the activation context.- Parameters:
activationContext- Activation context.
-