Package com.amazonaws.services.iot.client.core

Class AbstractAwsIotClient

java.lang.Object

com.amazonaws.services.iot.client.core.AbstractAwsIotClient

All Implemented Interfaces:

AwsIotConnectionCallback

Direct Known Subclasses:

AWSIotMqttClient

public abstract class AbstractAwsIotClient
extends Object
implements AwsIotConnectionCallback

The actual implementation of AWSIotMqttClient.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	baseRetryDelay
protected boolean	cleanSession
protected boolean	clientEnableMetrics
protected String	clientEndpoint
protected String	clientId
protected int	connectionTimeout
protected AwsIotConnectionType	connectionType
protected int	keepAliveInterval
protected int	maxConnectionRetries
protected int	maxOfflineQueueSize
protected int	maxRetryDelay
protected int	numOfClientThreads
protected int	port
protected int	serverAckTimeout
protected AWSIotMessage	willMessage

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, CredentialsProvider provider, String region)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, CredentialsProvider provider, String region, boolean enableSdkMetrics)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, String awsAccessKeyId, String awsSecretAccessKey, String sessionToken)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, String awsAccessKeyId, String awsSecretAccessKey, String sessionToken, boolean enableSdkMetrics)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, String awsAccessKeyId, String awsSecretAccessKey, String sessionToken, String region)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, String awsAccessKeyId, String awsSecretAccessKey, String sessionToken, String region, boolean enableSdkMetrics)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, KeyStore keyStore, String keyPassword)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, KeyStore keyStore, String keyPassword, boolean enableSdkMetrics)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, SSLSocketFactory socketFactory)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, SSLSocketFactory socketFactory, boolean enableSdkMetrics)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, SSLSocketFactory socketFactory, int port)
protected	AbstractAwsIotClient(String clientEndpoint, String clientId, SSLSocketFactory socketFactory, int port, boolean enableSdkMetrics)

Method Summary

Modifier and Type	Method	Description
void	attach(AWSIotDevice device)
void	connect()
void	connect(long timeout)
void	connect(long timeout, boolean blocking)
void	detach(AWSIotDevice device)
void	disconnect()
void	disconnect(long timeout)
void	disconnect(long timeout, boolean blocking)
void	dispatch(AWSIotMessage message)
int	getBaseRetryDelay()
String	getClientEndpoint()
String	getClientId()
AwsIotConnection	getConnection()
AWSIotConnectionStatus	getConnectionStatus()
int	getConnectionTimeout()
AwsIotConnectionType	getConnectionType()
ConcurrentMap<String,AbstractAwsIotDevice>	getDevices()
ScheduledExecutorService	getExecutionService()
int	getKeepAliveInterval()
int	getMaxConnectionRetries()
int	getMaxOfflineQueueSize()
int	getMaxRetryDelay()
int	getNumOfClientThreads()
int	getPort()
int	getServerAckTimeout()
ConcurrentMap<String,AWSIotTopic>	getSubscriptions()
AWSIotMessage	getWillMessage()
boolean	isCleanSession()
boolean	isClientEnableMetrics()
void	onConnectionClosed()	On connection closed.
void	onConnectionFailure()	On connection failure.
void	onConnectionSuccess()	On connection success.
void	publish(AWSIotMessage message)
void	publish(AWSIotMessage message, long timeout)
void	publish(String topic, byte[] payload)
void	publish(String topic, byte[] payload, long timeout)
void	publish(String topic, AWSIotQos qos, byte[] payload)
void	publish(String topic, AWSIotQos qos, byte[] payload, long timeout)
void	publish(String topic, AWSIotQos qos, String payload)
void	publish(String topic, AWSIotQos qos, String payload, long timeout)
void	publish(String topic, String payload)
void	publish(String topic, String payload, long timeout)
Future<?>	scheduleRoutineTask(Runnable runnable, long initialDelay, long period)
Future<?>	scheduleTask(Runnable runnable)
Future<?>	scheduleTimeoutTask(Runnable runnable, long timeout)
void	setBaseRetryDelay(int baseRetryDelay)
void	setCleanSession(boolean cleanSession)
void	setConnectionTimeout(int connectionTimeout)
void	setExecutionService(ScheduledExecutorService executionService)
void	setKeepAliveInterval(int keepAliveInterval)
void	setMaxConnectionRetries(int maxConnectionRetries)
void	setMaxOfflineQueueSize(int maxOfflineQueueSize)
void	setMaxRetryDelay(int maxRetryDelay)
void	setNumOfClientThreads(int numOfClientThreads)
void	setPort(int port)
void	setServerAckTimeout(int serverAckTimeout)
void	setWillMessage(AWSIotMessage willMessage)
void	subscribe(AWSIotTopic topic)
void	subscribe(AWSIotTopic topic, boolean blocking)
void	subscribe(AWSIotTopic topic, long timeout)
void	subscribe(AWSIotTopic topic, long timeout, boolean blocking)
boolean	topicFilterMatch(String topicFilter, String topic)
void	unsubscribe(AWSIotTopic topic)
void	unsubscribe(AWSIotTopic topic, long timeout)
void	unsubscribe(String topic)
void	unsubscribe(String topic, long timeout)
void	updateCredentials(String awsAccessKeyId, String awsSecretAccessKey, String sessionToken)

