com.amazonservices.mws.client

Class MwsConnection

java.lang.Object

com.amazonservices.mws.client.MwsConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable

public class MwsConnection
extends Object
implements Cloneable, Closeable

An connection to a server to send requests to for processing.

Parameters that describe a MwsConnection are Server address and port, caller credentials and network connection configuration.

Simplest use case is:

 1) Create an MwsConnection instance.
 2) Configure the connection using setter methods.
 3) Create and initialize a Request object.
 4) Call response = connection.execute(requestObject)
 5) Use the response object or handle exceptions.
 6) Repeat steps 3-5 as necessary.
 7) Close the connection object.
 

Author:

mayerj

Constructor Summary

Constructors

Constructor and Description
MwsConnection() Create with defaults.
MwsConnection(URI endpoint, String applicationName, String applicationVersion, String awsAccessKeyId, String awsSecretKeyId) Create a connection.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends MwsObject> T	call(MwsRequestType type, MwsObject requestData) Call an operation and return the response data.
<T extends MwsObject> Future<T>	callAsync(MwsRequestType type, MwsObject requestData) Call a request async, return a future on the response data.
MwsConnection	clone() Clone this connection, creates an unconnected connection with all the same settings.
void	close()
String	getApplicationName() Get the client application name.
String	getApplicationVersion() Get the client application version.
String	getAwsAccessKeyId() Get the configured AWS access key id.
int	getConnectionTimeout() Get the connection timeout.
URI	getEndpoint() Gets end point property.
ExecutorService	getExecutorService() Get the executor service that will be used for async requests.
String	getLibraryVersion() Get the client library version.
int	getMaxAsyncQueueSize() Get the MaxAsyncQueueSize property.
int	getMaxAsyncThreads() Get MaxAsyncThreads property.
int	getMaxConnections() Gets MaxConnections property
int	getMaxErrorRetry() Gets MaxErrorRetry property
String	getProxyHost() Gets ProxyHost property
String	getProxyPassword() Gets ProxyPassword property
int	getProxyPort() Gets ProxyPort property.
String	getProxyUsername() Gets the proxy username property.
String	getRequestHeader(String name) Gets the currently set value of a request header
protected Map<String,String>	getRequestHeaders() Gets the currently set request headers
String	getSignatureMethod() Gets SignatureMethod property
String	getSignatureVersion() Gets SignatureVersion property
int	getSocketTimeout() Gets SocketTimeout property
String	getUserAgent() Gets UserAgent property
void	includeRequestHeader(String name, String value) Sets the value of a request header to be included on every request
MwsCall	newCall(String servicePath, String operationName) Create a new request.
void	setApplicationName(String name) Set the application name.
void	setApplicationVersion(String version) Set the application version.
void	setAwsAccessKeyId(String awsAccessKeyId) Set the access key id.
void	setAwsSecretKeyId(String awsSecretKeyId) Set the secret key.
void	setConnectionTimeout(int timeout) Set the connection timeout.
void	setEndpoint(URI endpoint) Sets service endpoint property.
void	setExecutorService(ExecutorService executor) Set the executor service to use for async requests.
void	setLibraryVersion(String libraryVersion) Set the client library version.
void	setMaxAsyncQueueSize(int maxAsyncQueueSize) Set MaxAsyncQueueSize property.
void	setMaxAsyncThreads(int maxAsyncThreads) Set MaxAsyncThreads property.
void	setMaxConnections(int maxConnections) Set MaxConnections property.
void	setMaxErrorRetry(int maxErrorRetry) Sets MaxErrorRetry property
void	setProxyHost(String proxyHost) Sets ProxyHost property
void	setProxyPassword(String proxyPassword) Sets ProxyPassword property
void	setProxyPort(int proxyPort) Sets ProxyPort property.
void	setProxyUsername(String proxyUsername) Sets ProxyUsername property.
void	setSignatureMethod(String signatureMethod) Sets SignatureMethod property
void	setSignatureVersion(String signatureVersion) Sets SignatureVersion property
void	setSocketTimeout(int socketTimeout) Sets SocketTimeout property
void	setUserAgent(String applicationName, String applicationVersion, String programmingLanguage, String... additionalNameValuePairs) Sets UserAgent property

