Package com.netcetera.threeds.sdk.api.configparameters

Class ConfigParameters

  • public class ConfigParameters
extends java.lang.Object
    The ConfigParameters class shall represent the configuration parameters that are required by the 3DS SDK for initialization. The following are characteristics of the configuration parameters:
    • All related configuration parameters can be placed in a single group. Note: A group is not pre-defined. The 3DS SDK implementer can define it to logically group configuration parameters.
    • Explicit parameter grouping is optional. If a group name is not provided, then parameters are grouped under a default group.
    • Duplicate parameter names cannot be used within a given group or the default group. The 3DS requester App creates a ConfigParameters object and sets the required parameter values.

    • Constructor Summary

      Constructors 
      Constructor Description
      ConfigParameters()
      Default constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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.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.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ConfigParameters

        public ConfigParameters()
        Default constructor.

    • 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 - String Group to which the configuration parameter is to be added.
        paramName - String Name of the configuration parameter.
        paramValue - String Value of the configuration parameter.
        Throws:
        InvalidInputException - if paramName is null or if the parameter in the group is duplicate.

      • 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 - String Group from which the configuration parameter’s value is to be returned.
        paramName - String Name of the configuration parameter.
        Returns:
        the value with the parameters that are found under the specified group name with a semicolon between them.
        Throws:
        InvalidInputException - 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.
        Parameters:
        group - String Group from which the configuration parameter is to be removed.
        paramName - String Name of the configuration parameter.
        Returns:
        value of the parameter that it removes.
        Throws:
        InvalidInputException - if paramName is null.