Methods inherited from class java.lang.Object

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

Field Detail

clientId

protected final String clientId

clientEndpoint

protected final String clientEndpoint

clientEnableMetrics

protected final boolean clientEnableMetrics

connectionType

protected final AwsIotConnectionType connectionType

port

protected int port

numOfClientThreads

protected int numOfClientThreads

connectionTimeout

protected int connectionTimeout

serverAckTimeout

protected int serverAckTimeout

keepAliveInterval

protected int keepAliveInterval

maxConnectionRetries

protected int maxConnectionRetries

baseRetryDelay

protected int baseRetryDelay

maxRetryDelay

protected int maxRetryDelay

maxOfflineQueueSize

protected int maxOfflineQueueSize

cleanSession

protected boolean cleanSession

willMessage

protected AWSIotMessage willMessage

Constructor Detail

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               KeyStore keyStore,
                               String keyPassword,
                               boolean enableSdkMetrics)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               KeyStore keyStore,
                               String keyPassword)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               String awsAccessKeyId,
                               String awsSecretAccessKey,
                               String sessionToken,
                               boolean enableSdkMetrics)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               String awsAccessKeyId,
                               String awsSecretAccessKey,
                               String sessionToken,
                               String region,
                               boolean enableSdkMetrics)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               String awsAccessKeyId,
                               String awsSecretAccessKey,
                               String sessionToken)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               String awsAccessKeyId,
                               String awsSecretAccessKey,
                               String sessionToken,
                               String region)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               CredentialsProvider provider,
                               String region)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               CredentialsProvider provider,
                               String region,
                               boolean enableSdkMetrics)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               SSLSocketFactory socketFactory,
                               boolean enableSdkMetrics)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               SSLSocketFactory socketFactory)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               SSLSocketFactory socketFactory,
                               int port,
                               boolean enableSdkMetrics)

AbstractAwsIotClient

protected AbstractAwsIotClient(String clientEndpoint,
                               String clientId,
                               SSLSocketFactory socketFactory,
                               int port)

Method Detail

updateCredentials

public void updateCredentials(String awsAccessKeyId,
                              String awsSecretAccessKey,
                              String sessionToken)

connect

public void connect()
             throws AWSIotException

Throws:

AWSIotException

connect

public void connect(long timeout)
             throws AWSIotException,
                    AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

connect

public void connect(long timeout,
                    boolean blocking)
             throws AWSIotException,
                    AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

disconnect

public void disconnect()
                throws AWSIotException

Throws:

AWSIotException

disconnect

public void disconnect(long timeout)
                throws AWSIotException,
                       AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

disconnect

public void disconnect(long timeout,
                       boolean blocking)
                throws AWSIotException,
                       AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

publish

public void publish(String topic,
                    String payload)
             throws AWSIotException

Throws:

AWSIotException

publish

public void publish(String topic,
                    String payload,
                    long timeout)
             throws AWSIotException,
                    AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

publish

public void publish(String topic,
                    AWSIotQos qos,
                    String payload)
             throws AWSIotException

Throws:

AWSIotException

publish

public void publish(String topic,
                    AWSIotQos qos,
                    String payload,
                    long timeout)
             throws AWSIotException,
                    AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

publish

public void publish(String topic,
                    byte[] payload)
             throws AWSIotException

Throws:

AWSIotException

publish

public void publish(String topic,
                    byte[] payload,
                    long timeout)
             throws AWSIotException,
                    AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

publish

public void publish(String topic,
                    AWSIotQos qos,
                    byte[] payload)
             throws AWSIotException

Throws:

AWSIotException

publish

public void publish(String topic,
                    AWSIotQos qos,
                    byte[] payload,
                    long timeout)
             throws AWSIotException,
                    AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

publish

public void publish(AWSIotMessage message)
             throws AWSIotException

Throws:

AWSIotException

publish

