com.oppwa.mobile.connect.threeds

Class OppThreeDSService

java.lang.Object

com.oppwa.mobile.connect.threeds.OppThreeDSService

public class OppThreeDSService
extends java.lang.Object

The class to perform all necessary preparations for the 3-D Secure 2 authentication.

The service should be initialized just once per app session. Call initialize(Context, TransactionMode, List) method to start the service, it will initiate security checks and collecting device data as background task. It's recommended to initialize the service once the app is launched or at least once checkout is started.

Once service is initialized OppThreeDSTransaction object can be obtained for the specific transaction, please see createTransaction(String, String) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OppThreeDSService.Callback A callback to be notified when OppThreeDSService initialization is done.

Method Summary

Modifier and Type	Method and Description
void	cleanUp() The cleanup method frees up resources that are used by the 3DS SDK.
OppThreeDSTransaction	createTransaction(java.lang.String paymentBrand) Deprecated. Use createTransaction(String, String) instead. Creates transaction object for the specific payment brand. A reference should be kept for this transaction through the entire 3-D Secure process. When the transaction is complete, it should be closed via the OppThreeDSTransaction.close().
OppThreeDSTransaction	createTransaction(java.lang.String paymentBrand, java.lang.String protocolVersion) Creates transaction object for the specific payment brand and protocol version.
OppThreeDSConfig	getConfig() Configuration object to be used during service initialization.
static OppThreeDSService	getInstance() Returns single instance of the OppThreeDSService class.
java.lang.String	getNsoftwareVersion()
java.util.List<java.lang.String>	getPaymentBrands() Returns list of payment brands specified during initialization.
static java.lang.String	getSDKVersion() Returns version of the 3DS SDK.
java.util.List<Warning>	getWarnings() Returns warnings produced by the security checks during the service initialization.
void	initialize(android.content.Context context, TransactionMode transactionMode, java.util.List<java.lang.String> paymentBrands) Initializes the service, starts preparation for the 3-D Secure authentication.
boolean	isInitialized() Returns true if service is initialized, false otherwise.
void	setConfig(OppThreeDSConfig config) Sets configuration information that shall be used during initialization.
void	setCustomSchemeConfig(java.util.Map<java.lang.String,SchemeConfig> schemeConfigMap) Provides possibility to overwrite config information for the specific schemes to run transactions within specific environment.
void	setInitCallback(OppThreeDSService.Callback initCallback) Sets the callback which will be called after service initialization is done.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OppThreeDSService getInstance()

Returns single instance of the OppThreeDSService class.

Returns:

single instance of the OppThreeDSService class

initialize

public void initialize(android.content.Context context,
                       TransactionMode transactionMode,
                       java.util.List<java.lang.String> paymentBrands)
                throws InvalidInputException,
                       SDKRuntimeException

Initializes the service, starts preparation for the 3-D Secure authentication.

Preparation includes loading DS certificates for the specified payment brands, performing security checks and collecting device data as a background task.

You can know that initialization is done by checking isInitialized() or setInitCallback(Callback) to be notified about the result of initialization.

The state of the service is maintained until the cleanUp() method is called.

Parameters:

context - the instance of application context

transactionMode - the mode to switch between test and live system

paymentBrands - the list of payment brands which support 3-D Secure 2

Throws:

InvalidInputException - if list of payment brands is empty or transaction mode is invalid

SDKRuntimeException - if some internal error occurred

isInitialized

public boolean isInitialized()

Returns true if service is initialized, false otherwise.

Returns:

true if service is initialized, false otherwise

getPaymentBrands

public java.util.List<java.lang.String> getPaymentBrands()

Returns list of payment brands specified during initialization.

Returns:

list of payment brands specified during initialization

getConfig

public OppThreeDSConfig getConfig()

Configuration object to be used during service initialization.

If no custom config is set, the method will return default configuration to be used.

Returns:

configuration object to be used during service initialization.

setConfig

public void setConfig(OppThreeDSConfig config)

Sets configuration information that shall be used during initialization.

It's an optional method, if no config is set before initialization then default one will be applied.

Parameters:

config - the object containing configuration information to be applied during the initialization

See Also:

OppThreeDSConfig

setInitCallback

public void setInitCallback(OppThreeDSService.Callback initCallback)

Sets the callback which will be called after service initialization is done.

Parameters:

initCallback - the callback to be notified when service initialization is done

createTransaction

@Deprecated
public OppThreeDSTransaction createTransaction(java.lang.String paymentBrand)
                                                    throws InvalidInputException,
                                                           SDKNotInitializedException,
                                                           SDKRuntimeException

Deprecated. Use createTransaction(String, String) instead. Creates transaction object for the specific payment brand.

A reference should be kept for this transaction through the entire 3-D Secure process. When the transaction is complete, it should be closed via the OppThreeDSTransaction.close().

Parameters:

paymentBrand - brand of the shopper's card

Returns:

initialized transaction object

Throws:

InvalidInputException - if payment brand is not valid, e.g. it was not specified at OppThreeDSService initialization phase

SDKNotInitializedException - if service has not yet been initialized

SDKRuntimeException - if some internal error occurred

createTransaction

public OppThreeDSTransaction createTransaction(java.lang.String paymentBrand,
                                               java.lang.String protocolVersion)
                                        throws InvalidInputException,
                                               SDKNotInitializedException,
                                               SDKRuntimeException

Creates transaction object for the specific payment brand and protocol version.

A reference should be kept for this transaction through the entire 3-D Secure process. When the transaction is complete, it should be closed via the OppThreeDSTransaction.close().

Parameters:

paymentBrand - brand of the shopper's card

protocolVersion - the protocol version to use

Returns:

initialized transaction object

Throws:

InvalidInputException - if payment brand is not valid, e.g. it was not specified at OppThreeDSService initialization phase

SDKNotInitializedException - if service has not yet been initialized

SDKRuntimeException - if some internal error occurred

cleanUp

public void cleanUp()
             throws SDKNotInitializedException

The cleanup method frees up resources that are used by the 3DS SDK. It is called only once during a single app session.

Throws:

SDKNotInitializedException - if service has not yet been initialized

getWarnings

public java.util.List<Warning> getWarnings()
                                    throws SDKNotInitializedException

Returns warnings produced by the security checks during the service initialization.

These can be checked by the app to determine whether or not to proceed with the checkout process.

Returns:

the list of warnings produced during initialization

Throws:

SDKNotInitializedException - if service has not yet been initialized

setCustomSchemeConfig

public void setCustomSchemeConfig(java.util.Map<java.lang.String,SchemeConfig> schemeConfigMap)

Provides possibility to overwrite config information for the specific schemes to run transactions within specific environment. Should be used for testing purposes only.

Parameters:

schemeConfigMap - Map of the scheme config info, where key is a scheme, e.g. VISA.

getSDKVersion

public static java.lang.String getSDKVersion()

Returns version of the 3DS SDK.

Returns:

version of the 3DS SDK

getNsoftwareVersion

public java.lang.String getNsoftwareVersion()