Package com.adaptris.aws2

Class AWSConnection

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

com.adaptris.aws2.AWSConnection

All Implemented Interfaces:

AWSCredentialsProviderBuilder.BuilderConfig, AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent

public abstract class AWSConnection
extends AdaptrisConnectionImp
implements AWSCredentialsProviderBuilder.BuilderConfig

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisConnectionImp

log

Constructor Summary

Constructors

Constructor	Description
AWSConnection()

Method Summary

Modifier and Type	Method	Description
KeyValuePairSet	clientConfiguration()
AWSCredentialsProviderBuilder	credentialsProvider()
EndpointBuilder	endpointBuilder()	Returns something that can configure a normal AWS builder with a custom endpoint or a region...
KeyValuePairSet	getClientConfiguration()	Any specific client configuration.
AWSCredentialsProviderBuilder	getCredentials()	How to provide Credentials for AWS.
CustomEndpoint	getCustomEndpoint()	The custom endpoint for this connection.
String	getRegion()	Set the region for the client.
RetryPolicyFactory	getRetryPolicy()	The Retry policy.
RetryPolicyFactory	retryPolicy()
void	setClientConfiguration(KeyValuePairSet clientConfiguration)	Any specific client configuration.
void	setCredentials(AWSCredentialsProviderBuilder credentials)	How to provide Credentials for AWS.
void	setCustomEndpoint(CustomEndpoint customEndpoint)	The custom endpoint for this connection.
void	setRegion(String region)	Set the region for the client.
void	setRetryPolicy(RetryPolicyFactory retryPolicy)	The Retry policy.
<T extends AWSConnection> T	withClientConfiguration(KeyValuePairSet cfg)
<T extends AWSConnection> T	withCredentialsProviderBuilder(AWSCredentialsProviderBuilder builder)
<T extends AWSConnection> T	withCustomEndpoint(CustomEndpoint endpoint)
<T extends AWSConnection> T	withRegion(String s)
<T extends AWSConnection> T	withRetryPolicy(RetryPolicyFactory f)

Methods inherited from class com.adaptris.core.AdaptrisConnectionImp

addExceptionListener, addMessageConsumer, addMessageProducer, changeState, cloneForTesting, close, closeConnection, connectionErrorHandler, connectionStateHandler, getConnectionErrorHandler, getConnectionStateHandler, getRuntimeComponent, getUniqueId, getWorkersFirstOnShutdown, init, initConnection, prepare, prepareConnection, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setConnectionStateHandler, setRuntimeComponent, setUniqueId, setWorkersFirstOnShutdown, start, startConnection, stop, stopConnection, workersFirstOnShutdown

Methods inherited from class java.lang.Object

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

Constructor Details

AWSConnection

public AWSConnection()

Method Details

credentialsProvider

public AWSCredentialsProviderBuilder credentialsProvider()

clientConfiguration

public KeyValuePairSet clientConfiguration()

Specified by:

clientConfiguration in interface AWSCredentialsProviderBuilder.BuilderConfig

retryPolicy

public RetryPolicyFactory retryPolicy()

Specified by:

retryPolicy in interface AWSCredentialsProviderBuilder.BuilderConfig

withCustomEndpoint

public <T extends AWSConnection> T withCustomEndpoint(CustomEndpoint endpoint)

withCredentialsProviderBuilder

public <T extends AWSConnection> T withCredentialsProviderBuilder(AWSCredentialsProviderBuilder builder)

withClientConfiguration

public <T extends AWSConnection> T withClientConfiguration(KeyValuePairSet cfg)

withRetryPolicy

public <T extends AWSConnection> T withRetryPolicy(RetryPolicyFactory f)

withRegion

public <T extends AWSConnection> T withRegion(String s)

endpointBuilder

public EndpointBuilder endpointBuilder()

Returns something that can configure a normal AWS builder with a custom endpoint or a region...

Specified by:

endpointBuilder in interface AWSCredentialsProviderBuilder.BuilderConfig

getRegion

public String getRegion()

Set the region for the client.

If the region is not specified, then DefaultAwsRegionProviderChain is used to determine the region. You can always specify a region using the standard system property aws2.region or via environment variables.

setRegion

public void setRegion(String region)

Set the region for the client.

If the region is not specified, then DefaultAwsRegionProviderChain is used to determine the region. You can always specify a region using the standard system property aws2.region or via environment variables.

getCredentials

public AWSCredentialsProviderBuilder getCredentials()

How to provide Credentials for AWS.

If not specified, then a static credentials provider with a default provider chain will be used.

setCredentials

public void setCredentials(AWSCredentialsProviderBuilder credentials)

How to provide Credentials for AWS.

If not specified, then a static credentials provider with a default provider chain will be used.

getClientConfiguration

public KeyValuePairSet getClientConfiguration()

Any specific client configuration.

setClientConfiguration

public void setClientConfiguration(KeyValuePairSet clientConfiguration)

Any specific client configuration.

getRetryPolicy

public RetryPolicyFactory getRetryPolicy()

The Retry policy.

setRetryPolicy

public void setRetryPolicy(RetryPolicyFactory retryPolicy)

The Retry policy.

getCustomEndpoint

public CustomEndpoint getCustomEndpoint()

The custom endpoint for this connection.

Generally speaking, you don't need to configure this; use setRegion(String) instead. This is only required if you are planning to use a non-standard service endpoint such as localstack to provide AWS services. Explicitly configuring this means that your setRegion(String) will have no effect (i.e. AwsClientBuilder#setRegion(String) will never be invoked.

*

setCustomEndpoint

public void setCustomEndpoint(CustomEndpoint customEndpoint)

The custom endpoint for this connection.

Generally speaking, you don't need to configure this; use setRegion(String) instead. This is only required if you are planning to use a non-standard service endpoint such as localstack to provide AWS services. Explicitly configuring this means that your setRegion(String) will have no effect (i.e. AwsClientBuilder#setRegion(String) will never be invoked.

*