de.dim.trafficos.device.api

Interface DevicesService

public interface DevicesService

Service to create or update a Device which should be triggered from the REST

Since:

30.05.2019

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TOPIC_DEVICE_STATUS

Method Summary

Modifier and Type	Method and Description
java.util.List<Device>	getActiveDevices()
java.util.List<Device>	getAllDevices()
java.util.List<DeviceConfiguration>	getConfigurations(java.lang.String deviceId) Delegates to the DeviceService::getConfigurations associated with the Device of provided id
DeviceConfiguration	getCurrentConfiguration(java.lang.String deviceId) Delegates to the DeviceService::getCurrentConfiguration associated with the Device of provided id
DataEntry	getCurrentDataEntry(java.lang.String deviceId, java.util.Date timestamp)
java.util.List<DataEntry>	getDataEntries(java.lang.String deviceId, java.util.Date startDate, java.util.Date endDate) Delegates to the DeviceService::getDataEntries associated with the Device of provided id
Device	getDeviceById(java.lang.String deviceId) Retrieves from the DB the Device with the given ID.
LifeCycleDeviceType	getStatus(java.lang.String deviceId) Returns the LifeCycleDeviceType associated with the Device of provided ID
void	initializeDevice(java.lang.String deviceId, boolean forceReload, boolean forceRestart) Delegates to the DeviceService::initialize
boolean	isRunning(java.lang.String deviceId) Delegates to the DeviceService::isRunning associated with the Device of provided id
void	removeDevice(java.lang.String deviceId) Removes the Device with the given ID, if it exists and notifies the EventAdmin, so it can trigger the removal of the corresponding DeviceService instance.
boolean	startDevice(java.lang.String deviceId) Delegates to the DeviceService::startDevice associated with the Device of provided id
boolean	stopDevice(java.lang.String deviceId) Delegates to the DeviceService::stopDevice associated with the Device of provided id
Device	updateDevice(Device device) Updates the given Device.
DeviceConfiguration	updateDeviceConfiguration(java.lang.String deviceId, DeviceConfiguration configuration) Delegates to the DeviceService::updateDeviceConfiguration associated with the Device of provided id
DeviceInfo	updateDeviceInformation(java.lang.String deviceId, DeviceInfo info) Delegates to the DeviceService::updateDeviceInformation associated with the Device of provided id

Field Detail

TOPIC_DEVICE_STATUS

static final java.lang.String TOPIC_DEVICE_STATUS

See Also:

Constant Field Values

Method Detail

getActiveDevices

java.util.List<Device> getActiveDevices()

Returns:

the list of all active devices, or an empty list, in case no active device was found.

getAllDevices

java.util.List<Device> getAllDevices()

Returns:

the list of all active devices, or an empty list, in case no active device was found.

getStatus

LifeCycleDeviceType getStatus(java.lang.String deviceId)

Returns the LifeCycleDeviceType associated with the Device of provided ID

Parameters:

deviceId - the ID of the Device whose Status we want to retrieve

Returns:

the LifeCycleDeviceType associated with the Device of provided ID

getDeviceById

Device getDeviceById(java.lang.String deviceId)

Retrieves from the DB the Device with the given ID. It returns null if the given ID is null or if no Device with such ID was found.

Parameters:

deviceId - the ID of the device we want to retrieve

Returns:

the Device with the provided ID or null, if none was found or the ID was null

updateDevice

Device updateDevice(Device device)

Updates the given Device. It returns null if the provided Device has a null ID. If no Device was found with the provided Device id, then the Device will be saved as a new Device, otherwise the Device with the same ID will be updated. Once updating a Device the corresponding DeviceService instance is updated.

Parameters:

device - the updated Device to be saved

Returns:

the updated Device

removeDevice

void removeDevice(java.lang.String deviceId)

Removes the Device with the given ID, if it exists and notifies the EventAdmin, so it can trigger the removal of the corresponding DeviceService instance.

Parameters:

deviceId - the ID of the Device to be removed

updateDeviceConfiguration

DeviceConfiguration updateDeviceConfiguration(java.lang.String deviceId,
                                              DeviceConfiguration configuration)

Delegates to the DeviceService::updateDeviceConfiguration associated with the Device of provided id

Parameters:

deviceId - the id of the Device whose Configuration has to be updated

configuration - the new DeviceConfiguration

Returns:

the updated DeviceConfiguration, or null if the corresponding DeviceService is not registered

updateDeviceInformation

DeviceInfo updateDeviceInformation(java.lang.String deviceId,
                                   DeviceInfo info)

Delegates to the DeviceService::updateDeviceInformation associated with the Device of provided id

Parameters:

deviceId - the id of the Device whose DeviceInfo has to be updated

configuration - the new DeviceInfo

Returns:

the updated DeviceInfo, or null if the corresponding DeviceService is not registered

getCurrentConfiguration

DeviceConfiguration getCurrentConfiguration(java.lang.String deviceId)

Delegates to the DeviceService::getCurrentConfiguration associated with the Device of provided id

Parameters:

deviceId - the id of the Device whose Configuration we want to know

Returns:

the current DeviceConfiguration associated with the Device of provided id, or null if the corresponding DeviceService is not registered

getConfigurations

java.util.List<DeviceConfiguration> getConfigurations(java.lang.String deviceId)

Delegates to the DeviceService::getConfigurations associated with the Device of provided id

Parameters:

deviceId - the id of the Device whose Configurations we want to know

Returns:

the list of Configurations associated with the Device of provided id, or null if the corresponding DeviceService is not registered

isRunning

boolean isRunning(java.lang.String deviceId)

Delegates to the DeviceService::isRunning associated with the Device of provided id

Parameters:

deviceId - the id of the Device

Returns:

true if the Device is running, false if the associated DeviceService is not registered, or if the Device is not running

startDevice

boolean startDevice(java.lang.String deviceId)
             throws DeviceException

Delegates to the DeviceService::startDevice associated with the Device of provided id

Parameters:

deviceId - the id of the Device

Throws:

DeviceException

stopDevice

boolean stopDevice(java.lang.String deviceId)
            throws DeviceException

Delegates to the DeviceService::stopDevice associated with the Device of provided id

Parameters:

deviceId - the id of the Device

Throws:

DeviceException

initializeDevice

void initializeDevice(java.lang.String deviceId,
                      boolean forceReload,
                      boolean forceRestart)
               throws DeviceException

Delegates to the DeviceService::initialize

Parameters:

deviceId - the Device id

forceReload - a boolean indicating whether a reload is required

forceRestart - a boolean indicating whether a restart is required

Throws:

DeviceException

getDataEntries

java.util.List<DataEntry> getDataEntries(java.lang.String deviceId,
                                         java.util.Date startDate,
                                         java.util.Date endDate)

Delegates to the DeviceService::getDataEntries associated with the Device of provided id

Parameters:

deviceId - the id of the Device

startDate - the start date

endDate - the end date

Returns:

the list of DataEntry associated with the Device and for the provided period of time, an empty list in case no DataEntry has been found, or the dates are inconsistent and null in case the corresponding DeviceService is not registered or

getCurrentDataEntry

DataEntry getCurrentDataEntry(java.lang.String deviceId,
                              java.util.Date timestamp)

Parameters:

deviceId - the Device id

timestamp - the current Date

Returns:

the DataEntry for the given Device ID and Date, or null, if no DataEntry was stored for the provided Device and time, or in case the deviceId is null