com.oppwa.mobile.connect.threeds

Class OppThreeDSConfig.Builder

java.lang.Object

com.oppwa.mobile.connect.threeds.OppThreeDSConfig.Builder

Enclosing class:

OppThreeDSConfig

public static class OppThreeDSConfig.Builder
extends java.lang.Object

Class to build OppThreeDSConfig class with customized parameters.

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(OppThreeDSConfig config) Copy constructor for the Builder class

Method Summary

Modifier and Type	Method and Description
OppThreeDSConfig.Builder	addClientConfigParam(java.lang.String key, java.lang.String value) Sets value for the custom parameter for the /n software Client component.
OppThreeDSConfig	build() Creates OppThreeDSConfig initialized with all set earlier parameters.
OppThreeDSConfig.Builder	setAppSignature(java.lang.String appSignature) Sets app signature to be verified by the SDK.
OppThreeDSConfig.Builder	setChallengeUiTypes(java.util.EnumSet<ChallengeUiType> challengeUiTypes) Sets supported UI types for displaying challenge screens.
OppThreeDSConfig.Builder	setDeviceParameterBlacklist(java.lang.String[] deviceParameterBlacklist) Sets the list of device parameters that should NOT be collected for the device.
OppThreeDSConfig.Builder	setLocale(java.lang.String locale) Sets string that represents the locale for the app's user interface.
OppThreeDSConfig.Builder	setMaliciousApps(java.lang.String[] maliciousApps) Sets the list of package names for the apps that should be recognized as malicious.
OppThreeDSConfig.Builder	setSdkMaxTimeout(int sdkMaxTimeout) Sets maximum amount of time (in minutes) for all exchanges for the 3-D Secure authentication.
OppThreeDSConfig.Builder	setTrustedAppStores(java.lang.String[] trustedAppStores) Sets additional list of trusted applications, that would not cause security warnings (SW02).
OppThreeDSConfig.Builder	setUiCustomization(UiCustomization uiCustomization) Sets UI configuration information that is used to specify the UI layout and theme of the challenge screens, for example, font style and font size.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(OppThreeDSConfig config)

Copy constructor for the Builder class

Parameters:

config - Config class to be copied into Builder

Method Detail

setChallengeUiTypes

public OppThreeDSConfig.Builder setChallengeUiTypes(java.util.EnumSet<ChallengeUiType> challengeUiTypes)

Sets supported UI types for displaying challenge screens. They may vary for native way, e.g. present OTP or single select screen. By default all UI types are supported, it's strongly recommended by EMVCo.

Parameters:

challengeUiTypes - set of supported UI types for displaying challenge screens

Returns:

itself for chained execution

setSdkMaxTimeout

public OppThreeDSConfig.Builder setSdkMaxTimeout(int sdkMaxTimeout)

Sets maximum amount of time (in minutes) for all exchanges for the 3-D Secure authentication. Default value is 5 minutes.

Parameters:

sdkMaxTimeout - maximum amount of time in minutes for all exchanges for 3-D Secure authentication

Returns:

itself for chained execution

setUiCustomization

public OppThreeDSConfig.Builder setUiCustomization(UiCustomization uiCustomization)

Sets UI configuration information that is used to specify the UI layout and theme of the challenge screens, for example, font style and font size.

Parameters:

uiCustomization - UI configuration info to be applied for the challenge screens

Returns:

itself for chained execution

setLocale

public OppThreeDSConfig.Builder setLocale(java.lang.String locale)

Sets string that represents the locale for the app's user interface.

Parameters:

locale - string representation of the locale (for example, "en-US")

Returns:

itself for chained execution

setDeviceParameterBlacklist

public OppThreeDSConfig.Builder setDeviceParameterBlacklist(java.lang.String[] deviceParameterBlacklist)

Sets the list of device parameters that should NOT be collected for the device. By default, the SDK will pull as many device parameters as it can. Refer to the "EMV® 3-D Secure SDK—Device Information" guide to see the full list of possible device parameters and appropriate constants to be used. Sample values would be ["A001", "A002"].

Parameters:

deviceParameterBlacklist - the list of device parameters that should NOT be collected

Returns:

itself for chained execution

setAppSignature

public OppThreeDSConfig.Builder setAppSignature(java.lang.String appSignature)

Sets app signature to be verified by the SDK. If verification fail security warning (SW02) will be raised. The user should store the app signature to their server and retrieve it (and set it here). Note that this should not be hardcoded in the app for security reasons.

Parameters:

appSignature - Signature of the user's app to be verified by the SDK during service initialization

Returns:

itself for chained execution

setTrustedAppStores

public OppThreeDSConfig.Builder setTrustedAppStores(java.lang.String[] trustedAppStores)

Sets additional list of trusted applications, that would not cause security warnings (SW02). A security warning (SW02) will be raised if the app is not installed from the Google app store. Add some other applications that will be recognized by security checker as trusted.

Parameters:

trustedAppStores - the list of package names of the trusted applications

Returns:

itself for chained execution

setMaliciousApps

public OppThreeDSConfig.Builder setMaliciousApps(java.lang.String[] maliciousApps)

Sets the list of package names for the apps that should be recognized as malicious. If the apps are installed, a security warning (SW02) will be raised. This could be checked in OppThreeDSService.getWarnings() after service is initialized. There are some default malicious apps configured inside by default:

• de.robv.android.xposed
• de.robv.android.xposed.installer
• com.saurik.substrate

Parameters:

maliciousApps - the list of package names of malicious applications

Returns:

itself for chained execution

addClientConfigParam

public OppThreeDSConfig.Builder addClientConfigParam(java.lang.String key,
                                                     java.lang.String value)

Sets value for the custom parameter for the /n software Client component. See /n software ClientConfig guide for the keys. Sample value addClientConfigParam("AcceptAnyACSCert", "true")

Parameters:

key - the key of the custom parameter

value - the value to be assigned for the custom parameter

Returns:

itself for chained execution

build

public OppThreeDSConfig build()

Creates OppThreeDSConfig initialized with all set earlier parameters.

Returns:

initialized OppThreeDSConfig object