org.mule.modules.aws.commons

Class ClientBuilder<T extends com.amazonaws.AmazonWebServiceClient>

java.lang.Object

org.mule.modules.aws.commons.ClientBuilder<T>

Direct Known Subclasses:

S3ClientBuilder

public abstract class ClientBuilder<T extends com.amazonaws.AmazonWebServiceClient>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	accessKey
protected static int	AWS_CLIENT_MAX_ERROR_RETRY
protected com.amazonaws.client.builder.AwsSyncClientBuilder	awsSyncClientBuilder
protected String	connectionId
protected com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration	endpointConfiguration
protected String	roleARN
protected String	secretKey
protected String	sessionToken
protected boolean	tryDefaultAWSCredentialsProviderChain

Constructor Summary

Constructors

Constructor and Description
ClientBuilder()

Method Summary

Modifier and Type	Method and Description
T	buildClient(String region)
abstract void	connect()
protected com.amazonaws.ClientConfiguration	createClientConfiguration() Creates the configuration for the AWSClient
protected void	customSetupClientBuilder()
abstract void	disconnect()
String	getAccessKey()
String	getConfigRegion()
String	getConnectionId()
Integer	getConnectionTimeout()
protected abstract String	getDefaultRegion()
com.amazonaws.Protocol	getProtocol()
String	getProxyDomain()
String	getProxyHost()
String	getProxyPassword()
Integer	getProxyPort()
String	getProxyUsername()
String	getProxyWorkstation()
String	getRoleARN()
String	getSecretKey()
String	getSessionToken()
Integer	getSocketTimeout()
T	getSyncClient()
protected abstract com.amazonaws.client.builder.AwsSyncClientBuilder	getSyncClientBuilder()
void	instantiateClient(String region)
boolean	isTryDefaultAWSCredentialsProviderChain()
void	setAccessKey(String accessKey)
void	setConfigRegion(String configRegion)
void	setConnectionTimeout(Integer connectionTimeout)
protected abstract void	setCustomClientConfiguration(com.amazonaws.ClientConfiguration clientConfig) Sets the custom configuration fields for every different AWSClient
void	setDefaultRegion(String defaultRegion)
void	setProtocol(com.amazonaws.Protocol protocol)
void	setProxyDomain(String proxyDomain)
void	setProxyHost(String proxyHost)
void	setProxyPassword(String proxyPassword)
void	setProxyPort(Integer proxyPort)
void	setProxyUsername(String proxyUsername)
void	setProxyWorkstation(String proxyWorkstation)
void	setRoleARN(String roleARN)
void	setSecretKey(String secretKey)
void	setSessionToken(String sessionToken)
void	setSocketTimeout(Integer socketTimeout)
void	setSyncClient(T syncClient)
void	setTryDefaultAWSCredentialsProviderChain(boolean tryDefaultAWSCredentialsProviderChain)
void	setupClientBuilder()
abstract void	testConnect()

Methods inherited from class java.lang.Object

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

Field Detail

AWS_CLIENT_MAX_ERROR_RETRY

protected static final int AWS_CLIENT_MAX_ERROR_RETRY

See Also:

Constant Field Values

awsSyncClientBuilder

protected com.amazonaws.client.builder.AwsSyncClientBuilder awsSyncClientBuilder

endpointConfiguration

protected com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration endpointConfiguration

accessKey

protected String accessKey

secretKey

protected String secretKey

roleARN

protected String roleARN

sessionToken

protected String sessionToken

tryDefaultAWSCredentialsProviderChain

protected boolean tryDefaultAWSCredentialsProviderChain

connectionId

protected String connectionId

Constructor Detail

ClientBuilder

public ClientBuilder()

Method Detail

getConnectionId

public String getConnectionId()

setSyncClient

public void setSyncClient(T syncClient)

getSyncClient

public T getSyncClient()

setupClientBuilder

public void setupClientBuilder()

customSetupClientBuilder

protected void customSetupClientBuilder()

instantiateClient

public void instantiateClient(String region)

buildClient

public T buildClient(String region)

getAccessKey

public String getAccessKey()

setAccessKey

public void setAccessKey(String accessKey)

getSecretKey

public String getSecretKey()

setSecretKey

public void setSecretKey(String secretKey)

getRoleARN

public String getRoleARN()

setRoleARN

public void setRoleARN(String roleARN)

getSessionToken

public String getSessionToken()

setSessionToken

public void setSessionToken(String sessionToken)

isTryDefaultAWSCredentialsProviderChain

public boolean isTryDefaultAWSCredentialsProviderChain()

setTryDefaultAWSCredentialsProviderChain

public void setTryDefaultAWSCredentialsProviderChain(boolean tryDefaultAWSCredentialsProviderChain)

getDefaultRegion

protected abstract String getDefaultRegion()

setDefaultRegion

public void setDefaultRegion(String defaultRegion)

getConfigRegion

public String getConfigRegion()

setConfigRegion

public void setConfigRegion(String configRegion)

getSyncClientBuilder

protected abstract com.amazonaws.client.builder.AwsSyncClientBuilder getSyncClientBuilder()

connect

public abstract void connect()
                      throws org.mule.api.ConnectionException

Throws:

org.mule.api.ConnectionException

testConnect

public abstract void testConnect()
                          throws org.mule.api.ConnectionException

Throws:

org.mule.api.ConnectionException

disconnect

public abstract void disconnect()

createClientConfiguration

protected com.amazonaws.ClientConfiguration createClientConfiguration()

Creates the configuration for the AWSClient

Returns:

The configuration for the AWSClient

setCustomClientConfiguration

protected abstract void setCustomClientConfiguration(com.amazonaws.ClientConfiguration clientConfig)

Sets the custom configuration fields for every different AWSClient

getProtocol

public com.amazonaws.Protocol getProtocol()

setProtocol

public void setProtocol(com.amazonaws.Protocol protocol)

getProxyHost

public String getProxyHost()

setProxyHost

public void setProxyHost(String proxyHost)

getProxyPort

public Integer getProxyPort()

setProxyPort

public void setProxyPort(Integer proxyPort)

getProxyUsername

public String getProxyUsername()

setProxyUsername

public void setProxyUsername(String proxyUsername)

getProxyPassword

public String getProxyPassword()

setProxyPassword

public void setProxyPassword(String proxyPassword)

getProxyDomain

public String getProxyDomain()

setProxyDomain

public void setProxyDomain(String proxyDomain)

getProxyWorkstation

public String getProxyWorkstation()

setProxyWorkstation

public void setProxyWorkstation(String proxyWorkstation)

getSocketTimeout

public Integer getSocketTimeout()

setSocketTimeout

public void setSocketTimeout(Integer socketTimeout)

getConnectionTimeout

public Integer getConnectionTimeout()

setConnectionTimeout

public void setConnectionTimeout(Integer connectionTimeout)