com.amazon.pay.api

Class PayConfiguration

java.lang.Object

com.amazon.pay.api.PayConfiguration

public class PayConfiguration
extends Object

Constructor Summary

Constructors

Constructor and Description
PayConfiguration()

Method Summary

Modifier and Type	Method and Description
Environment	getEnvironment()
int	getMaxRetries()
String	getOverrideServiceURL()
PrivateKey	getPrivateKey()
ProxySettings	getProxySettings()
String	getPublicKeyId()
Region	getRegion()
boolean	isUserAgentRedaction() Returns true if the merchant wants to set the Java and OS version segment in the User-Agent header to 'Redacted'.
PayConfiguration	setEnvironment(Environment environment)
PayConfiguration	setMaxRetries(int maxRetries)
PayConfiguration	setOverrideServiceURL(String overrideServiceURL)
PayConfiguration	setPrivateKey(char[] privateKey)
PayConfiguration	setPrivateKey(PrivateKey privateKey)
PayConfiguration	setPrivateKey(String privateKey) Deprecated. This method is deprecated, instead use setPrivateKey(char[] privateKey)
PayConfiguration	setProxySettings(ProxySettings proxySettings)
PayConfiguration	setPublicKeyId(String publicKeyId)
PayConfiguration	setRegion(Region region)
PayConfiguration	setUserAgentRedaction(boolean userAgentRedaction) Sets userAgentRedaction in PayConfiguration If this flag is set to true, the Java and OS version segment in the User-Agent header is 'Redacted'.

Methods inherited from class java.lang.Object

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

Constructor Detail

PayConfiguration

public PayConfiguration()

Method Detail

getRegion

public Region getRegion()

Returns:

Returns region code from PayConfiguration

setRegion

public PayConfiguration setRegion(Region region)

Parameters:

region - Identifies region associated with Amazon Pay API operations.

Returns:

the PayConfiguration object

getPublicKeyId

public String getPublicKeyId()

Returns:

returns the public key id from the PayConfiguration

setPublicKeyId

public PayConfiguration setPublicKeyId(String publicKeyId)

Parameters:

publicKeyId - The public key id of the merchant

Returns:

the PayConfiguration object

getPrivateKey

public PrivateKey getPrivateKey()

Returns:

returns the private key object from the PayConfiguration

setPrivateKey

@Deprecated
public PayConfiguration setPrivateKey(String privateKey)
                                           throws AmazonPayClientException

Deprecated. This method is deprecated, instead use setPrivateKey(char[] privateKey)

Parameters:

privateKey - The private key String

Returns:

the PayConfiguration object

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue

setPrivateKey

public PayConfiguration setPrivateKey(char[] privateKey)
                               throws AmazonPayClientException

Parameters:

privateKey - The private key char array

Returns:

the PayConfiguration object

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue

setPrivateKey

public PayConfiguration setPrivateKey(PrivateKey privateKey)

Parameters:

privateKey - the PrivateKey object

Returns:

the PayConfiguration object

getEnvironment

public Environment getEnvironment()

Returns:

returns the environment from the PayConfiguration

setEnvironment

public PayConfiguration setEnvironment(Environment environment)

Parameters:

environment - the environment,i.e, Sandbox or Live

Returns:

the PayConfiguration object

getMaxRetries

public int getMaxRetries()

Returns:

the maximum number of retries to be made

setMaxRetries

public PayConfiguration setMaxRetries(int maxRetries)

Parameters:

maxRetries - Sets the maximum number of retries to be made in case of internal server errors or throttling errors, in PayConfiguration

Returns:

the PayConfiguration object

isUserAgentRedaction

public boolean isUserAgentRedaction()

Returns true if the merchant wants to set the Java and OS version segment in the User-Agent header to 'Redacted'.

Returns:

boolean userAgentRedaction

setUserAgentRedaction

public PayConfiguration setUserAgentRedaction(boolean userAgentRedaction)

Sets userAgentRedaction in PayConfiguration If this flag is set to true, the Java and OS version segment in the User-Agent header is 'Redacted'.

Parameters:

userAgentRedaction - - argument that sets userAgentRedaction in PayConfiguration

Returns:

the PayConfiguration object

getOverrideServiceURL

public String getOverrideServiceURL()

Returns:

overrideServiceURL Returns overridden MWS Service URL in PayConfiguration

setOverrideServiceURL

public PayConfiguration setOverrideServiceURL(String overrideServiceURL)

Parameters:

overrideServiceURL - Sets CV2 Service URL override in PayConfiguration This should only be used if you need to programmatically override the default service endpoint provided by the SDK's endpointMappingsMap in com.amazon.pay.types.ServiceConstants.

Returns:

the PayConfiguration object

getProxySettings

public ProxySettings getProxySettings()

Returns:

proxySettings Returns Proxy Settings in PayConfiguration

setProxySettings

public PayConfiguration setProxySettings(ProxySettings proxySettings)

Parameters:

proxySettings - Sets the Proxy Settings in PayConfiguration This should only be used if you need to enable internet traffic flows through the proxy server

Returns:

the PayConfiguration object