Package com.vasco.orchestration.client
Interface Orchestrator
-
public interface Orchestrator
TheOrchestrator
interface is the entry point of the Orchestration SDK. It allows the execution of orchestration commands providing seamless two-factor authentication.Creation
You can create an orchestrator using the internal class
Orchestrator.Builder
. This builder will provide you with the minimal required configuration for the orchestrator.Subsequent configurations can be done during the lifecycle of the
Orchestrator
object by using the related setters.Provisioning
In order to provision the SDK with a DIGIPASS instance, a call to
startActivation(ActivationParams activationParams)
must be performed.
All subsequent orchestration commands transmission shall be done through theexecute(String)
method.Notification registration
In order to provision the SDK with a DIGIPASS instance, a call to
startNotificationRegistration(NotificationRegistrationParams activationParams)
must be performed.
Commands
All subsequent orchestration commands transmission shall be done through theexecute(String)
method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Orchestrator.Builder
Simple builder for theOrchestrator
object.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
VERSION
CurrentOrchestrator
version.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
execute(java.lang.String command)
Executes an Orchestration Command provided by the server.CDDCDataFeeder
getCDDCDataFeeder()
Provides aCDDCDataFeeder
object that allows integrator to set CDDC data values .CDDCMessage
getCDDCMessage(CDDCMessageParams cddcMessageParams)
UserManager
getUserManager()
Provides aUserManager
object that allows manipulation of users and DIGIPASSes.void
setErrorCallback(OrchestrationErrorCallback orchestrationErrorCallback)
Sets the callback to be notified of errors.void
setRemoteAuthCallback(RemoteAuthenticationCallback remoteAuthenticationCallback)
Sets the callback to be notified about remote authentication events.void
setRemoteTranCallback(RemoteTransactionCallback remoteTransactionCallback)
Sets the callback to be notified about remote transaction validation events.void
setUserAuthenticationCallback(UserAuthenticationCallback userAuthenticationCallback, UserAuthenticationCallback.UserAuthentication[] types)
Sets the callback to override the way a user authentication will be displayed.void
setWarningCallback(OrchestrationWarningCallback orchestrationWarningCallback)
Sets the callback called when warnings happen.void
startActivation(ActivationParams activationParams)
Starts the activation process.void
startChangePassword(ChangePasswordParams changePasswordParams)
Starts password changing.void
startLocalAuthentication(LocalAuthenticationParams localAuthenticationParams)
Starts a local authentication process.void
startLocalTransaction(LocalTransactionParams localTransactionParams)
Starts a local transaction process.void
startNotificationRegistration(NotificationRegistrationParams notificationRegistrationParams)
Starts registering for push notifications.
-
-
-
Field Detail
-
VERSION
static final java.lang.String VERSION
CurrentOrchestrator
version.- See Also:
- Constant Field Values
-
-
Method Detail
-
execute
void execute(@NonNull java.lang.String command)
Executes an Orchestration Command provided by the server.- Parameters:
command
- the Orchestration Command provided by the server, as an hexadecimal string.
-
startActivation
void startActivation(@NonNull ActivationParams activationParams)
Starts the activation process.
-
startNotificationRegistration
void startNotificationRegistration(@NonNull NotificationRegistrationParams notificationRegistrationParams)
Starts registering for push notifications.
-
startChangePassword
void startChangePassword(@NonNull ChangePasswordParams changePasswordParams)
Starts password changing.
-
startLocalAuthentication
void startLocalAuthentication(@NonNull LocalAuthenticationParams localAuthenticationParams)
Starts a local authentication process. This method is used to generate a one-time password using a specified protection type and an optional challenge.
-
startLocalTransaction
void startLocalTransaction(@NonNull LocalTransactionParams localTransactionParams)
Starts a local transaction process. This method is used to generate a signature from specified data fields and using a specified protection type.
-
getUserManager
UserManager getUserManager()
Provides aUserManager
object that allows manipulation of users and DIGIPASSes.- Returns:
- a
UserManager
object
-
getCDDCDataFeeder
CDDCDataFeeder getCDDCDataFeeder()
Provides aCDDCDataFeeder
object that allows integrator to set CDDC data values .- Returns:
- a
CDDCDataFeeder
object
-
getCDDCMessage
CDDCMessage getCDDCMessage(CDDCMessageParams cddcMessageParams)
- Parameters:
cddcMessageParams
-CDDCMessageParams
object- Returns:
- a
CDDCMessage
object, with the CDDC data in clear text or encrypted.
-
setRemoteAuthCallback
void setRemoteAuthCallback(@NonNull RemoteAuthenticationCallback remoteAuthenticationCallback)
Sets the callback to be notified about remote authentication events.
-
setRemoteTranCallback
void setRemoteTranCallback(@NonNull RemoteTransactionCallback remoteTransactionCallback)
Sets the callback to be notified about remote transaction validation events.
-
setErrorCallback
void setErrorCallback(@NonNull OrchestrationErrorCallback orchestrationErrorCallback)
Sets the callback to be notified of errors.
-
setWarningCallback
void setWarningCallback(OrchestrationWarningCallback orchestrationWarningCallback)
Sets the callback called when warnings happen.
-
setUserAuthenticationCallback
void setUserAuthenticationCallback(@NonNull UserAuthenticationCallback userAuthenticationCallback, UserAuthenticationCallback.UserAuthentication[] types)
Sets the callback to override the way a user authentication will be displayed.- Parameters:
userAuthenticationCallback
- aUserAuthenticationCallback
objecttypes
- an array ofUserAuthenticationCallback.UserAuthentication
the type of user authentication that will be overridden.
-
-