Package com.adaptris.aws.kms

Class AWSKMSConnection

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

com.adaptris.aws.AWSConnection

com.adaptris.aws.kms.AWSKMSConnection

All Implemented Interfaces:

com.adaptris.aws.AWSCredentialsProviderBuilder.BuilderConfig, ClientWrapper<com.amazonaws.services.kms.AWSKMSClient>, AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent

@ComponentProfile(summary="Connection for supporting connectivity to Amazon KMS",
                  tag="connections,amazon,aws,kms",
                  since="3.10.1")
public class AWSKMSConnection
extends com.adaptris.aws.AWSConnection
implements ClientWrapper<com.amazonaws.services.kms.AWSKMSClient>

AdaptrisConnection implementation for Amazon KMS

This class directly exposes almost all the getter and setters that are available in ClientConfiguration via the AWSConnection.getClientConfiguration() property for maximum flexibility in configuration.

The key from the client-configuration element should match the name of the underlying ClientConfiguration property; so if you wanted to control the user-agent you would do :

 
   <client-configuration>
     <key-value-pair>
        <key>UserAgent</key>
        <value>My User Agent</value>
     </key-value-pair>
   </client-configuration>
 
 

In the adapter configuration file this class is aliased as aws-kms-connection which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisConnectionImp

log

Constructor Summary

Constructors

Constructor	Description
AWSKMSConnection()

Method Summary

Modifier and Type	Method	Description
com.amazonaws.services.kms.AWSKMSClient	awsClient()
protected void	closeConnection()
protected com.amazonaws.services.kms.AWSKMSClientBuilder	createBuilder()
protected void	initConnection()
protected void	prepareConnection()
protected void	startConnection()
protected void	stopConnection()

Methods inherited from class com.adaptris.aws.AWSConnection

clientConfiguration, credentialsProvider, endpointBuilder, getClientConfiguration, getCredentials, getCustomEndpoint, getRegion, getRetryPolicy, retryPolicy, setClientConfiguration, setCredentials, setCustomEndpoint, setRegion, setRetryPolicy, withClientConfiguration, withCredentialsProviderBuilder, withCustomEndpoint, withRegion, withRetryPolicy

Methods inherited from class com.adaptris.core.AdaptrisConnectionImp

addExceptionListener, addMessageConsumer, addMessageProducer, changeState, cloneForTesting, close, connectionErrorHandler, getConnectionErrorHandler, getUniqueId, getWorkersFirstOnShutdown, init, prepare, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setUniqueId, setWorkersFirstOnShutdown, start, stop, workersFirstOnShutdown

Methods inherited from class java.lang.Object

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

Constructor Details

AWSKMSConnection

public AWSKMSConnection()

Method Details

prepareConnection

protected void prepareConnection()
                          throws CoreException

Specified by:

prepareConnection in class AdaptrisConnectionImp

Throws:

CoreException

initConnection

protected void initConnection()
                       throws CoreException

Specified by:

initConnection in class AdaptrisConnectionImp

Throws:

CoreException

startConnection

protected void startConnection()
                        throws CoreException

Specified by:

startConnection in class AdaptrisConnectionImp

Throws:

CoreException

stopConnection

protected void stopConnection()

Specified by:

stopConnection in class AdaptrisConnectionImp

closeConnection

protected void closeConnection()

Specified by:

closeConnection in class AdaptrisConnectionImp

createBuilder

protected com.amazonaws.services.kms.AWSKMSClientBuilder createBuilder()
                                                                throws CoreException

Throws:

CoreException

awsClient

public com.amazonaws.services.kms.AWSKMSClient awsClient()
                                                  throws Exception

Specified by:

awsClient in interface ClientWrapper<com.amazonaws.services.kms.AWSKMSClient>

Throws:

Exception