org.mule.modules.aws

Class BasicConfig<T extends com.amazonaws.AmazonWebServiceClient>

java.lang.Object

org.mule.modules.aws.GenericConfig<T>

org.mule.modules.aws.BasicConfig<T>

public abstract class BasicConfig<T extends com.amazonaws.AmazonWebServiceClient>
extends GenericConfig<T>

Field Summary

Fields inherited from class org.mule.modules.aws.GenericConfig

clientBuilder, clientConfig, clientCredentials, regions

Constructor Summary

Constructors

Constructor and Description
BasicConfig()

Method Summary

Modifier and Type	Method and Description
void	connect(String accessKey, String secretKey, boolean tryDefaultAWSCredentialsProviderChain) Login to Amazon S3
protected void	createClientCredentials(String accessKey, String secretKey, boolean tryDefaultAWSCredentialsProviderChain) Creates AWS basic credentials for the client
protected abstract void	performClientConnectionTest() Executes a requests in AWS server to check if the client configuration is correct.
void	testConnect(String accessKey, String secretKey, boolean tryDefaultAWSCredentialsProviderChain) Test Connectivity to Amazon S3.

Methods inherited from class org.mule.modules.aws.GenericConfig

connectionId, createClient, createClientBuilder, createClientConfiguration, disconnect, getClient, getConnectionTimeout, getMaxConnections, getProtocol, getProxyDomain, getProxyHost, getProxyPassword, getProxyPort, getProxyUsername, getProxyWorkstation, getRegions, getSocketTimeout, isConnected, setClient, setClientBuilder, setConnectionTimeout, setCustomClientConfiguration, setMaxConnections, setProtocol, setProxyDomain, setProxyHost, setProxyPassword, setProxyPort, setProxyUsername, setProxyWorkstation, setRegion, setSocketTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicConfig

public BasicConfig()

Method Detail

connect

@Connect
public void connect(@ConnectionKey
                             String accessKey,
                             String secretKey,
                             @Optional
                             boolean tryDefaultAWSCredentialsProviderChain)
                      throws org.mule.api.ConnectionException

Login to Amazon S3

Parameters:

accessKey - The access key provided by Amazon, needed for non anonymous operations

secretKey - The secrete key provided by Amazon, needed for non anonymous operations

tryDefaultAWSCredentialsProviderChain - Set it to true to try first to obtain credentials from AWS environment. See: http://docs.aws.amazon.com/java-sdk/latest/developer-guide/credentials.html#using-the-default-credential-provider-chain

Throws:

org.mule.api.ConnectionException

testConnect

@TestConnectivity
public void testConnect(@ConnectionKey
                                          String accessKey,
                                          String secretKey,
                                          @Optional
                                          boolean tryDefaultAWSCredentialsProviderChain)
                                   throws org.mule.api.ConnectionException

Test Connectivity to Amazon S3. Access to operations on Amazon S3 is controlled through policies for that user. It may not always be possible to validate the credentials before the exact operation for which the user has access is done. This can vary for instance on the bucket name and other parameters. Hence the test connection may fail in case the credentials have a restricted policy such as access to a specific folder within a specific bucket.

Parameters:

accessKey - The access key provided by Amazon, needed for non anonymous operations

secretKey - The secret key provided by Amazon, needed for non anonymous operations

tryDefaultAWSCredentialsProviderChain - Set it to true to try first to obtain credentials from AWS environment. See: http://docs.aws.amazon.com/java-sdk/latest/developer-guide/credentials.html#using-the-default-credential-provider-chain

Throws:

org.mule.api.ConnectionException

createClientCredentials

protected void createClientCredentials(String accessKey,
                                       String secretKey,
                                       boolean tryDefaultAWSCredentialsProviderChain)
                                throws org.mule.api.ConnectionException

Creates AWS basic credentials for the client

Parameters:

accessKey -

secretKey -

tryDefaultAWSCredentialsProviderChain -

Throws:

org.mule.api.ConnectionException

performClientConnectionTest

protected abstract void performClientConnectionTest()

Executes a requests in AWS server to check if the client configuration is correct.