com.oracle.iot.client.enterprise

Class DeviceApp

java.lang.Object

com.oracle.iot.client.enterprise.DeviceApp

public abstract class DeviceApp
extends java.lang.Object

A DeviceApp represents an application, running on a device, and implementing its own device model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceApp.Field The Field enum defines the characteristics of a device.

Constructor Summary

Constructors

Constructor and Description
DeviceApp()

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 endpoint.
abstract java.lang.String	getId() Get the endpoint identifier.
abstract java.util.Map<java.lang.String,java.lang.String>	getMetadata() Return the endpoint metadata.
abstract java.lang.String	getMetadata(java.lang.String key) Return the value of the metadata field key.
abstract java.lang.String	getValue(DeviceApp.Field field) Get the value of the specified field or an empty String if the value is unknown.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceApp

public DeviceApp()

Method Detail

getId

public abstract java.lang.String getId()

Get the endpoint identifier.

Returns:

the endpoint identifier.

getMetadata

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

Return the endpoint 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.

getDeviceModels

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

Get the list of device models supported by this endpoint.

Returns:

a list of device model URN.

getValue

public abstract java.lang.String getValue(DeviceApp.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.