Methods inherited from class java.lang.Object

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

Constructor Detail

MwsConnection

public MwsConnection()

Create with defaults.

MwsConnection

public MwsConnection(URI endpoint,
             String applicationName,
             String applicationVersion,
             String awsAccessKeyId,
             String awsSecretKeyId)

Create a connection.

Parameters:

endpoint - The endpoint URI.

applicationName - The calling applications name.

applicationVersion - The calling applications version.

awsAccessKeyId - The developer access key id.

awsSecretKeyId - The developers secret key id.

Method Detail

call

public <T extends MwsObject> T call(MwsRequestType type,
                           MwsObject requestData)

Call an operation and return the response data.

Parameters:

requestData - The request data.

Returns:

The response data.

callAsync

public <T extends MwsObject> Future<T> callAsync(MwsRequestType type,
                                        MwsObject requestData)

Call a request async, return a future on the response data.

Parameters:

requestData -

Returns:

A future on the response data.

clone

public MwsConnection clone()

Clone this connection, creates an unconnected connection with all the same settings. But in a state as if it were never used.

Overrides:

clone in class Object

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getApplicationName

public String getApplicationName()

Get the client application name.

Returns:

The client application name.

getApplicationVersion

public String getApplicationVersion()

Get the client application version.

Returns:

The client application version.

getAwsAccessKeyId

public String getAwsAccessKeyId()

Get the configured AWS access key id.

Returns:

The AWS access key id.

getConnectionTimeout

public int getConnectionTimeout()

Get the connection timeout.

Returns:

The connection timeout in milliseconds.

getEndpoint

public URI getEndpoint()

Gets end point property.

Returns:

Service end point URI

getExecutorService

public ExecutorService getExecutorService()

Get the executor service that will be used for async requests.

Returns:

The service.

getLibraryVersion

public String getLibraryVersion()

Get the client library version.

Returns:

The client library version.

getMaxAsyncQueueSize

public int getMaxAsyncQueueSize()

Get the MaxAsyncQueueSize property.

Returns:

MaxAsyncQueueSize.

getMaxAsyncThreads

public int getMaxAsyncThreads()

Get MaxAsyncThreads property.

Returns:

Max number of threads to be used for async operations

getMaxConnections

public int getMaxConnections()

Gets MaxConnections property

Returns:

Max number of http connections

getMaxErrorRetry

public int getMaxErrorRetry()

Gets MaxErrorRetry property

Returns:

Max number of retries on 500th errors

getProxyHost

public String getProxyHost()

Gets ProxyHost property

Returns:

Proxy Host for connection

getProxyPassword

public String getProxyPassword()

Gets ProxyPassword property

Returns:

Proxy Password

getProxyPort

public int getProxyPort()

Gets ProxyPort property.

Returns:

Proxy Port for connection.

getProxyUsername

public String getProxyUsername()

Gets the proxy username property.

Returns:

Proxy username.

getSignatureMethod

public String getSignatureMethod()

Gets SignatureMethod property

Returns:

Signature Method for signing requests

getSignatureVersion

public String getSignatureVersion()

Gets SignatureVersion property

Returns:

Signature Version for signing requests

getSocketTimeout

public int getSocketTimeout()

Gets SocketTimeout property

Returns:

Socket Timeout for waiting for data

getUserAgent

public String getUserAgent()

Gets UserAgent property

Returns:

User Agent String to use when sending request

getRequestHeaders

protected Map<String,String> getRequestHeaders()

Gets the currently set request headers

Returns:

Map of all set request headers

getRequestHeader

public String getRequestHeader(String name)

Gets the currently set value of a request header

Parameters:

name - the name of the header to get

Returns:

value of specified header, or null if not defined

