oracle.iot.client.enterprise

Class Device

java.lang.Object

oracle.iot.client.enterprise.Device

public abstract class Device
extends java.lang.Object

A Device lists the characteristics of a device.

See Also:

EnterpriseClient.getActiveDevices(String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Device.Field The Field enum defines the characteristics of a device.
static class	Device.Location The Device.Location describes the location of a device.

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<java.lang.String>	getDeviceModels() Get the list of device models supported by this device.
abstract java.lang.String	getId() Get the device identifier.
abstract Device.Location	getLocation() Return the device location.
abstract java.util.Map<java.lang.String,java.lang.String>	getMetadata() Return the device metadata.
abstract java.lang.String	getMetadata(java.lang.String key) Return the value of the metadata field key.
abstract java.lang.String	getValue(Device.Field field) Get the value of the specified field or an empty String if the value is unknown.
abstract boolean	isDirectlyConnected() Return whether the device is directly connected to the server or is connected through a gateway.

Methods inherited from class java.lang.Object

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

Method Detail

getDeviceModels

public abstract java.util.List<java.lang.String> getDeviceModels()

Get the list of device models supported by this device.

Returns:

a list of device model URN.

getValue

public abstract java.lang.String getValue(Device.Field field)

Get the value of the specified field or an empty String if the value is unknown.

Parameters:

field - the field to look for

Returns:

the field value or an empty String.

isDirectlyConnected

public abstract boolean isDirectlyConnected()

Return whether the device is directly connected to the server or is connected through a gateway.

Returns:

true if the device is directly connected, false otherwise.

getId

public abstract java.lang.String getId()

Get the device identifier.

Returns:

the device identifier.

getMetadata

public abstract java.util.Map<java.lang.String,java.lang.String> getMetadata()

Return the device metadata. Might be empty.

Returns:

a map of device metadata

getMetadata

public abstract java.lang.String getMetadata(java.lang.String key)

Return the value of the metadata field key.

Parameters:

key - the metadata key to return

Returns:

value for metadata key or null if not found.

getLocation

public abstract Device.Location getLocation()

Return the device location.

Returns:

the device location