Package com.amazonaws.services.iot.client.shadow

Class AbstractAwsIotDevice

java.lang.Object

com.amazonaws.services.iot.client.shadow.AbstractAwsIotDevice

Direct Known Subclasses:

AWSIotDevice

public abstract class AbstractAwsIotDevice
extends Object

The actual implementation of AWSIotDevice.

Field Summary

Fields

Modifier and Type	Field	Description
protected AWSIotQos	deviceReportQos
protected boolean	enableVersioning
protected AWSIotQos	methodAckQos
protected AWSIotQos	methodQos
protected long	reportInterval
protected AWSIotQos	shadowUpdateQos
protected String	thingName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAwsIotDevice(String thingName)

Method Summary

Modifier and Type	Method	Description
void	activate()
void	deactivate()
protected void	delete()
protected void	delete(long timeout)
protected void	delete(AWSIotMessage message, long timeout)
protected String	get()
protected String	get(long timeout)
protected void	get(AWSIotMessage message, long timeout)
AbstractAwsIotClient	getClient()
AwsIotDeviceCommandManager	getCommandManager()
protected AbstractAwsIotDevice	getDevice()
AWSIotQos	getDeviceReportQos()
ConcurrentMap<String,Boolean>	getDeviceSubscriptions()
com.fasterxml.jackson.databind.ObjectMapper	getJsonObjectMapper()
AtomicLong	getLocalVersion()
AWSIotQos	getMethodAckQos()
AWSIotQos	getMethodQos()
Map<String,Field>	getReportedProperties()
long	getReportInterval()
AWSIotQos	getShadowUpdateQos()
Future<?>	getSyncTask()
String	getThingName()
Map<String,Field>	getUpdatableProperties()
boolean	isCommandReady(AwsIotDeviceCommandManager.Command command)
boolean	isEnableVersioning()
boolean	isTopicReady(String topic)
void	onCommandAck(AWSIotMessage message)
protected String	onDeviceReport()
protected void	onShadowUpdate(String jsonState)
void	onSubscriptionAck(String topic, boolean success)
void	setClient(AbstractAwsIotClient client)
void	setDeviceReportQos(AWSIotQos deviceReportQos)
void	setEnableVersioning(boolean enableVersioning)
void	setLocalVersion(AtomicLong localVersion)
void	setMethodAckQos(AWSIotQos methodAckQos)
void	setMethodQos(AWSIotQos methodQos)
void	setReportInterval(long reportInterval)
void	setShadowUpdateQos(AWSIotQos shadowUpdateQos)
void	setSyncTask(Future<?> syncTask)
protected void	startSync()
protected void	startVersionSync()
protected void	stopSync()
protected void	update(AWSIotMessage message, long timeout)
protected void	update(String jsonState)
protected void	update(String jsonState, long timeout)

Methods inherited from class java.lang.Object

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

Field Detail

thingName

protected final String thingName

reportInterval

protected long reportInterval

enableVersioning

protected boolean enableVersioning

deviceReportQos

protected AWSIotQos deviceReportQos

shadowUpdateQos

protected AWSIotQos shadowUpdateQos

methodQos

protected AWSIotQos methodQos

methodAckQos

protected AWSIotQos methodAckQos

Constructor Detail

AbstractAwsIotDevice

protected AbstractAwsIotDevice(String thingName)

Method Detail

getDevice

protected AbstractAwsIotDevice getDevice()

get

protected String get()
              throws AWSIotException

Throws:

AWSIotException

get

protected String get(long timeout)
              throws AWSIotException,
                     AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

get

protected void get(AWSIotMessage message,
                   long timeout)
            throws AWSIotException

Throws:

AWSIotException

update

protected void update(String jsonState)
               throws AWSIotException

Throws:

AWSIotException

update

protected void update(String jsonState,
                      long timeout)
               throws AWSIotException,
                      AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

update

protected void update(AWSIotMessage message,
                      long timeout)
               throws AWSIotException

Throws:

AWSIotException

delete

protected void delete()
               throws AWSIotException

Throws:

AWSIotException

delete

protected void delete(long timeout)
               throws AWSIotException,
                      AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

delete

protected void delete(AWSIotMessage message,
                      long timeout)
               throws AWSIotException

Throws:

AWSIotException

onShadowUpdate

protected void onShadowUpdate(String jsonState)

onDeviceReport

protected String onDeviceReport()

activate

public void activate()
              throws AWSIotException

Throws:

AWSIotException

deactivate

public void deactivate()
                throws AWSIotException

Throws:

AWSIotException

isTopicReady

public boolean isTopicReady(String topic)

isCommandReady

public boolean isCommandReady(AwsIotDeviceCommandManager.Command command)

onSubscriptionAck

public void onSubscriptionAck(String topic,
                              boolean success)

onCommandAck

public void onCommandAck(AWSIotMessage message)

startSync

protected void startSync()

stopSync

protected void stopSync()

startVersionSync

protected void startVersionSync()

getThingName

public String getThingName()

getReportInterval

public long getReportInterval()

isEnableVersioning

public boolean isEnableVersioning()

getDeviceReportQos

public AWSIotQos getDeviceReportQos()

getShadowUpdateQos

public AWSIotQos getShadowUpdateQos()

getMethodQos

public AWSIotQos getMethodQos()

getMethodAckQos

public AWSIotQos getMethodAckQos()

getReportedProperties

public Map<String,Field> getReportedProperties()

getUpdatableProperties

public Map<String,Field> getUpdatableProperties()

getCommandManager

public AwsIotDeviceCommandManager getCommandManager()

getDeviceSubscriptions

public ConcurrentMap<String,Boolean> getDeviceSubscriptions()

getJsonObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getJsonObjectMapper()

getClient

public AbstractAwsIotClient getClient()

getSyncTask

public Future<?> getSyncTask()

getLocalVersion

public AtomicLong getLocalVersion()

setReportInterval

public void setReportInterval(long reportInterval)

setEnableVersioning

public void setEnableVersioning(boolean enableVersioning)

setDeviceReportQos

public void setDeviceReportQos(AWSIotQos deviceReportQos)

setShadowUpdateQos

public void setShadowUpdateQos(AWSIotQos shadowUpdateQos)

setMethodQos

public void setMethodQos(AWSIotQos methodQos)

setMethodAckQos

public void setMethodAckQos(AWSIotQos methodAckQos)

setClient

public void setClient(AbstractAwsIotClient client)

setSyncTask

public void setSyncTask(Future<?> syncTask)

setLocalVersion

public void setLocalVersion(AtomicLong localVersion)