de.iip_ecosphere.platform.support.iip_aas

Interface IdProvider

All Known Implementing Classes:

MacIdProvider

public interface IdProvider

Provides the device id.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_PARAM_NAME

Method Summary

Modifier and Type	Method and Description
boolean	allowsConsoleOverride() Returns whether the console parameter "--"iip.id"" may override the value of this provider.
String	provideId() Returns the id of this device.

Field Detail

ID_PARAM_NAME

static final String ID_PARAM_NAME

See Also:

Constant Field Values

Method Detail

provideId

String provideId()

Returns the id of this device. As the ID is also used as shortId in the platform AAS, it may be that the AAS implementation adjusts the ID to comply with the AAS id rules. Thus, it may be adequate that the returned ID already complies with these rules, e.g., must start with a character.

Returns:

the id, may be null if for some reason the ID cannot be provided and a fallback shall be used

allowsConsoleOverride

boolean allowsConsoleOverride()

Returns whether the console parameter "--"iip.id"" may override the value of this provider.

Returns:

true for override, false else