newCall

public MwsCall newCall(String servicePath,
              String operationName)

Create a new request.

After first call to this method connection parameters can no longer be updated.

Parameters:

servicePath -

operationName -

Returns:

A new request.

setApplicationName

public void setApplicationName(String name)

Set the application name.

Parameters:

name -

setApplicationVersion

public void setApplicationVersion(String version)

Set the application version.

Parameters:

version -

setAwsAccessKeyId

public void setAwsAccessKeyId(String awsAccessKeyId)

Set the access key id.

Parameters:

awsAccessKeyId -

setAwsSecretKeyId

public void setAwsSecretKeyId(String awsSecretKeyId)

Set the secret key.

Parameters:

awsSecretKeyId -

setConnectionTimeout

public void setConnectionTimeout(int timeout)

Set the connection timeout.

Parameters:

timeout - The connection timeout in milliseconds;

setEndpoint

public void setEndpoint(URI endpoint)

Sets service endpoint property.

Parameters:

endpoint - The service end point URI.

setExecutorService

public void setExecutorService(ExecutorService executor)

Set the executor service to use for async requests.

Parameters:

executor -

setLibraryVersion

public void setLibraryVersion(String libraryVersion)

Set the client library version.

Used to create default user agent string.

Parameters:

libraryVersion -

setMaxAsyncQueueSize

public void setMaxAsyncQueueSize(int maxAsyncQueueSize)

Set MaxAsyncQueueSize property.

When the async queue is full further async calls will execute on the calling thread. see setMaxAsyncThreads(int)

Parameters:

maxAsyncQueueSize -

setMaxAsyncThreads

public void setMaxAsyncThreads(int maxAsyncThreads)

Set MaxAsyncThreads property.

This is the maximum number of threads to spawn for async operations.

When Max number of threads is reached, requests will be stored in the queue. When queue becomes full, request will be executed on the calling thread.

Only used to configure default shared executor service when it is first created. If caller supplies an executor service for a connection or the shared executor already exists then this parameter is ignored.

Parameters:

maxAsyncThreads -

setMaxConnections

public void setMaxConnections(int maxConnections)

Set MaxConnections property.

All MwsConnection instances share the same connection pool. Only the first MwsConnection configures the pool size.

Parameters:

maxConnections - Max number of http connections

setMaxErrorRetry

public void setMaxErrorRetry(int maxErrorRetry)

Sets MaxErrorRetry property

Parameters:

maxErrorRetry - Max number of retries on 50x errors

setProxyHost

public void setProxyHost(String proxyHost)

Sets ProxyHost property

Parameters:

proxyHost - Proxy Host for connection

setProxyPassword

public void setProxyPassword(String proxyPassword)

Sets ProxyPassword property

Parameters:

proxyPassword - Proxy Password for connection

setProxyPort

public void setProxyPort(int proxyPort)

Sets ProxyPort property.

Parameters:

proxyPort - Proxy Port for connection.

setProxyUsername

public void setProxyUsername(String proxyUsername)

Sets ProxyUsername property.

Parameters:

proxyUsername - Proxy username for connection.

setSignatureMethod

public void setSignatureMethod(String signatureMethod)

Sets SignatureMethod property

Parameters:

signatureMethod - Signature Method for signing requests

setSignatureVersion

public void setSignatureVersion(String signatureVersion)

Sets SignatureVersion property

Parameters:

signatureVersion - Signature Version for signing requests

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

Sets SocketTimeout property

Parameters:

socketTimeout - Timeout for waiting for data

setUserAgent

public void setUserAgent(String applicationName,
                String applicationVersion,
                String programmingLanguage,
                String... additionalNameValuePairs)

Sets UserAgent property

Parameters:

applicationName -

applicationVersion -

programmingLanguage -

additionalNameValuePairs -

includeRequestHeader

public void includeRequestHeader(String name,
                        String value)

Sets the value of a request header to be included on every request

Parameters:

name - the name of the header to set

value - value to send with header