com.ibm.wiotp.sdk.devicemgmt.internal

Class ConcreteDeviceAction

java.lang.Object

com.ibm.wiotp.sdk.devicemgmt.internal.ConcreteDeviceAction

All Implemented Interfaces:

DeviceAction

public class ConcreteDeviceAction
extends Object
implements DeviceAction

This class encapsulates the device action like reboot and factory reset.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.wiotp.sdk.devicemgmt.DeviceAction

DeviceAction.Status

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEVICE_ACTION_STATUS_UPDATE

Constructor Summary

Constructors

Constructor and Description
ConcreteDeviceAction(String typeId, String deviceId)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Add a new listener to be notified when device action status is changed.
void	clearListener()
void	fireEvent(String event) Trigger the notification message - This method should only be used by the library code
String	getDeviceId()
String	getMessage()
int	getStatus()
String	getTypeId()
void	setMessage(String message)
void	setStatus(DeviceAction.Status status) Set the failure status of the current device action The Device Action handler must use this method to report the failure status back to IBM Watson IoT Platform whenever there is a failure.
void	setStatus(DeviceAction.Status status, String message) Set the failure status of the current device action The Device Action handler must use this method to report the failure status back to IBM Watson IoT Platform whenever there is a failure.
com.google.gson.JsonObject	toJsonObject() Return the JsonObject representation of the Listener Response object.
String	toString() Return the JSON string of the Listener Response object.

Methods inherited from class java.lang.Object

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

Field Detail

DEVICE_ACTION_STATUS_UPDATE

public static final String DEVICE_ACTION_STATUS_UPDATE

See Also:

Constant Field Values

Constructor Detail

ConcreteDeviceAction

public ConcreteDeviceAction(String typeId,
                            String deviceId)

Method Detail

getTypeId

public String getTypeId()

Specified by:

getTypeId in interface DeviceAction

getDeviceId

public String getDeviceId()

Specified by:

getDeviceId in interface DeviceAction

setStatus

public void setStatus(DeviceAction.Status status)

Set the failure status of the current device action
The Device Action handler must use this method to report the failure status back to IBM Watson IoT Platform whenever there is a failure.

Specified by:

setStatus in interface DeviceAction

Parameters:

status - Failure status of the current device action

setStatus

public void setStatus(DeviceAction.Status status,
                      String message)

Set the failure status of the current device action
The Device Action handler must use this method to report the failure status back to IBM Watson IoT Platform whenever there is a failure.

Specified by:

setStatus in interface DeviceAction

Parameters:

status - Failure status of the current device action

message - Failure message to be reported

getMessage

public String getMessage()

fireEvent

public void fireEvent(String event)

Trigger the notification message - This method should only be used by the library code

Parameters:

event - event to be fired

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a new listener to be notified when device action status is changed.

Parameters:

listener - PropertyChangeListener

clearListener

public void clearListener()

toJsonObject

public com.google.gson.JsonObject toJsonObject()

Return the JsonObject representation of the Listener Response object.

Returns:

JsonObject object

toString

public String toString()

Return the JSON string of the Listener Response object.

Overrides:

toString in class Object

getStatus

public int getStatus()

setMessage

public void setMessage(String message)

Specified by:

setMessage in interface DeviceAction