com.worldline.connect.sdk.java

Class CommunicatorConfiguration

java.lang.Object

com.worldline.connect.sdk.java.CommunicatorConfiguration

public class CommunicatorConfiguration
extends Object

Configuration for the communicator.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	DEFAULT_HTTPS_PROTOCOLS The default HTTPS protocols.
static int	DEFAULT_MAX_CONNECTIONS The default number of maximum connections.

Constructor Summary

Constructors

Constructor and Description
CommunicatorConfiguration()
CommunicatorConfiguration(Properties properties)

Method Summary

Modifier and Type	Method and Description
URI	getApiEndpoint() Returns the Worldline Global Collect platform API endpoint URI.
String	getApiKeyId() Returns an identifier for the secret API key.
String	getAuthorizationId() Returns an id used for authorization.
String	getAuthorizationSecret() Returns a secret used for authorization.
AuthorizationType	getAuthorizationType()
int	getConnectTimeout()
Set<String>	getHttpsProtocols()
String	getIntegrator()
int	getMaxConnections()
ProxyConfiguration	getProxyConfiguration()
String	getSecretApiKey() Returns a shared secret.
ShoppingCartExtension	getShoppingCartExtension()
int	getSocketTimeout()
boolean	isConnectionReuse()
void	setApiEndpoint(URI apiEndpoint)
void	setApiKeyId(String apiKeyId) This method is an alias for setAuthorizationId(String).
void	setAuthorizationId(String authorizationId)
void	setAuthorizationSecret(String authorizationSecret)
void	setAuthorizationType(AuthorizationType authorizationType)
void	setConnectionReuse(boolean connectionReuse)
void	setConnectTimeout(int connectTimeout)
void	setHttpsProtocols(Set<String> httpsProtocols)
void	setIntegrator(String integrator)
void	setMaxConnections(int maxConnections)
void	setProxyConfiguration(ProxyConfiguration proxyConfiguration)
void	setSecretApiKey(String secretApiKey) This method is an alias for setAuthorizationSecret(String).
void	setShoppingCartExtension(ShoppingCartExtension shoppingCartExtension)
void	setSocketTimeout(int socketTimeout)
CommunicatorConfiguration	withApiEndpoint(URI apiEndpoint)
CommunicatorConfiguration	withApiKeyId(String apiKeyId) This method is an alias for withAuthorizationId(String).
CommunicatorConfiguration	withAuthorizationId(String authorizationId)
CommunicatorConfiguration	withAuthorizationSecret(String authorizationSecret)
CommunicatorConfiguration	withAuthorizationType(AuthorizationType authorizationType)
CommunicatorConfiguration	withConnectionReuse(boolean connectionReuse)
CommunicatorConfiguration	withConnectTimeout(int connectTimeout)
CommunicatorConfiguration	withHttpsProtocols(Collection<String> httpsProtocols)
CommunicatorConfiguration	withHttpsProtocols(String... httpsProtocols)
CommunicatorConfiguration	withIntegrator(String integrator)
CommunicatorConfiguration	withMaxConnections(int maxConnections)
CommunicatorConfiguration	withProxyConfiguration(ProxyConfiguration proxyConfiguration)
CommunicatorConfiguration	withSecretApiKey(String secretApiKey) This method is an alias for withAuthorizationSecret(String).
CommunicatorConfiguration	withShoppingCartExtension(ShoppingCartExtension shoppingCartExtension)
CommunicatorConfiguration	withSocketTimeout(int socketTimeout)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_CONNECTIONS

public static final int DEFAULT_MAX_CONNECTIONS

The default number of maximum connections.

See Also:

Constant Field Values

DEFAULT_HTTPS_PROTOCOLS

public static final Set<String> DEFAULT_HTTPS_PROTOCOLS

The default HTTPS protocols.

Constructor Detail

CommunicatorConfiguration

public CommunicatorConfiguration()

CommunicatorConfiguration

public CommunicatorConfiguration(Properties properties)

Method Detail

getApiEndpoint

public URI getApiEndpoint()

Returns the Worldline Global Collect platform API endpoint URI.

setApiEndpoint

public void setApiEndpoint(URI apiEndpoint)

