org.mule.modules.sns

Class SNSBasicConfig

java.lang.Object

org.mule.modules.sns.CommonConfig<com.amazonaws.services.sns.AmazonSNSClient>

org.mule.modules.sns.SNSCommonConfig

org.mule.modules.sns.SNSBasicConfig

@ConnectionManagement(friendlyName="Configuration",
                      configElementName="config")
public class SNSBasicConfig
extends SNSCommonConfig

Field Summary

Fields inherited from class org.mule.modules.sns.CommonConfig

clientBuilder

Constructor Summary

Constructors

Constructor and Description
SNSBasicConfig()

Method Summary

Modifier and Type	Method and Description
void	connect(String accessKey, String secretKey, String sessionToken, boolean tryDefaultAWSCredentialsProviderChain) Login to Amazon SNS
String	connectionId() Connection identifier
void	testConnect(String accessKey, String secretKey, String sessionToken, boolean tryDefaultAWSCredentialsProviderChain) Test connectivity to Amazon SNS

Methods inherited from class org.mule.modules.sns.SNSCommonConfig

disconnect, getDefaultRegion, getMaxConnections, getRegion, getTestTopicArn, isConnected, setClientBuilder, setMaxConnections, setRegion, setTestTopicArn

Methods inherited from class org.mule.modules.sns.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

SNSBasicConfig

public SNSBasicConfig()

Method Detail

connect

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

Login to Amazon SNS

Parameters:

accessKey - The access key provided by Amazon

secretKey - The secret key provided by Amazon

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
                                          String sessionToken,
                                          @Optional
                                          boolean tryDefaultAWSCredentialsProviderChain)
                                   throws org.mule.api.ConnectionException

Test connectivity to Amazon SNS

Parameters:

accessKey - The access key provided by Amazon

secretKey - The secret key provided by Amazon

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

connectionId

@ConnectionIdentifier
public String connectionId()

Connection identifier

Returns:

connection identifier