com.gemalto.idp.mobile.otp.provisioning

Class EpsConfigurationBuilder

java.lang.Object

com.gemalto.idp.mobile.otp.provisioning.EpsConfigurationBuilder

public class EpsConfigurationBuilder
extends Object

Builder for provisioning configuration with EPS server

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
EpsConfigurationBuilder(SecureString registrationCode, URL url, MobileProvisioningProtocol provisioningProtocol, String rsaKeyId, byte[] rsaExponent, byte[] rsaModulus) Initialize builder with mandatory configurations.
EpsConfigurationBuilder(SecureString registrationCode, URL url, MobileProvisioningProtocol provisioningProtocol, String rsaKeyId, RSAPublicKey publicKey) Initialize builder with mandatory configurations.
EpsConfigurationBuilder(SecureString registrationCode, URL url, String domain, MobileProvisioningProtocol provisioningProtocol, String rsaKeyId, byte[] rsaExponent, byte[] rsaModulus) Initialize builder with mandatory configurations.
EpsConfigurationBuilder(SecureString registrationCode, URL url, String domain, MobileProvisioningProtocol provisioningProtocol, String rsaKeyId, RSAPublicKey publicKey) Initialize builder with mandatory configurations.

Method Summary

Modifier and Type	Method and Description
ProvisioningConfiguration	build()
EpsConfigurationBuilder	setProvisioningRequestHeaders(Map<String,SecureString> headers) Set customized header during provisioning request.
EpsConfigurationBuilder	setTlsConfiguration(TlsConfiguration tlsConfig) Set TLS configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

EpsConfigurationBuilder

public EpsConfigurationBuilder(SecureString registrationCode,
                               URL url,
                               String domain,
                               MobileProvisioningProtocol provisioningProtocol,
                               String rsaKeyId,
                               RSAPublicKey publicKey)

Initialize builder with mandatory configurations. Use this API for Mobile Provisioning Protocol version 5

Parameters:

registrationCode - Minimum registration code length is 2, and maximun registration code length is 14.

url - the URL of the Enrollment API endpoint (e.g. http(s)://:/EnrolmentServlet/GetAppCredentials for EPS 1.x, http(s)://:/provisioner/api/provisioning/pp for EPS 2.x or http(s)://:/provisioner/domains//provision for EPS 3.x with PPv5)

domain - This domain can only be use when the provisioningProtocol set to MobileProvisioningProtocol.PROVISIONING_PROTOCOL_V5 and above as well as when EPS that is being use is version 3 and above. Otherwise, this domain can be put null or empty.

provisioningProtocol - ProvisioningProtocol version

rsaKeyId - RSA publicKey ID

publicKey - RSA publicKey

Since:

5.0

EpsConfigurationBuilder

public EpsConfigurationBuilder(SecureString registrationCode,
                               URL url,
                               String domain,
                               MobileProvisioningProtocol provisioningProtocol,
                               String rsaKeyId,
                               byte[] rsaExponent,
                               byte[] rsaModulus)

Initialize builder with mandatory configurations. Use this API for Mobile Provisioning Protocol version 5

Parameters:

registrationCode - Minimum registration code length is 2, and maximun registration code length is 14.

url - the URL of the Enrollment API endpoint (e.g. http(s)://:/EnrolmentServlet/GetAppCredentials for EPS 1.x, http(s)://:/provisioner/api/provisioning/pp for EPS 2.x or http(s)://:/provisioner/domains//provision for EPS 3.x with PPv5)

domain - This domain can only be use when the provisioningProtocol set to MobileProvisioningProtocol.PROVISIONING_PROTOCOL_V5 and above as well as when EPS that is being use is version 3 and above. Otherwise, this domain can be put null or empty.

provisioningProtocol - ProvisioningProtocol version

rsaKeyId - RSA publicKey ID

rsaExponent - RSA publicKey exponent

rsaModulus - RSA publicKey modulus

Since:

5.0

EpsConfigurationBuilder

public EpsConfigurationBuilder(SecureString registrationCode,
                               URL url,
                               MobileProvisioningProtocol provisioningProtocol,
                               String rsaKeyId,
                               RSAPublicKey publicKey)

Initialize builder with mandatory configurations. This API does not support Mobile Provisioning Protocol version 5

Parameters:

registrationCode - Minimum registration code length is 2, and maximun registration code length is 14.

url - the URL of the Enrollment API endpoint (e.g. http(s)://:/EnrolmentServlet/GetAppCredentials for EPS 1.x, http(s)://:/provisioner/api/provisioning/pp for EPS 2.x)

provisioningProtocol - ProvisioningProtocol version

rsaKeyId - RSA publicKey ID

publicKey - RSA publicKey

EpsConfigurationBuilder

public EpsConfigurationBuilder(SecureString registrationCode,
                               URL url,
                               MobileProvisioningProtocol provisioningProtocol,
                               String rsaKeyId,
                               byte[] rsaExponent,
                               byte[] rsaModulus)

Initialize builder with mandatory configurations. This API does not support Mobile Provisioning Protocol version 5

Parameters:

registrationCode - Minimum registration code length is 2, and maximun registration code length is 14.

url - the URL of the Enrollment API endpoint (e.g. http(s)://:/EnrolmentServlet/GetAppCredentials for EPS 1.x, http(s)://:/provisioner/api/provisioning/pp for EPS 2.x)

provisioningProtocol - ProvisioningProtocol version

rsaKeyId - RSA publicKey ID

rsaExponent - RSA publicKey exponent

rsaModulus - RSA publicKey modulus

Method Detail

setProvisioningRequestHeaders

public EpsConfigurationBuilder setProvisioningRequestHeaders(Map<String,SecureString> headers)

Set customized header during provisioning request.

Parameters:

headers - custom headers.

Returns:

builder

setTlsConfiguration

public EpsConfigurationBuilder setTlsConfiguration(TlsConfiguration tlsConfig)

Set TLS configuration. Default TlsConfiguration does not allow Self-signed certificates, Hostname mismatch or Insecure connection (HTTP)

Parameters:

tlsConfig - TlsConfiguration

Returns:

builder

build

public ProvisioningConfiguration build()

Returns:

ProvisioningConfiguration object.