de.iip_ecosphere.platform.support.iip_aas

Class NetworkManagerAas

java.lang.Object

de.iip_ecosphere.platform.support.iip_aas.NetworkManagerAas

All Implemented Interfaces:

AasContributor

public class NetworkManagerAas
extends Object
implements AasContributor

Builds an active AAS for the NetworkManager.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	NetworkManagerAas.ManagedServerAddressHolder A proxy for ManagedServerAddress as we do not want to have setters there.

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

AasContributor.Kind

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_SUBMODEL
static String	OP_GET_PORT
static String	OP_IS_IN_USE_ADR
static String	OP_IS_IN_USE_PORT
static String	OP_OBTAIN_PORT
static String	OP_RELEASE_PORT
static String	OP_RESERVE_PORT
static String	PROP_HIGH_PORT
static String	PROP_LOW_PORT

Constructor Summary

Constructors

Constructor and Description
NetworkManagerAas()

Method Summary

Modifier and Type	Method and 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) Contribute to the given aasBuilder.
void	contributeTo(de.iip_ecosphere.platform.support.aas.ProtocolServerBuilder sBuilder) Contributes the real implementation functions to the sBuilder.
AasContributor.Kind	getKind() Returns the kind of AAS being created.
static String	getQName(String elementName) Returns the qualified name for an operation/property implementation.
boolean	isValid() Allow the AAS contributor to declare itself as invalid.
static de.iip_ecosphere.platform.support.net.ManagedServerAddress	managedServerAddressFromJson(Object json) Reads a ManagedServerAddress from a JSON string.
static String	toJson(de.iip_ecosphere.platform.support.net.ManagedServerAddress address) Turns a ManagedServerAddress into JSON.

Methods inherited from class java.lang.Object

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

Field Detail

NAME_SUBMODEL

public static final String NAME_SUBMODEL

See Also:

Constant Field Values

OP_RELEASE_PORT

public static final String OP_RELEASE_PORT

See Also:

Constant Field Values

OP_IS_IN_USE_PORT

public static final String OP_IS_IN_USE_PORT

See Also:

Constant Field Values

OP_IS_IN_USE_ADR

public static final String OP_IS_IN_USE_ADR

See Also:

Constant Field Values

OP_GET_PORT

public static final String OP_GET_PORT

See Also:

Constant Field Values

PROP_HIGH_PORT

public static final String PROP_HIGH_PORT

See Also:

Constant Field Values

PROP_LOW_PORT

public static final String PROP_LOW_PORT

See Also:

Constant Field Values

OP_OBTAIN_PORT

public static final String OP_OBTAIN_PORT

See Also:

Constant Field Values

OP_RESERVE_PORT

public static final String OP_RESERVE_PORT

See Also:

Constant Field Values

Constructor Detail

NetworkManagerAas

public NetworkManagerAas()

Method Detail

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)

Description copied from interface: AasContributor

Contribute to the given aasBuilder.

Specified by:

contributeTo in interface AasContributor

Parameters:

aasBuilder - the AAS to contribute to

iCreator - the invocables creator for binding (remote) property and operation implementations. Property and function namesshall be qualified by the AAS short id.

Returns:

the contributor may ignore aasBuilder and create an own AAS and return that. If this contributor just contributes to the aasBuilder the result shall be null

contributeTo

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

Description copied from interface: AasContributor

Contributes the real implementation functions to the sBuilder. Names used for the iCreator in #contributeTo(AasBuilder, InvocablesCreator) must be the same as used here. Property and function names shall be qualified by the AAS short id.

Specified by:

contributeTo in interface AasContributor

Parameters:

sBuilder - the server builder

getQName

public static String getQName(String elementName)

Returns the qualified name for an operation/property implementation.

Parameters:

elementName - the element name

Returns:

the qualified name

managedServerAddressFromJson

public static de.iip_ecosphere.platform.support.net.ManagedServerAddress managedServerAddressFromJson(Object json)

Reads a ManagedServerAddress from a JSON string.

Parameters:

json - the JSON object, usually a String

Returns:

the server address or null if reading fails

toJson

public static String toJson(de.iip_ecosphere.platform.support.net.ManagedServerAddress address)

Turns a ManagedServerAddress into JSON.

Parameters:

address - the address (may be null)

Returns:

the JSON string or an empty string in case of problems/no address

getKind

public AasContributor.Kind getKind()

Description copied from interface: AasContributor

Returns the kind of AAS being created. This is helpful for filtering.

Specified by:

getKind in interface AasContributor

Returns:

the kind of AAS

isValid

public boolean isValid()

Description copied from interface: AasContributor

Allow the AAS contributor to declare itself as invalid.

Specified by:

isValid in interface AasContributor

Returns:

true as prerequisite to execute AasContributor.contributeTo(ProtocolServerBuilder) and #contributeTo(AasBuilder, InvocablesCreator), false else