Package com.cumulocity.sdk.client.devicecontrol

Class DeviceCredentialsApiImpl

java.lang.Object

com.cumulocity.sdk.client.devicecontrol.DeviceCredentialsApiImpl

All Implemented Interfaces:

DeviceCredentialsApi

public class DeviceCredentialsApiImpl
extends Object
implements DeviceCredentialsApi

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEVICE_CREDENTIALS_URI
static String	DEVICE_REQUEST_URI

Constructor Summary

Constructors

Constructor	Description
DeviceCredentialsApiImpl(PlatformParameters platformParameters, RestConnector restConnector)

Method Summary

Modifier and Type	Method	Description
void	delete(NewDeviceRequestRepresentation representation)	Remove a device registration.
DeviceCredentialsRepresentation	pollCredentials(String deviceId)	Executes single request to credentials endpoint
DeviceCredentialsRepresentation	pollCredentials(String deviceId, int interval, int timeout)	Schedule polling credentials task, invoking it at the specified execution time and subsequently with the given interval Execution will end after timeout
DeviceCredentialsRepresentation	pollCredentials(String deviceId, PollingStrategy pollingStrategy)	Device poll credentials
NewDeviceRequestRepresentation	register(String id)	Register a new device.

Methods inherited from class java.lang.Object

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

Field Detail

DEVICE_CREDENTIALS_URI

public static final String DEVICE_CREDENTIALS_URI

See Also:

Constant Field Values

DEVICE_REQUEST_URI

public static final String DEVICE_REQUEST_URI

See Also:

Constant Field Values

Constructor Detail

DeviceCredentialsApiImpl

public DeviceCredentialsApiImpl(PlatformParameters platformParameters,
                                RestConnector restConnector)

Method Detail

register

public NewDeviceRequestRepresentation register(String id)

Description copied from interface: DeviceCredentialsApi

Register a new device.

Specified by:

register in interface DeviceCredentialsApi

Parameters:

id - external id of the device to register

Returns:

new device request representation

delete

public void delete(NewDeviceRequestRepresentation representation)

Description copied from interface: DeviceCredentialsApi

Remove a device registration.

Specified by:

delete in interface DeviceCredentialsApi

Parameters:

representation - representation of new device request to delete

pollCredentials

public DeviceCredentialsRepresentation pollCredentials(String deviceId)

Description copied from interface: DeviceCredentialsApi

Executes single request to credentials endpoint

Specified by:

pollCredentials in interface DeviceCredentialsApi

Parameters:

deviceId - device unique identifier

Returns:

device credentials representation

pollCredentials

public DeviceCredentialsRepresentation pollCredentials(String deviceId,
                                                       int interval,
                                                       int timeout)

Description copied from interface: DeviceCredentialsApi

Schedule polling credentials task, invoking it at the specified execution time and subsequently with the given interval Execution will end after timeout

Specified by:

pollCredentials in interface DeviceCredentialsApi

Parameters:

deviceId - device unique identifier

interval - - how often request is sent in seconds

timeout - - after how many seconds polling process will expire

Returns:

device credentials representation

pollCredentials

public DeviceCredentialsRepresentation pollCredentials(String deviceId,
                                                       PollingStrategy pollingStrategy)

Description copied from interface: DeviceCredentialsApi

Device poll credentials

Specified by:

pollCredentials in interface DeviceCredentialsApi

Parameters:

deviceId - device unique identifier

pollingStrategy - credentials polling strategy

Returns:

device credentials representation