org.mule.modules.sqs

Class Config

java.lang.Object

org.mule.modules.sqs.Config

@ReconnectOn(exceptions=SQSConnectorException.class)
@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)
void	disconnect()
org.mule.modules.sqs.Config.SQSClientBuilder	getClientBuilder()
String	getConnectionId()
Integer	getConnectionTimeout()
String	getDefaultQueueName()
com.amazonaws.services.sqs.AmazonSQSClient	getMsgQueue()
com.amazonaws.services.sqs.AmazonSQSAsync	getMsgQueueAsync()
com.amazonaws.Protocol	getProtocol()
String	getProxyDomain()
String	getProxyHost()
String	getProxyPassword()
Integer	getProxyPort()
String	getProxyUsername()
String	getProxyWorkstation()
RegionEndpoint	getRegion()
String	getRoleARN()
Integer	getSocketTimeout()
String	getUrl()
String	getUrl(String queueUrl)
boolean	isConnected()
void	setConnectionId(String accessKey)
void	setConnectionTimeout(Integer connectionTimeout)
void	setDefaultQueueName(String defaultQueueName)
void	setMsgQueue(com.amazonaws.services.sqs.AmazonSQSClient msgQueue)
void	setMsgQueueAsync(com.amazonaws.services.sqs.AmazonSQSAsync msgQueueAsync)
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	setRegion(RegionEndpoint region)
void	setRoleARN(String roleARN)
void	setSocketTimeout(Integer socketTimeout)
void	setUrl(String queueUrl)
void	testConnect(String accessKey, String secretKey, boolean tryDefaultAWSCredentialsProviderChain)

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

getClientBuilder

public org.mule.modules.sqs.Config.SQSClientBuilder getClientBuilder()

connect

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

Parameters:

accessKey - AWS access key

secretKey - AWS secret key

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 - If a connection cannot be made due to invalid credentials or if a network connection is not available.

testConnect

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

Parameters:

accessKey - AWS access key

secretKey - AWS secret key

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 - If a connection cannot be made due to invalid credentials or if a network connection is not available.

getConnectionId

@ConnectionIdentifier
public String getConnectionId()

setConnectionId

public void setConnectionId(String accessKey)

disconnect

@Disconnect
public void disconnect()

isConnected

@ValidateConnection
public boolean isConnected()

setUrl

public void setUrl(String queueUrl)

getUrl

public String getUrl()

getUrl

public String getUrl(String queueUrl)
              throws SQSConnectorException

Throws:

SQSConnectorException

getRegion

public RegionEndpoint getRegion()

setRegion

public void setRegion(RegionEndpoint region)

getRoleARN

public String getRoleARN()

setRoleARN

public void setRoleARN(String roleARN)

getMsgQueue

public com.amazonaws.services.sqs.AmazonSQSClient getMsgQueue()

setMsgQueue

public void setMsgQueue(com.amazonaws.services.sqs.AmazonSQSClient msgQueue)

getMsgQueueAsync

public com.amazonaws.services.sqs.AmazonSQSAsync getMsgQueueAsync()

setMsgQueueAsync

public void setMsgQueueAsync(com.amazonaws.services.sqs.AmazonSQSAsync msgQueueAsync)

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)

getDefaultQueueName

public String getDefaultQueueName()

setDefaultQueueName

public void setDefaultQueueName(String defaultQueueName)