oracle.iot.client.enterprise

Class VirtualDevice

java.lang.Object

oracle.iot.client.AbstractVirtualDevice<VirtualDevice>

oracle.iot.client.enterprise.VirtualDevice

public abstract class VirtualDevice
extends AbstractVirtualDevice<VirtualDevice>

VirtualDevice for an enterprise-client adds methods to execute a write-only or executable attribute.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VirtualDevice.AlertCallback A callback interface for receiving notification of an Alert.
static class	VirtualDevice.AlertEvent An event passed to the AlertCallback.
static interface	VirtualDevice.DataCallback A callback interface for receiving notification of custom data.
static class	VirtualDevice.DataEvent An event passed to the DataCallback.

Nested classes/interfaces inherited from class oracle.iot.client.AbstractVirtualDevice

AbstractVirtualDevice.ChangeCallback<V>, AbstractVirtualDevice.ChangeEvent<V>, AbstractVirtualDevice.ErrorCallback<V>, AbstractVirtualDevice.ErrorEvent<V>, AbstractVirtualDevice.Event<V>, AbstractVirtualDevice.NamedValue<T>

Method Summary

Modifier and Type	Method and Description
abstract void	call(java.lang.String actionName) Deprecated. Use createAction(String)
abstract <T> void	call(java.lang.String actionName, T data) Deprecated. This method does not support multiple arguments. Use createAction(String)
abstract Action	createAction(java.lang.String actionName) Create an Action for this VirtualDevice.
abstract void	setOnAlert(java.lang.String formatURN, VirtualDevice.AlertCallback callback) Set a callback that is invoked when an alert for the given format URN is received.
abstract void	setOnAlert(VirtualDevice.AlertCallback callback) Set a callback that is invoked when any alert in the device model is received.
abstract void	setOnData(java.lang.String formatURN, VirtualDevice.DataCallback callback) Set a callback that is invoked when custom data for the given format URN is received.
abstract void	setOnData(VirtualDevice.DataCallback callback) Set a callback that is invoked when any custom data in the device model is received.

Methods inherited from class oracle.iot.client.AbstractVirtualDevice

finish, get, getDeviceModel, getEndpointId, getLastKnown, set, setOnChange, setOnChange, setOnError, setOnError, update

Methods inherited from class java.lang.Object

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

Method Detail

call

@Deprecated
public abstract <T> void call(java.lang.String actionName,
                                          T data)

Deprecated. This method does not support multiple arguments. Use createAction(String)

Execute an action with the given data.

Type Parameters:

T - the data type

Parameters:

actionName - The name of the action

data - The data to send to the action

call

@Deprecated
public abstract void call(java.lang.String actionName)

Deprecated. Use createAction(String)

Execute an action with no data.

Parameters:

actionName - The name of the action

setOnAlert

public abstract void setOnAlert(java.lang.String formatURN,
                                VirtualDevice.AlertCallback callback)

Set a callback that is invoked when an alert for the given format URN is received.

Note that it is possible to set a callback for a specific alert and to set a callback for all alerts via setOnAlert(VirtualDevice.AlertCallback). If there is a callback for the specific alert and for all alerts, both callbacks will be invoked.

Parameters:

formatURN - The alert format URN from the device model

callback - a callback to invoke when an alert is received with the format URN, if null, the existing callback will be removed

See Also:

setOnAlert(VirtualDevice.AlertCallback)

setOnAlert

public abstract void setOnAlert(VirtualDevice.AlertCallback callback)

Set a callback that is invoked when any alert in the device model is received.

Note that it is possible to set a callback for a specific alert via setOnAlert(String, VirtualDevice.AlertCallback). If there is a callback for the specific alert and for all alerts, both callbacks will be invoked.

Parameters:

callback - a callback to invoke when an alert is received, if null, the existing callback will be removed

See Also:

setOnAlert(VirtualDevice.AlertCallback)

setOnData

public abstract void setOnData(java.lang.String formatURN,
                               VirtualDevice.DataCallback callback)

Set a callback that is invoked when custom data for the given format URN is received.

Note that it is possible to set a callback for a specific data format and to set a callback for all formats via setOnData(VirtualDevice.DataCallback). If there is a callback for the specific data and for all formats, both callbacks will be invoked.

Parameters:

formatURN - The data format URN from the device model

callback - a callback to invoke when custom data is received with the format URN, if null, the existing callback will be removed

See Also:

setOnData(VirtualDevice.DataCallback)

setOnData

public abstract void setOnData(VirtualDevice.DataCallback callback)

Set a callback that is invoked when any custom data in the device model is received.

Note that it is possible to set a callback for a specific data format via setOnData(String, VirtualDevice.DataCallback). If there is a callback for the specific data and for all formats, both callbacks will be invoked.

Parameters:

callback - a callback to invoke when custom data is received, if null, the existing callback will be removed

See Also:

setOnData(VirtualDevice.DataCallback)

createAction

public abstract Action createAction(java.lang.String actionName)

Create an Action for this VirtualDevice. The action will be created for the named action in the device model.

Parameters:

actionName - the name of the action.

Returns:

an Action