com.adobe.cq.screens.device

Interface DeviceManager

public interface DeviceManager

Manages the devices in the repository.

Method Summary

Modifier and Type	Method and Description
Device	assignDeviceConfig(Device device, DeviceConfig config) Assigns a device to an existing device config.
Device	assignDisplay(Device device, java.lang.String displayPath) Assigns a display to a device and creates a new DeviceConfig.
Device	createDevice(java.lang.String tenant) Creates a new device for the given tenant.
void	deleteDevice(java.lang.String deviceId) Deletes an existing device, and removes any existing assignment to a display.
Device	getDevice(java.lang.String deviceId) Returns the device with the given id or null
java.util.Iterator<Device>	getDevices() Returns an iterator over all devices.
java.util.Iterator<Device>	getDevices(org.apache.commons.collections.Predicate predicate) Returns an iterator over all devices that fulfill the given predicate.
DeviceStatus	getDeviceStatus(java.lang.String deviceId) Returns the status of the device with the given id.
Device	removeDisplay(Device device, boolean removeConfig) Removes the display assignment from the device.
Device	setMetadata(Device device, JSONObject metadata) Updates the device metadata.
java.lang.String	updatePassword(Device device) Generates and sets a new password for the device user.

Method Detail

getDevice

Device getDevice(java.lang.String deviceId)

Returns the device with the given id or null

Parameters:

deviceId - the device id

Returns:

the device or null

getDeviceStatus

DeviceStatus getDeviceStatus(java.lang.String deviceId)

Returns the status of the device with the given id.

Parameters:

deviceId - the device id

Returns:

status or null if the device does not exist.

getDevices

java.util.Iterator<Device> getDevices()

Returns an iterator over all devices.

Returns:

an iterator.

getDevices

java.util.Iterator<Device> getDevices(org.apache.commons.collections.Predicate predicate)

Returns an iterator over all devices that fulfill the given predicate.

Parameters:

predicate - the filter predicate or null

Returns:

the iterator.

createDevice

Device createDevice(java.lang.String tenant)
             throws RepositoryException

Creates a new device for the given tenant.

Parameters:

tenant - the name of the tenant. eg "geometrixx".

Returns:

the newly created device

Throws:

RepositoryException - if an error occurrs.

deleteDevice

void deleteDevice(java.lang.String deviceId)
           throws RepositoryException

Deletes an existing device, and removes any existing assignment to a display.

Parameters:

deviceId - the device id

Throws:

RepositoryException - if an error occurrs.

updatePassword

java.lang.String updatePassword(Device device)
                         throws RepositoryException

Generates and sets a new password for the device user.

Parameters:

device - the device

Returns:

the new password

Throws:

RepositoryException - if an error occurrs.

setMetadata

Device setMetadata(Device device,
                   JSONObject metadata)
            throws JSONException,
                   RepositoryException

Updates the device metadata.

Parameters:

device - the device

metadata - the metadata.

Returns:

the device for chaining.

Throws:

JSONException - if a JSON error occurrs

RepositoryException - if an error occurrs

assignDisplay

Device assignDisplay(Device device,
                     java.lang.String displayPath)
              throws RepositoryException

Assigns a display to a device and creates a new DeviceConfig.

Parameters:

device - the device

displayPath - the display path

Returns:

the device for chaining.

Throws:

RepositoryException - if an error occurrs.

assignDeviceConfig

Device assignDeviceConfig(Device device,
                          DeviceConfig config)
                   throws RepositoryException

Assigns a device to an existing device config.

Parameters:

device - the device

config - the device config

Returns:

the device for chaining.

Throws:

RepositoryException - if an error occurrs.

removeDisplay

Device removeDisplay(Device device,
                     boolean removeConfig)
              throws RepositoryException

Removes the display assignment from the device.

Parameters:

device - the device

removeConfig - true to also remove the device config from the display.4

Returns:

the device for chaining.

Throws:

RepositoryException - if an error occurrs.