Package com.vasco.orchestration.client
Interface Orchestrator
public interface Orchestrator
The
Orchestrator
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 the execute(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 -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
Executes an Orchestration Command provided by the server.Provides aCDDCDataFeeder
object that allows integrator to set CDDC data values .getCDDCMessage
(CDDCMessageParams cddcMessageParams) 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 Details
-
VERSION
CurrentOrchestrator
version.- See Also:
-
-
Method Details
-
execute
Executes an Orchestration Command provided by the server.- Parameters:
command
- the Orchestration Command provided by the server, as an hexadecimal string.
-
startActivation
Starts the activation process. -
startNotificationRegistration
void startNotificationRegistration(@NonNull NotificationRegistrationParams notificationRegistrationParams) Starts registering for push notifications. -
startChangePassword
Starts password changing. -
startLocalAuthentication
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
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
- Parameters:
cddcMessageParams
-CDDCMessageParams
object- Returns:
- a
CDDCMessage
object, with the CDDC data in clear text or encrypted.
-
setRemoteAuthCallback
Sets the callback to be notified about remote authentication events. -
setRemoteTranCallback
Sets the callback to be notified about remote transaction validation events. -
setErrorCallback
Sets the callback to be notified of errors. -
setWarningCallback
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.
-