-
- All Implemented Interfaces:
-
android.os.Parcelable
public class ThreeDSConfig implements Parcelable
Class that contains all possible configurations to be applied at com.nsoftware.ipworks3ds.sdk.ThreeDS2Service initialization phase.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
ThreeDSConfig.Builder
Class to build
OppThreeDSConfig
class with customized parameters.
-
Field Summary
Fields Modifier and Type Field Description private final EnumSet<ChallengeUiType>
challengeUiTypes
private final int
sdkMaxTimeout
private final Map<String, String>
clientConfigParams
private final UiCustomization
uiCustomization
private final String
locale
private final Array<String>
deviceParameterBlacklist
private final String
appSignature
private final Array<String>
trustedAppStores
private final Array<String>
maliciousApps
private final boolean
isThreeDSRequestorAppUrlUsed
private final boolean
isBrowserDataRequired
public final static Parcelable.Creator<ThreeDSConfig>
CREATOR
-
Constructor Summary
Constructors Constructor Description ThreeDSConfig(ThreeDSConfig.Builder builder)
-
Method Summary
Modifier and Type Method Description EnumSet<ChallengeUiType>
getChallengeUiTypes()
Returns supported UI types for displaying challenge screens. int
getSdkMaxTimeout()
Returns maximum amount of time (in minutes) for all exchanges for the 3-D Secure authentication. Map<String, String>
getClientConfigParams()
The map of all client config params which were set up using addClientConfigParam method. UiCustomization
getUiCustomization()
Returns UI configuration information that is used to specify the UI layout and theme of the challenge screens, for example, font style and font size. String
getLocale()
Returns string that represents the locale for the app's user interface (for example, "en-US"). Array<String>
getDeviceParameterBlacklist()
Returns the list of device parameters that should NOT be collected for the device. String
getAppSignature()
Returns app signature for the merchant app to be verified by the SDK. Array<String>
getTrustedAppStores()
Returns additional list of trusted applications, that would not cause security warnings (SW02). Array<String>
getMaliciousApps()
Returns list of package names for the apps that should be recognized as malicious. boolean
isThreeDSRequestorAppUrlUsed()
Indicates if threeDSRequestorAppUrl should be used or not. boolean
isBrowserDataRequired()
Indicates if browser data is required. String
getClientConfigParam(@NonNull() String key)
Returns string value of the custom parameter for the /n software Client
component.String
toString()
boolean
equals(@Nullable() Object o)
int
hashCode()
int
describeContents()
void
writeToParcel(@NonNull() Parcel dest, int flags)
-
-
Constructor Detail
-
ThreeDSConfig
ThreeDSConfig(ThreeDSConfig.Builder builder)
-
-
Method Detail
-
getChallengeUiTypes
@NonNull() EnumSet<ChallengeUiType> getChallengeUiTypes()
Returns 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.
-
getSdkMaxTimeout
int getSdkMaxTimeout()
Returns maximum amount of time (in minutes) for all exchanges for the 3-D Secure authentication. Default value is 5 minutes.
-
getClientConfigParams
@NonNull() Map<String, String> getClientConfigParams()
The map of all client config params which were set up using addClientConfigParam method.
-
getUiCustomization
@Nullable() UiCustomization getUiCustomization()
Returns UI configuration information that is used to specify the UI layout and theme of the challenge screens, for example, font style and font size.
-
getLocale
@Nullable() String getLocale()
Returns string that represents the locale for the app's user interface (for example, "en-US").
-
getDeviceParameterBlacklist
@Nullable() Array<String> getDeviceParameterBlacklist()
Returns 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"]
.
-
getAppSignature
@Nullable() String getAppSignature()
Returns app signature for the merchant app to be verified by the SDK. This value should be set by the merchant and match to the app signature, otherwise 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.
-
getTrustedAppStores
@Nullable() Array<String> getTrustedAppStores()
Returns 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.
-
getMaliciousApps
@Nullable() Array<String> getMaliciousApps()
Returns 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 getThreeDS2Warnings 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
-
isThreeDSRequestorAppUrlUsed
boolean isThreeDSRequestorAppUrlUsed()
Indicates if threeDSRequestorAppUrl should be used or not.
-
isBrowserDataRequired
boolean isBrowserDataRequired()
Indicates if browser data is required.
-
getClientConfigParam
@Nullable() String getClientConfigParam(@NonNull() String key)
Returns string value of the custom parameter for the /n software
Client
component. See /n software ClientConfig guide for the keys. Sample valuegetClientConfigParam("AcceptAnyACSCert")
.- Parameters:
key
- the key for the custom parameter
-
hashCode
int hashCode()
-
describeContents
int describeContents()
-
writeToParcel
void writeToParcel(@NonNull() Parcel dest, int flags)
-
-
-
-