public class

Config

extends Object
java.lang.Object
   ↳ org.mule.modules.sqs.Config
Known Direct Subclasses

Summary

Fields
private String connectionId
private Integer connectionTimeout The amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
private String defaultQueueName Name of the queue to connect, if one does not exist the connector will automatically create one.
private AmazonSQSClient msgQueue Message Queue
private AmazonSQSAsync msgQueueAsync
private Protocol protocol The optional communication protocol to use when sending requests to AWS.
private String proxyDomain The optional proxy domain
private String proxyHost The optional proxy port
private String proxyPassword The optional proxy password
private Integer proxyPort The optional proxy port
private String proxyUsername The optional proxy username
private String proxyWorkstation The optional proxy workstation
private RegionEndpoint region Queue Region
private Integer socketTimeout The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection is timed out.
private String url Queue URL takes priority over the Queue Name and is required if Queue Name has not been defined.
Public Constructors
Config()
Public Methods
void connect(String accessKey, String secretKey)
void disconnect()
String getConnectionId()
Integer getConnectionTimeout()
String getDefaultQueueName()
AmazonSQSClient getMsgQueue()
AmazonSQSAsync getMsgQueueAsync()
Protocol getProtocol()
String getProxyDomain()
String getProxyHost()
String getProxyPassword()
Integer getProxyPort()
String getProxyUsername()
String getProxyWorkstation()
RegionEndpoint getRegion()
Integer getSocketTimeout()
String getUrl(String queueUrl)
String getUrl()
boolean isConnected()
void setConnectionId(String accessKey)
void setConnectionTimeout(Integer connectionTimeout)
void setDefaultQueueName(String defaultQueueName)
void setMsgQueue(AmazonSQSClient msgQueue)
void setMsgQueueAsync(AmazonSQSAsync msgQueueAsync)
void setProtocol(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 setSocketTimeout(Integer socketTimeout)
void setUrl(String queueUrl)
void testConnect(String accessKey, String secretKey)
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private String connectionId

private Integer connectionTimeout

The amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out. A value of 0 means infinity, and is not recommended.

private String defaultQueueName

Name of the queue to connect, if one does not exist the connector will automatically create one. Required if Queue URL has not been defined.

private AmazonSQSClient msgQueue

Message Queue

private AmazonSQSAsync msgQueueAsync

private Protocol protocol

The optional communication protocol to use when sending requests to AWS. Communication over HTTPS is the default

private String proxyDomain

The optional proxy domain

private String proxyHost

The optional proxy port

private String proxyPassword

The optional proxy password

private Integer proxyPort

The optional proxy port

private String proxyUsername

The optional proxy username

private String proxyWorkstation

The optional proxy workstation

private RegionEndpoint region

Queue Region

private Integer socketTimeout

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection is timed out. A value of 0 means infinity, and is not recommended.

private String url

Queue URL takes priority over the Queue Name and is required if Queue Name has not been defined.

Public Constructors

public Config ()

Public Methods

public void connect (String accessKey, String secretKey)

Parameters
accessKey AWS access key
secretKey AWS secret key
Throws
ConnectionException If a connection cannot be made due to invalid credentials or if a network connection is not available.

public void disconnect ()

public String getConnectionId ()

public Integer getConnectionTimeout ()

public String getDefaultQueueName ()

public AmazonSQSClient getMsgQueue ()

public AmazonSQSAsync getMsgQueueAsync ()

public Protocol getProtocol ()

public String getProxyDomain ()

public String getProxyHost ()

public String getProxyPassword ()

public Integer getProxyPort ()

public String getProxyUsername ()

public String getProxyWorkstation ()

public RegionEndpoint getRegion ()

public Integer getSocketTimeout ()

public String getUrl (String queueUrl)

Parameters
queueUrl
Throws
SQSConnectorException

public String getUrl ()

public boolean isConnected ()

public void setConnectionId (String accessKey)

Parameters
accessKey

public void setConnectionTimeout (Integer connectionTimeout)

Parameters
connectionTimeout

public void setDefaultQueueName (String defaultQueueName)

Parameters
defaultQueueName

public void setMsgQueue (AmazonSQSClient msgQueue)

Parameters
msgQueue

public void setMsgQueueAsync (AmazonSQSAsync msgQueueAsync)

Parameters
msgQueueAsync

public void setProtocol (Protocol protocol)

Parameters
protocol

public void setProxyDomain (String proxyDomain)

Parameters
proxyDomain

public void setProxyHost (String proxyHost)

Parameters
proxyHost

public void setProxyPassword (String proxyPassword)

Parameters
proxyPassword

public void setProxyPort (Integer proxyPort)

Parameters
proxyPort

public void setProxyUsername (String proxyUsername)

Parameters
proxyUsername

public void setProxyWorkstation (String proxyWorkstation)

Parameters
proxyWorkstation

public void setRegion (RegionEndpoint region)

Parameters
region

public void setSocketTimeout (Integer socketTimeout)

Parameters
socketTimeout

public void setUrl (String queueUrl)

Parameters
queueUrl

public void testConnect (String accessKey, String secretKey)

Parameters
accessKey AWS access key
secretKey AWS secret key
Throws
ConnectionException If a connection cannot be made due to invalid credentials or if a network connection is not available.