com.sitewhere.spi.device.communication

Interface IRegistrationManager

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

public interface IRegistrationManager
extends ITenantLifecycleComponent

Manages how devices are dynamically registered into the system.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAutoAssignSiteToken() Gets the token used for automatic site assignment.
void	handleDeviceMapping(java.lang.String hardwareId, IDeviceMappingCreateRequest request) Handle mapping of a device to a path on a composite device.
void	handleDeviceRegistration(IDeviceRegistrationRequest request) Handle registration of a new device.
boolean	isAllowNewDevices() Indicates whether the registration manager allows new devices to be created as a byproduct of the registration process.
boolean	isAutoAssignSite() Indicates whether all new regsitrations can be automatically assigned to a given site.

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent

getTenant, setTenant

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent

canPause, findComponentsOfType, getComponentId, getComponentName, getComponentType, getCreatedDate, getLifecycleComponents, getLifecycleError, getLifecycleStatus, getLogger, initialize, initializeNestedComponent, lifecycleInitialize, lifecyclePause, lifecycleStart, lifecycleStop, lifecycleStop, logState, pause, start, startNestedComponent, stop, stop

Method Detail

isAllowNewDevices

boolean isAllowNewDevices()

Indicates whether the registration manager allows new devices to be created as a byproduct of the registration process.

Returns:

isAutoAssignSite

boolean isAutoAssignSite()

Indicates whether all new regsitrations can be automatically assigned to a given site. If not, the site token must be passed as part of the registration payload.

Returns:

getAutoAssignSiteToken

java.lang.String getAutoAssignSiteToken()

Gets the token used for automatic site assignment. This only applies when 'auto assign site' is set to true.

Returns:

handleDeviceRegistration

void handleDeviceRegistration(IDeviceRegistrationRequest request)
                       throws SiteWhereException

Handle registration of a new device.

Parameters:

request -

Throws:

SiteWhereException

handleDeviceMapping

void handleDeviceMapping(java.lang.String hardwareId,
                         IDeviceMappingCreateRequest request)
                  throws SiteWhereException

Handle mapping of a device to a path on a composite device.

Parameters:

hardwareId -

request -

Throws:

SiteWhereException