com.onlinepayments

Class CommunicatorConfiguration

java.lang.Object

com.onlinepayments.CommunicatorConfiguration

public class CommunicatorConfiguration
extends Object

Configuration for the communicator.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CommunicatorConfiguration()
CommunicatorConfiguration(Properties properties)

Method Summary

Modifier and Type	Method and Description
URI	getApiEndpoint() Returns the Online Payments platform API endpoint URI.
String	getApiKeyId() An identifier for the secret API key.
AuthorizationType	getAuthorizationType()
int	getConnectionRequestTimeout()
int	getConnectTimeout()
Set<String>	getHttpsProtocols()
String	getIntegrator()
int	getMaxConnections()
ProxyConfiguration	getProxyConfiguration()
String	getSecretApiKey() A shared secret.
ShoppingCartExtension	getShoppingCartExtension()
int	getSocketTimeout()
void	setApiEndpoint(URI apiEndpoint)
void	setApiKeyId(String apiKeyId)
void	setAuthorizationType(AuthorizationType authorizationType)
void	setConnectionRequestTimeout(int connectionRequestTimeout)
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)
void	setShoppingCartExtension(ShoppingCartExtension shoppingCartExtension)
void	setSocketTimeout(int socketTimeout)
CommunicatorConfiguration	withApiEndpoint(URI apiEndpoint)
CommunicatorConfiguration	withApiKeyId(String apiKeyId)
CommunicatorConfiguration	withAuthorizationType(AuthorizationType authorizationType)
CommunicatorConfiguration	withConnectionRequestTimeout(int connectionRequestTimeout)
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)
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_CONNECTION_REQUEST_TIMEOUT

public static final int DEFAULT_CONNECTION_REQUEST_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT

public static final int DEFAULT_SOCKET_TIMEOUT

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 Online Payments platform API endpoint URI.

setApiEndpoint

public void setApiEndpoint(URI apiEndpoint)

withApiEndpoint

public CommunicatorConfiguration withApiEndpoint(URI apiEndpoint)

getApiKeyId

public String getApiKeyId()

An identifier for the secret API key. This identifier is visible in the HTTP request and is also used to identify the correct account.

setApiKeyId

public void setApiKeyId(String apiKeyId)

withApiKeyId

public CommunicatorConfiguration withApiKeyId(String apiKeyId)

getSecretApiKey

public String getSecretApiKey()

A shared secret. 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.

setSecretApiKey

public void setSecretApiKey(String secretApiKey)

withSecretApiKey

public CommunicatorConfiguration withSecretApiKey(String secretApiKey)

getAuthorizationType

public AuthorizationType getAuthorizationType()

setAuthorizationType

public void setAuthorizationType(AuthorizationType authorizationType)

withAuthorizationType

public CommunicatorConfiguration withAuthorizationType(AuthorizationType authorizationType)

getConnectionRequestTimeout

public int getConnectionRequestTimeout()

setConnectionRequestTimeout

public void setConnectionRequestTimeout(int connectionRequestTimeout)

withConnectionRequestTimeout

public CommunicatorConfiguration withConnectionRequestTimeout(int connectionRequestTimeout)

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)

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)