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

Class AwsIotDeviceCommand

java.lang.Object

com.amazonaws.services.iot.client.AWSIotMessage

com.amazonaws.services.iot.client.core.AwsIotCompletion

com.amazonaws.services.iot.client.shadow.AwsIotDeviceCommand

All Implemented Interfaces:

AwsIotMessageCallback

public class AwsIotDeviceCommand
extends AwsIotCompletion

This is a helper class that can be used to manage the execution result of a shadow command, i.e. get, update, and delete. It makes sure that the command is not published until the subscription requests for the acknowledgment topics, namely accepted and rejected, have completed successfully.

See Also:

• AwsIotCompletion

Field Summary

Fields inherited from class com.amazonaws.services.iot.client.core.AwsIotCompletion

hasFailure, hasSuccess, hasTimeout, isAsync, request, timeout, timeoutTask

Fields inherited from class com.amazonaws.services.iot.client.AWSIotMessage

errorCode, errorMessage, payload, qos, topic

Constructor Summary

Constructors

Constructor	Description
AwsIotDeviceCommand(AwsIotDeviceCommandManager commandManager, AwsIotDeviceCommandManager.Command command, String commandId, AWSIotMessage request, long commandTimeout, boolean isAsync)

Method Summary

Modifier and Type	Method	Description
String	get(AbstractAwsIotDevice device)
AwsIotDeviceCommandManager.Command	getCommand()
String	getCommandId()
AwsIotDeviceCommandManager	getCommandManager()
Boolean	getRequestSent()
AWSIotMessage	getResponse()
void	onFailure()	Callback function to be invoked a non-block API has completed unsuccessfully.
boolean	onReady(AbstractAwsIotDevice device)
void	onSuccess()	Callback function to be invoked a non-block API has completed successfully.
void	onTimeout()	Callback function to be invoked a non-block API has timed out.
void	put(AbstractAwsIotDevice device)
void	setResponse(AWSIotMessage response)

Methods inherited from class com.amazonaws.services.iot.client.core.AwsIotCompletion

get

Methods inherited from class com.amazonaws.services.iot.client.AWSIotMessage

getErrorCode, getErrorMessage, getPayload, getQos, getStringPayload, getTopic, setErrorCode, setErrorMessage, setPayload, setQos, setStringPayload, setTopic

Methods inherited from class java.lang.Object

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

Constructor Details

AwsIotDeviceCommand

public AwsIotDeviceCommand(AwsIotDeviceCommandManager commandManager,
 AwsIotDeviceCommandManager.Command command,
 String commandId,
 AWSIotMessage request,
 long commandTimeout,
 boolean isAsync)

Method Details

put

public void put(AbstractAwsIotDevice device)
         throws AWSIotException

Throws:

AWSIotException

get

public String get(AbstractAwsIotDevice device)
           throws AWSIotException,
AWSIotTimeoutException

Throws:

AWSIotException

AWSIotTimeoutException

onReady

public boolean onReady(AbstractAwsIotDevice device)

onSuccess

public void onSuccess()

Description copied from class: AWSIotMessage

Callback function to be invoked a non-block API has completed successfully.

Specified by:

onSuccess in interface AwsIotMessageCallback

Overrides:

onSuccess in class AwsIotCompletion

onFailure

public void onFailure()

Description copied from class: AWSIotMessage

Callback function to be invoked a non-block API has completed unsuccessfully.

Specified by:

onFailure in interface AwsIotMessageCallback

Overrides:

onFailure in class AwsIotCompletion

onTimeout

public void onTimeout()

Description copied from class: AWSIotMessage

Callback function to be invoked a non-block API has timed out.

Specified by:

onTimeout in interface AwsIotMessageCallback

Overrides:

onTimeout in class AwsIotCompletion

getCommandManager

public AwsIotDeviceCommandManager getCommandManager()

getCommand

public AwsIotDeviceCommandManager.Command getCommand()

getCommandId

public String getCommandId()

getResponse

public AWSIotMessage getResponse()

getRequestSent

public Boolean getRequestSent()

setResponse

public void setResponse(AWSIotMessage response)