Package de.iip_ecosphere.platform.support.iip_aas

Class MacIdProvider

java.lang.Object

de.iip_ecosphere.platform.support.iip_aas.MacIdProvider

All Implemented Interfaces:

IdProvider

public class MacIdProvider
extends Object
implements IdProvider

A MAC-based device ID provider.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MacIdProvider.MacIdProviderDescriptor	Implements the provider descriptor.

Field Summary

Fields inherited from interface de.iip_ecosphere.platform.support.iip_aas.IdProvider

ID_PARAM_NAME

Constructor Summary

Constructors

Constructor	Description
MacIdProvider()

Method Summary

Modifier and Type	Method	Description
private void	addAddress(NetworkInterface ni, List<String> addresses)	Adds the hardware address of ni to addresses if possible.
boolean	allowsConsoleOverride()	Returns whether the console parameter "--"iip.id"" may override the value of this provider.
String	provideId()	Returns the id of this device.

Methods inherited from class java.lang.Object

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

Constructor Details

MacIdProvider

public MacIdProvider()

Method Details

provideId

public String provideId()

Description copied from interface: IdProvider

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.

Specified by:

provideId in interface IdProvider

Returns:

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

addAddress

private void addAddress(NetworkInterface ni,
 List<String> addresses)

Adds the hardware address of ni to addresses if possible.

Parameters:

ni - the network interface

addresses - the list of addresses to be modified as a side effect

allowsConsoleOverride

public boolean allowsConsoleOverride()

Description copied from interface: IdProvider

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

Specified by:

allowsConsoleOverride in interface IdProvider

Returns:

true for override, false else