com.adyen.threeds2.parameters

Class ConfigParameters

java.lang.Object

com.adyen.threeds2.parameters.ConfigParameters

public final class ConfigParameters
extends java.lang.Object

This class represents the configuration parameters that are required by the 3DS SDK for initialization. The App should create a ConfigParameters object and sets the required parameter values.

Notice: The AdyenConfigParameters.Builder utility method can be used to easily create the configuration parameters required by the 3DS SDK.

Created by Ran Haveshush on 24/08/2018.

Constructor Summary

Constructors

Constructor and Description
ConfigParameters()

Method Summary

Modifier and Type	Method and Description
void	addParam(java.lang.String group, java.lang.String paramName, java.lang.String paramValue) Adds a configuration parameter either to the specified group or to the default group.
java.util.Map<java.lang.String,java.lang.String>	getGroup(java.lang.String group) Returns a group of configuration parameters value from the specified group.
java.lang.String	getParamValue(java.lang.String group, java.lang.String paramName) Returns a configuration parameter’s value either from the specified group or from the default group.
java.lang.String	removeParam(java.lang.String group, java.lang.String paramName) Removes a configuration parameter either from the specified group or from the default group. It returns the name of the parameter that it removes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigParameters

public ConfigParameters()

Method Detail

addParam

public void addParam(java.lang.String group,
                     java.lang.String paramName,
                     java.lang.String paramValue)
              throws InvalidInputException

Adds a configuration parameter either to the specified group or to the default group.

Parameters:

group - The group to which the configuration parameter is to be added.
Note: If a group is not specified, then the default group will be used.

paramName - The name of the configuration parameter.

paramValue - The value of the configuration parameter.

Throws:

InvalidInputException - This exception shall be thrown if paramName is null.

getParamValue

public java.lang.String getParamValue(java.lang.String group,
                                      java.lang.String paramName)
                               throws InvalidInputException

Returns a configuration parameter’s value either from the specified group or from the default group.

Parameters:

group - The group from which the configuration parameter’s value is to be returned.
Note: If the group is null, then the default group shall be used.

paramName - The name of the configuration parameter.

Returns:

The value of the specified configuration parameter.

Throws:

InvalidInputException - This exception shall be thrown if paramName is null.

removeParam

public java.lang.String removeParam(java.lang.String group,
                                    java.lang.String paramName)
                             throws InvalidInputException

Removes a configuration parameter either from the specified group or from the default group.
It returns the name of the parameter that it removes.

Parameters:

group - The group from which the configuration parameter is to be removed.
Note: If group is null, then the default group shall be used.

paramName - The name of the configuration parameter.

Returns:

The name of the parameter that it removes.

Throws:

InvalidInputException - This exception shall be thrown if paramName is null.

getGroup

public java.util.Map<java.lang.String,java.lang.String> getGroup(java.lang.String group)

Returns a group of configuration parameters value from the specified group.

Parameters:

group - The group from which the configuration parameters values is to be returned.
Note: If the group is null, then the default group will be used.

Returns:

The value of the specified configuration parameter.

Throws:

InvalidInputException - This exception shall be thrown if paramName is null.