public void publish(AWSIotMessage message,
                    long timeout)
             throws AWSIotException

Throws:

AWSIotException

subscribe

public void subscribe(AWSIotTopic topic,
                      boolean blocking)
               throws AWSIotException

Throws:

AWSIotException

subscribe

public void subscribe(AWSIotTopic topic,
                      long timeout,
                      boolean blocking)
               throws AWSIotException,
                      AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

subscribe

public void subscribe(AWSIotTopic topic)
               throws AWSIotException

Throws:

AWSIotException

subscribe

public void subscribe(AWSIotTopic topic,
                      long timeout)
               throws AWSIotException

Throws:

AWSIotException

unsubscribe

public void unsubscribe(String topic)
                 throws AWSIotException

Throws:

AWSIotException

unsubscribe

public void unsubscribe(String topic,
                        long timeout)
                 throws AWSIotException,
                        AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

unsubscribe

public void unsubscribe(AWSIotTopic topic)
                 throws AWSIotException

Throws:

AWSIotException

unsubscribe

public void unsubscribe(AWSIotTopic topic,
                        long timeout)
                 throws AWSIotException

Throws:

AWSIotException

topicFilterMatch

public boolean topicFilterMatch(String topicFilter,
                                String topic)

dispatch

public void dispatch(AWSIotMessage message)

attach

public void attach(AWSIotDevice device)
            throws AWSIotException

Throws:

AWSIotException

detach

public void detach(AWSIotDevice device)
            throws AWSIotException

Throws:

AWSIotException

getConnectionStatus

public AWSIotConnectionStatus getConnectionStatus()

onConnectionSuccess

public void onConnectionSuccess()

Description copied from interface: AwsIotConnectionCallback

On connection success.

Specified by:

onConnectionSuccess in interface AwsIotConnectionCallback

onConnectionFailure

public void onConnectionFailure()

Description copied from interface: AwsIotConnectionCallback

On connection failure.

Specified by:

onConnectionFailure in interface AwsIotConnectionCallback

onConnectionClosed

public void onConnectionClosed()

Description copied from interface: AwsIotConnectionCallback

On connection closed.

Specified by:

onConnectionClosed in interface AwsIotConnectionCallback

scheduleTask

public Future<?> scheduleTask(Runnable runnable)

scheduleTimeoutTask

public Future<?> scheduleTimeoutTask(Runnable runnable,
                                     long timeout)

scheduleRoutineTask

public Future<?> scheduleRoutineTask(Runnable runnable,
                                     long initialDelay,
                                     long period)

getClientId

public String getClientId()

getClientEndpoint

public String getClientEndpoint()

isClientEnableMetrics

public boolean isClientEnableMetrics()

getConnectionType

public AwsIotConnectionType getConnectionType()

getPort

public int getPort()

getNumOfClientThreads

public int getNumOfClientThreads()

getConnectionTimeout

public int getConnectionTimeout()

getServerAckTimeout

public int getServerAckTimeout()

getKeepAliveInterval

public int getKeepAliveInterval()

getMaxConnectionRetries

public int getMaxConnectionRetries()

getBaseRetryDelay

public int getBaseRetryDelay()

getMaxRetryDelay

public int getMaxRetryDelay()

getMaxOfflineQueueSize

public int getMaxOfflineQueueSize()

isCleanSession

public boolean isCleanSession()

getWillMessage

public AWSIotMessage getWillMessage()

getSubscriptions

public ConcurrentMap<String,AWSIotTopic> getSubscriptions()

getDevices

public ConcurrentMap<String,AbstractAwsIotDevice> getDevices()

getConnection

public AwsIotConnection getConnection()

getExecutionService

public ScheduledExecutorService getExecutionService()

setPort

public void setPort(int port)

setNumOfClientThreads

public void setNumOfClientThreads(int numOfClientThreads)

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

setServerAckTimeout

public void setServerAckTimeout(int serverAckTimeout)

setKeepAliveInterval

public void setKeepAliveInterval(int keepAliveInterval)

setMaxConnectionRetries

public void setMaxConnectionRetries(int maxConnectionRetries)

setBaseRetryDelay

public void setBaseRetryDelay(int baseRetryDelay)

setMaxRetryDelay

public void setMaxRetryDelay(int maxRetryDelay)

setMaxOfflineQueueSize

public void setMaxOfflineQueueSize(int maxOfflineQueueSize)

setCleanSession

public void setCleanSession(boolean cleanSession)

setWillMessage

public void setWillMessage(AWSIotMessage willMessage)

setExecutionService

public void setExecutionService(ScheduledExecutorService executionService)