org.mule.modules.ec2

Class Config

java.lang.Object

org.mule.modules.aws.commons.CommonConfig<com.amazonaws.services.ec2.AmazonEC2Client>

org.mule.modules.ec2.Config

@ConnectionManagement(friendlyName="Configuration")
public class Config
extends CommonConfig<com.amazonaws.services.ec2.AmazonEC2Client>

Field Summary

Fields inherited from class org.mule.modules.aws.commons.CommonConfig

clientBuilder

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
void	connect(String accessKey, String secretKey, boolean tryDefaultAWSCredentialsProviderChain) Login to Amazon S3
String	connectionId()
void	disconnect()
protected String	getDefaultRegion()
Integer	getMaxConnections()
RegionEndpoint	getRegion()
boolean	isConnected()
protected void	setClientBuilder()
void	setMaxConnections(Integer maxConnections)
void	setRegion(RegionEndpoint region)
void	testConnect(String accessKey, String secretKey, boolean tryDefaultAWSCredentialsProviderChain) Test Connectivity to Amazon S3.

Methods inherited from class org.mule.modules.aws.commons.CommonConfig

getAsyncClient, getClientBuilder, getConfigRegion, getConnectionTimeout, getProtocol, getProxyDomain, getProxyHost, getProxyPassword, getProxyPort, getProxyUsername, getProxyWorkstation, getSocketTimeout, getSyncClient, setConnectionTimeout, setProtocol, setProxyDomain, setProxyHost, setProxyPassword, setProxyPort, setProxyUsername, setProxyWorkstation, setSocketTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

Config

public Config()

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 - an Exception indicating connection failure

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 - Boolean value indicating whether credentials provider chain needs to be used

Throws:

org.mule.api.ConnectionException - an Exception indicating connection failure

disconnect

@Disconnect
public void disconnect()

isConnected

@ValidateConnection
public boolean isConnected()

connectionId

@ConnectionIdentifier
public String connectionId()

getMaxConnections

public Integer getMaxConnections()

setMaxConnections

public void setMaxConnections(Integer maxConnections)

getRegion

public RegionEndpoint getRegion()

setRegion

public void setRegion(RegionEndpoint region)

getDefaultRegion

protected String getDefaultRegion()

Specified by:

getDefaultRegion in class CommonConfig<com.amazonaws.services.ec2.AmazonEC2Client>

setClientBuilder

protected void setClientBuilder()

Specified by:

setClientBuilder in class CommonConfig<com.amazonaws.services.ec2.AmazonEC2Client>