Package de.iip_ecosphere.platform.deviceMgt.registry

Class DeviceRegistryAas

java.lang.Object

de.iip_ecosphere.platform.deviceMgt.registry.DeviceRegistryAas

All Implemented Interfaces:

de.iip_ecosphere.platform.support.iip_aas.AasContributor

public class DeviceRegistryAas
extends Object
implements de.iip_ecosphere.platform.support.iip_aas.AasContributor

A Asset Administration Shell for device registry functionalities. Mostly called by DeviceManagement and devices itself.

Author:

Dennis Pidun, University of Hildesheim

Nested Class Summary

Nested classes/interfaces inherited from interface de.iip_ecosphere.platform.support.iip_aas.AasContributor

de.iip_ecosphere.platform.support.iip_aas.AasContributor.Kind

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME_COLL_DEVICE_REGISTRY
static final String	NAME_OP_DEVICE_ADD
static final String	NAME_OP_DEVICE_REMOVE
static final String	NAME_OP_IM_ALIVE
static final String	NAME_OP_SEND_TELEMETRY
static final String	NAME_PROP_DEVICE_IP
static final String	NAME_PROP_DEVICE_RESOURCE
static final String	NAME_PROP_MANAGED_DEVICE_ID
static final String	NAME_SUBMODEL

Constructor Summary

Constructors

Constructor	Description
DeviceRegistryAas()

Method Summary

Modifier and Type	Method	Description
de.iip_ecosphere.platform.support.aas.Aas	contributeTo(de.iip_ecosphere.platform.support.aas.Aas.AasBuilder aasBuilder, de.iip_ecosphere.platform.support.aas.InvocablesCreator iCreator)	Basically registers the aas for the device registry.
void	contributeTo(de.iip_ecosphere.platform.support.aas.ProtocolServerBuilder sBuilder)	Defines the operations details.
de.iip_ecosphere.platform.support.iip_aas.AasContributor.Kind	getKind()	This aas is a Kind.ACTIVE.
private static String	getQName(String name)	Returns a qualified name within this submodel.
boolean	isValid()	In case this code is used as library one doesn't want that the aas is setup.
static void	notifyDeviceAdded(String managedId, String resourceId, String resourceIp)	Notify the DeviceRegistryAas if a device was added, so it can manage and build dynamic parts for this device.
static void	notifyDeviceRemoved(String resourceId)	Notify the DeviceRegistryAas if a device was removed, so it can remove entries of the managed device.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.iip_ecosphere.platform.support.iip_aas.AasContributor

exists, getAasAuthentication, getSubmodelAuthentication

Field Details

NAME_SUBMODEL

public static final String NAME_SUBMODEL

See Also:

• Constant Field Values

NAME_COLL_DEVICE_REGISTRY

public static final String NAME_COLL_DEVICE_REGISTRY

See Also:

• Constant Field Values

NAME_PROP_DEVICE_RESOURCE

public static final String NAME_PROP_DEVICE_RESOURCE

See Also:

• Constant Field Values

NAME_PROP_MANAGED_DEVICE_ID

public static final String NAME_PROP_MANAGED_DEVICE_ID

See Also:

• Constant Field Values

NAME_PROP_DEVICE_IP

public static final String NAME_PROP_DEVICE_IP

See Also:

• Constant Field Values

NAME_OP_DEVICE_ADD

public static final String NAME_OP_DEVICE_ADD

See Also:

• Constant Field Values

NAME_OP_DEVICE_REMOVE

public static final String NAME_OP_DEVICE_REMOVE

See Also:

• Constant Field Values

NAME_OP_IM_ALIVE

public static final String NAME_OP_IM_ALIVE

See Also:

• Constant Field Values

NAME_OP_SEND_TELEMETRY

public static final String NAME_OP_SEND_TELEMETRY

See Also:

• Constant Field Values

Constructor Details

DeviceRegistryAas

public DeviceRegistryAas()

Method Details

contributeTo

public de.iip_ecosphere.platform.support.aas.Aas contributeTo(de.iip_ecosphere.platform.support.aas.Aas.AasBuilder aasBuilder,
 de.iip_ecosphere.platform.support.aas.InvocablesCreator iCreator)

Basically registers the aas for the device registry.

Specified by:

contributeTo in interface de.iip_ecosphere.platform.support.iip_aas.AasContributor

Parameters:

aasBuilder - the aasBuilder to contributeTo

iCreator - an InvocablesCreator

Returns:

null

contributeTo

public void contributeTo(de.iip_ecosphere.platform.support.aas.ProtocolServerBuilder sBuilder)

Defines the operations details.

Specified by:

contributeTo in interface de.iip_ecosphere.platform.support.iip_aas.AasContributor

Parameters:

sBuilder - the ProtocolServerBuilder

getQName

private static String getQName(String name)

Returns a qualified name within this submodel.

Parameters:

name - the name to be turned into a qualified name

Returns:

the qualified name

getKind

public de.iip_ecosphere.platform.support.iip_aas.AasContributor.Kind getKind()

This aas is a Kind.ACTIVE.

Specified by:

getKind in interface de.iip_ecosphere.platform.support.iip_aas.AasContributor

Returns:

Kind.ACTIVE.

isValid

public boolean isValid()

In case this code is used as library one doesn't want that the aas is setup.

Specified by:

isValid in interface de.iip_ecosphere.platform.support.iip_aas.AasContributor

Returns:

true if code based is not used as a library and the aas should be deployed.

notifyDeviceAdded

public static void notifyDeviceAdded(String managedId,
 String resourceId,
 String resourceIp)

Notify the DeviceRegistryAas if a device was added, so it can manage and build dynamic parts for this device.

Parameters:

managedId - the internal/managed id, could be the same as resourceId

resourceId - the resource id

resourceIp - the ip address of the resource

notifyDeviceRemoved

public static void notifyDeviceRemoved(String resourceId)

Notify the DeviceRegistryAas if a device was removed, so it can remove entries of the managed device.

Parameters:

resourceId - the id of the resource