com.ibm.wiotp.sdk.devicemgmt

Class DeviceFirmware

java.lang.Object

com.ibm.wiotp.sdk.devicemgmt.resource.Resource

com.ibm.wiotp.sdk.devicemgmt.DeviceFirmware

public class DeviceFirmware
extends Resource

Device Firmware as specified in Watson IoT Platform Device Model. The following attributes are present as part of the Device Firmware,

• mgmt.firmware.version
• mgmt.firmware.name
• mgmt.firmware.url
• mgmt.firmware.verifier
• mgmt.firmware.state
• mgmt.firmware.updateStatus
• mgmt.firmware.updatedDateTime

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceFirmware.Builder A Builder class that helps to build the Device Firmware object
static class	DeviceFirmware.FirmwareState The firmware update process is separated into two distinct actions, Downloading Firmware, and Updating Firmware.
static class	DeviceFirmware.FirmwareUpdateStatus The mgmt.firmware.updateStatus attribute describes the status of firmware update.

Nested classes/interfaces inherited from class com.ibm.wiotp.sdk.devicemgmt.resource.Resource

Resource.ChangeListenerType

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_NAME

Fields inherited from class com.ibm.wiotp.sdk.devicemgmt.resource.Resource

RESPONSE_TIMEOUT, ROOT_RESOURCE_NAME

Method Summary

Modifier and Type	Method and Description
String	getDeviceId()
String	getName() Returns the name of the firmware
int	getState() Returns the firmware state
String	getTypeId()
int	getUpdateStatus() Returns the Firmware Update status
String	getUrl() Returns the firmware URL
String	getVerifier() Returns the firmware Verifier
String	getVersion() returns the version of the firmware
void	setName(String name) Set the name of the firmware
void	setState(DeviceFirmware.FirmwareState state) Set the firmware state
void	setUpdateStatus(DeviceFirmware.FirmwareUpdateStatus updateStatus) Set the Firmware Update status
void	setUrl(String url) Set the firmware URL
void	setVerifier(String verifier) Set the firmware verifier
void	setVersion(String version) Set the firmware with the given version
com.google.gson.JsonObject	toJsonObject()
String	toString()
int	update(DeviceFirmware firmware) Update the Firmware object with new values
int	update(com.google.gson.JsonElement firmware) Update the Firmware object with new values
int	update(com.google.gson.JsonElement firmware, boolean fireEvent) Update the Firmware object with new values

Methods inherited from class com.ibm.wiotp.sdk.devicemgmt.resource.Resource

add, addPropertyChangeListener, addPropertyChangeListener, fireEvent, fireEvent, getCanonicalName, getChild, getChildren, getParent, getRC, getResourceName, getResponseRequired, getValue, notifyExternalListeners, remove, remove, removePropertyChangeListener, setParent, setRC, setValue, setValue, waitForResponse

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_NAME

public static final String RESOURCE_NAME

See Also:

Constant Field Values

Method Detail

update

public int update(DeviceFirmware firmware)

Update the Firmware object with new values

Parameters:

firmware - The device firmware object to be updated

Returns:

code indicating whether the update is successful or not (200 means success, otherwise unsuccessful)

update

public int update(com.google.gson.JsonElement firmware)

Update the Firmware object with new values

Specified by:

update in class Resource

Parameters:

firmware - The device firmware object to be updated

Returns:

code indicating whether the update is successful or not (200 means success, otherwise unsuccessful)

update

public int update(com.google.gson.JsonElement firmware,
                  boolean fireEvent)

Update the Firmware object with new values

Specified by:

update in class Resource

Parameters:

firmware - The device firmware object to be updated

fireEvent - - whether to fire an update event of not

Returns:

code indicating whether the update is successful or not (200 means success, otherwise unsuccessful)

getVersion

public String getVersion()

returns the version of the firmware

Returns:

version

setVersion

public void setVersion(String version)

Set the firmware with the given version

Parameters:

version - version to be updated

getUrl

public String getUrl()

Returns the firmware URL

Returns:

String the Firmware URL

setUrl

public void setUrl(String url)

Set the firmware URL

Parameters:

url - URL that needs to be set

getVerifier

public String getVerifier()

Returns the firmware Verifier

Returns:

String returns the Firmware verifier or null

setVerifier

public void setVerifier(String verifier)

Set the firmware verifier

Parameters:

verifier - verifier that needs to be set

getState

public int getState()

Returns the firmware state

Returns:

returns the state of the Firmware

setState

public void setState(DeviceFirmware.FirmwareState state)

Set the firmware state

Parameters:

state - the state needs to be set

getName

public String getName()

Returns the name of the firmware

Returns:

returns the name of the firmware

setName

public void setName(String name)

Set the name of the firmware

Parameters:

name - The name of the firmware to be set to

getUpdateStatus

public int getUpdateStatus()

Returns the Firmware Update status

Returns:

Returns the Firmware Update status.

setUpdateStatus

public void setUpdateStatus(DeviceFirmware.FirmwareUpdateStatus updateStatus)

Set the Firmware Update status

Parameters:

updateStatus - the firmware update status to be set to

toJsonObject

public com.google.gson.JsonObject toJsonObject()

Specified by:

toJsonObject in class Resource

Returns:

JsonObject of the DeviceInfo

toString

public String toString()

Overrides:

toString in class Object

Returns:

JSON string of the DeviceInfo

getDeviceId

public String getDeviceId()

getTypeId

public String getTypeId()