org.mule.module.s3

Class Config

java.lang.Object

org.mule.module.s3.Config

@ConnectionManagement(friendlyName="Configuration")
public class Config
extends Object

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(String accessKey, String secretKey, boolean tryDefaultAWSCredentialsProviderChain) Login to Amazon S3
String	connectionId()
void	disconnect()
com.amazonaws.services.s3.AmazonS3	getClient()
Integer	getConnectionTimeout()
Integer	getMaxConnections()
com.amazonaws.Protocol	getProtocol()
String	getProxyDomain()
String	getProxyHost()
String	getProxyPassword()
Integer	getProxyPort()
String	getProxyUsername()
String	getProxyWorkstation()
String	getRoleARN()
Integer	getSocketTimeout()
String	getStorageUrl()
boolean	isConnected()
void	setClient(com.amazonaws.services.s3.AmazonS3 client)
void	setConnectionTimeout(Integer connectionTimeout)
void	setMaxConnections(Integer maxConnections)
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	setSocketTimeout(Integer socketTimeout)
void	setStorageUrl(String storageUrl)
void	testConnect(String accessKey, String secretKey, boolean tryDefaultAWSCredentialsProviderChain) Test Connectivity to Amazon S3.

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

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

Throws:

org.mule.api.ConnectionException

disconnect

@Disconnect
public void disconnect()

isConnected

@ValidateConnection
public boolean isConnected()

connectionId

@ConnectionIdentifier
public String connectionId()

getProxyUsername

public String getProxyUsername()

setProxyUsername

public void setProxyUsername(String proxyUsername)

getProxyPort

public Integer getProxyPort()

setProxyPort

public void setProxyPort(Integer proxyPort)

getProxyPassword

public String getProxyPassword()

setProxyPassword

public void setProxyPassword(String proxyPassword)

getProxyHost

public String getProxyHost()

setProxyHost

public void setProxyHost(String proxyHost)

getSocketTimeout

public Integer getSocketTimeout()

setSocketTimeout

public void setSocketTimeout(Integer socketTimeout)

getConnectionTimeout

public Integer getConnectionTimeout()

setConnectionTimeout

public void setConnectionTimeout(Integer connectionTimeout)

getClient

public com.amazonaws.services.s3.AmazonS3 getClient()

setClient

public void setClient(com.amazonaws.services.s3.AmazonS3 client)

getProtocol

public com.amazonaws.Protocol getProtocol()

setProtocol

public void setProtocol(com.amazonaws.Protocol protocol)

getProxyDomain

public String getProxyDomain()

setProxyDomain

public void setProxyDomain(String proxyDomain)

getProxyWorkstation

public String getProxyWorkstation()

setProxyWorkstation

public void setProxyWorkstation(String proxyWorkstation)

getMaxConnections

public Integer getMaxConnections()

setMaxConnections

public void setMaxConnections(Integer maxConnections)

getStorageUrl

public String getStorageUrl()

setStorageUrl

public void setStorageUrl(String storageUrl)

getRoleARN

public String getRoleARN()

setRoleARN

public void setRoleARN(String roleARN)