withApiEndpoint

public CommunicatorConfiguration withApiEndpoint(URI apiEndpoint)

getAuthorizationId

public String getAuthorizationId()

Returns an id used for authorization. The meaning of this id is different for each authorization type. For instance, for AuthorizationType.V1HMAC this is the identifier for the secret API key.

setAuthorizationId

public void setAuthorizationId(String authorizationId)

withAuthorizationId

public CommunicatorConfiguration withAuthorizationId(String authorizationId)

getAuthorizationSecret

public String getAuthorizationSecret()

Returns a secret used for authorization. The meaning of this secret is different for each authorization type. For instance, for AuthorizationType.V1HMAC this is the secret API key.

setAuthorizationSecret

public void setAuthorizationSecret(String authorizationSecret)

withAuthorizationSecret

public CommunicatorConfiguration withAuthorizationSecret(String authorizationSecret)

getApiKeyId

public String getApiKeyId()

Returns an identifier for the secret API key. The apiKeyId can be retrieved from the Configuration Center. This identifier is visible in the HTTP request and is also used to identify the correct account.

This method is an alias for getAuthorizationId().

setApiKeyId

public void setApiKeyId(String apiKeyId)

This method is an alias for setAuthorizationId(String).

withApiKeyId

public CommunicatorConfiguration withApiKeyId(String apiKeyId)

This method is an alias for withAuthorizationId(String).

getSecretApiKey

public String getSecretApiKey()

Returns a shared secret. The shared secret can be retrieved from the Configuration Center. An apiKeyId and secretApiKey always go hand-in-hand, the difference is that secretApiKey is never visible in the HTTP request. This secret is used as input for the HMAC algorithm.

This method is an alias for getAuthorizationSecret().

setSecretApiKey

public void setSecretApiKey(String secretApiKey)

This method is an alias for setAuthorizationSecret(String).

withSecretApiKey

public CommunicatorConfiguration withSecretApiKey(String secretApiKey)

This method is an alias for withAuthorizationSecret(String).

getAuthorizationType

public AuthorizationType getAuthorizationType()

setAuthorizationType

public void setAuthorizationType(AuthorizationType authorizationType)

withAuthorizationType

public CommunicatorConfiguration withAuthorizationType(AuthorizationType authorizationType)

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

withConnectTimeout

public CommunicatorConfiguration withConnectTimeout(int connectTimeout)

getSocketTimeout

public int getSocketTimeout()

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

withSocketTimeout

public CommunicatorConfiguration withSocketTimeout(int socketTimeout)

getMaxConnections

public int getMaxConnections()

setMaxConnections

public void setMaxConnections(int maxConnections)

withMaxConnections

public CommunicatorConfiguration withMaxConnections(int maxConnections)

isConnectionReuse

public boolean isConnectionReuse()

setConnectionReuse

public void setConnectionReuse(boolean connectionReuse)

withConnectionReuse

public CommunicatorConfiguration withConnectionReuse(boolean connectionReuse)

getProxyConfiguration

public ProxyConfiguration getProxyConfiguration()

setProxyConfiguration

public void setProxyConfiguration(ProxyConfiguration proxyConfiguration)

withProxyConfiguration

public CommunicatorConfiguration withProxyConfiguration(ProxyConfiguration proxyConfiguration)

getHttpsProtocols

public Set<String> getHttpsProtocols()

setHttpsProtocols

public void setHttpsProtocols(Set<String> httpsProtocols)

withHttpsProtocols

public CommunicatorConfiguration withHttpsProtocols(Collection<String> httpsProtocols)

withHttpsProtocols

public CommunicatorConfiguration withHttpsProtocols(String... httpsProtocols)

getIntegrator

public String getIntegrator()

setIntegrator

public void setIntegrator(String integrator)

withIntegrator

public CommunicatorConfiguration withIntegrator(String integrator)

getShoppingCartExtension

public ShoppingCartExtension getShoppingCartExtension()

setShoppingCartExtension

public void setShoppingCartExtension(ShoppingCartExtension shoppingCartExtension)

withShoppingCartExtension

public CommunicatorConfiguration withShoppingCartExtension(ShoppingCartExtension shoppingCartExtension)