com.adobe.cq.screens.device

Interface DeviceManager

@ProviderType
public interface DeviceManager

Manages the devices in the repository.

Method Summary

Modifier and Type	Method and Description
void	acknowledgeCommand(Device device, java.lang.String command) Acknowledge the command for the specified device.
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	deleteLogs(Device device, java.lang.String type) Deletes the existing device logs from the repository.
void	executeCommand(Device device, java.lang.String command) Execute the desired command on the specified device.
void	executeCommand(Device device, java.lang.String command, JSONObject payload) Execute the desired command on the specified device.
void	executeCommand(Device device, java.lang.String command, JSONObject payload, boolean requiresAck) Execute the desired command on the specified device.
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(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.
java.util.Iterator<Device>	getRelatedDevices(Resource resource) Returns an iterator over all devices that are related to the specified Resource.
Device	removeDisplay(Device device, boolean removeConfig) Removes the display assignment from the device.
Device	saveLogs(Device device, java.lang.String type, java.io.InputStream data) Saves the provided device logs to the repository.
Device	saveScreenshot(Device device, java.io.InputStream data) Adds new screenshot content as a nt:file under device's profile_screens node
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

@CheckForNull
Device getDevice(@Nonnull
                               java.lang.String deviceId)

Returns the device with the given id or null

Parameters:

deviceId - the device id

Returns:

the device or null

getDeviceStatus

@CheckForNull
DeviceStatus getDeviceStatus(@Nonnull
                                           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

@Nonnull
java.util.Iterator<Device> getDevices()

Returns an iterator over all devices.

Returns:

an iterator.

getDevices

@Nonnull
java.util.Iterator<Device> getDevices(@Nullable
                                               Predicate predicate)

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

Parameters:

predicate - the filter predicate or null

Returns:

the iterator.

getRelatedDevices

@Nonnull
java.util.Iterator<Device> getRelatedDevices(@Nonnull
                                                      Resource resource)

Returns an iterator over all devices that are related to the specified Resource.

Parameters:

resource - the resource that the devices are related to

Returns:

the iterator.

createDevice

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

Creates a new device for the given tenant.

Parameters:

tenant - the name of the tenant. eg "we-retail".

Returns:

the newly created device

Throws:

RepositoryException - if an error occurrs.

deleteDevice

void deleteDevice(@Nonnull
                  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

@Nonnull
java.lang.String updatePassword(@Nonnull
                                         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

@Nonnull
Device setMetadata(@Nonnull
                            Device device,
                            @Nonnull
                            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

@Nonnull
Device assignDisplay(@Nonnull
                              Device device,
                              @Nonnull
                              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

@Nonnull
Device assignDeviceConfig(@Nonnull
                                   Device device,
                                   @Nonnull
                                   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

@Nonnull
Device removeDisplay(@Nonnull
                              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.

Returns:

the device for chaining.

Throws:

RepositoryException - if an error occurrs.

saveLogs

@Nonnull
Device saveLogs(@Nonnull
                         Device device,
                         @Nonnull
                         java.lang.String type,
                         @Nonnull
                         java.io.InputStream data)
                  throws RepositoryException

Saves the provided device logs to the repository.

Parameters:

device - the device

type - the type of logs to save

data - the log data

Returns:

the device for chaining.

Throws:

RepositoryException - if an error occurrs.

deleteLogs

@Nonnull
Device deleteLogs(@Nonnull
                           Device device,
                           @Nullable
                           java.lang.String type)
                    throws RepositoryException

Deletes the existing device logs from the repository.

Parameters:

device - the device

type - the type of logs to delete, if not specified all logs will be deleted

Returns:

the device for chaining.

Throws:

RepositoryException - if an error occurrs.

saveScreenshot

@Nonnull
Device saveScreenshot(@Nonnull
                               Device device,
                               @Nonnull
                               java.io.InputStream data)
                        throws RepositoryException

Adds new screenshot content as a nt:file under device's profile_screens node

Parameters:

device - the device

Returns:

the device for chaining.

Throws:

RepositoryException - if an error occurrs.

acknowledgeCommand

void acknowledgeCommand(@Nonnull
                        Device device,
                        @Nonnull
                        java.lang.String command)
                 throws RepositoryException

Acknowledge the command for the specified device.

Parameters:

device - the device for which the command is acknowledged

command - the command to acknowledge

Throws:

RepositoryException - if an error accessing the repository occurs.

executeCommand

void executeCommand(@Nonnull
                    Device device,
                    @Nonnull
                    java.lang.String command)
             throws RepositoryException

Execute the desired command on the specified device.

Parameters:

device - the device to execute the command on

command - the command to execute

Throws:

RepositoryException - if an error accessing the repository occurs.

executeCommand

void executeCommand(@Nonnull
                    Device device,
                    @Nonnull
                    java.lang.String command,
                    @Nullable
                    JSONObject payload)
             throws RepositoryException

Execute the desired command on the specified device.

Parameters:

device - the device to execute the command on

command - the command to execute

payload - the payload to add to the command. If null then the command doesn't have a payload.

Throws:

RepositoryException - if an error accessing the repository occurs.

executeCommand

void executeCommand(@Nonnull
                    Device device,
                    @Nonnull
                    java.lang.String command,
                    @Nullable
                    JSONObject payload,
                    boolean requiresAck)
             throws RepositoryException

Execute the desired command on the specified device.

Parameters:

device - the device to execute the command on

command - the command to execute

payload - the payload to add to the command. If null then the command doesn't have a payload.

requiresAck - whether the command requires acknowledgement that the device has processed it.

Throws:

RepositoryException - if an error accessing the repository occurs.