de.iip_ecosphere.platform.support.iip_aas

Class AasPartRegistry.AasSetup

java.lang.Object

de.iip_ecosphere.platform.support.iip_aas.AasPartRegistry.AasSetup

Enclosing class:

AasPartRegistry

public static class AasPartRegistry.AasSetup
extends Object

The technical setup of the AAS/VAB endpoints as data class to be used with a usual configuration format/YAML parser. For local server setup/testing, server and registry shall point to the same server instance but with different endpoint paths (in memory registry). For a real installation, this information may differ. Typically, the implementation runs on localhost.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field and Description
private ProtocolAddressHolder	implementation
private AasPartRegistry.AasMode	mode
private EndpointHolder	registry
private EndpointHolder	server
private String	serverHost

Constructor Summary

Constructors

Constructor and Description
AasSetup() Default constructor.
AasSetup(AasPartRegistry.AasSetup setup) Copy constructor.

Method Summary

Modifier and Type	Method and Description
de.iip_ecosphere.platform.support.Endpoint	adaptEndpoint(de.iip_ecosphere.platform.support.Endpoint endpoint) Potentially adapts the endpoint with respect to getServerEndpoint().
static AasPartRegistry.AasSetup	createLocalEphemeralSetup() Returns a default setup with all hosts to ServerAddress.LOCALHOST and all ports to ephemeral while the registry port is the same as the aas port.
static AasPartRegistry.AasSetup	createLocalEphemeralSetup(AasPartRegistry.AasSetup setup, boolean regPortSame) Returns a default setup with all hosts to ServerAddress.LOCALHOST and all ports to ephemeral.
static <A extends AasPartRegistry.AasSetup> A	createLocalEphemeralSetup(A setup, boolean regPortSame, Supplier<A> supplier) Returns a default setup with all hosts to ServerAddress.LOCALHOST and all ports to ephemeral.
ProtocolAddressHolder	getImplementation() Returns the implementation (server) information.
String	getImplementationProtocol() Returns the implementation protocol.
de.iip_ecosphere.platform.support.ServerAddress	getImplementationServer() Returns the implementation server information as server address.
AasPartRegistry.AasMode	getMode() Returns the AAS mode.
EndpointHolder	getRegistry() Returns the AAS information.
de.iip_ecosphere.platform.support.Endpoint	getRegistryEndpoint() Returns the registry server information as endpoint.
EndpointHolder	getServer() Returns the AAS server information.
de.iip_ecosphere.platform.support.Endpoint	getServerEndpoint() Returns the AAS server information as endpoint.
String	getServerHost() Returns the server host.
void	setImplementation(ProtocolAddressHolder implementation) Defines the implementation (server) information.
void	setMode(AasPartRegistry.AasMode mode) Defines the AAS mode.
void	setRegistry(EndpointHolder registry) Defines the registry information.
void	setServer(EndpointHolder aas) Defines the AAS server information.
void	setServerHost(String serverHost) Changes the server host.

Methods inherited from class java.lang.Object

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

Field Detail

server

private EndpointHolder server

registry

private EndpointHolder registry

implementation

private ProtocolAddressHolder implementation

serverHost

private String serverHost

mode

private AasPartRegistry.AasMode mode

Constructor Detail

AasSetup

public AasSetup()

Default constructor.

AasSetup

public AasSetup(AasPartRegistry.AasSetup setup)

Copy constructor.

Parameters:

setup - the setup to copy from

Method Detail

getServerEndpoint

public de.iip_ecosphere.platform.support.Endpoint getServerEndpoint()

Returns the AAS server information as endpoint.

Returns:

the AAS server information as endpoint

getRegistryEndpoint

public de.iip_ecosphere.platform.support.Endpoint getRegistryEndpoint()

Returns the registry server information as endpoint.

Returns:

the registry server information as endpoint

getImplementationServer

public de.iip_ecosphere.platform.support.ServerAddress getImplementationServer()

Returns the implementation server information as server address.

Returns:

the implementation server information as server address

getImplementationProtocol

public String getImplementationProtocol()

Returns the implementation protocol.

Returns:

the implementation protocol (see AasFactory)

getServer

public EndpointHolder getServer()

Returns the AAS server information.

Returns:

the AAS server information

setServer

public void setServer(EndpointHolder aas)

Defines the AAS server information. [required by data mapper]

Parameters:

aas - the AAS server information

getRegistry

public EndpointHolder getRegistry()

Returns the AAS information. [required by data mapper]

Returns:

the AAS information

getMode

public AasPartRegistry.AasMode getMode()

Returns the AAS mode.

Returns:

the AAS mode

setMode

public void setMode(AasPartRegistry.AasMode mode)

Defines the AAS mode. [required by data mapper, snakeyaml]

Parameters:

mode - the AAS mode

getServerHost

public String getServerHost()

Returns the server host. Often, the address stated in server or registry is sufficient. However, if the devices shall use a specific address, while the server shall listen to multiple or all available IP addresses, the address to be used for server instance creation may have to be different, e.g., "localhost" rather than a specific IO.

Returns:

the server host, may be AasPartRegistry.NO_SPECIFIC_SERVER_HOST to indicate that the addresses in server or registry shall be used

adaptEndpoint

public de.iip_ecosphere.platform.support.Endpoint adaptEndpoint(de.iip_ecosphere.platform.support.Endpoint endpoint)

Potentially adapts the endpoint with respect to getServerEndpoint().

Parameters:

endpoint - the endpoint to be adapted

Returns:

the adapted endpoint or endpoint

setServerHost

public void setServerHost(String serverHost)

Changes the server host.

Parameters:

serverHost - the server host, may be AasPartRegistry.NO_SPECIFIC_SERVER_HOST to indicate that the addresses in server or registry shall be used

See Also:

getServerHost()

setRegistry

public void setRegistry(EndpointHolder registry)

Defines the registry information. [required by data mapper, snakeyaml]

Parameters:

registry - the registry information

getImplementation

public ProtocolAddressHolder getImplementation()

Returns the implementation (server) information. [required by data mapper, snakeyaml] For convenience, the port number may be invalid and is turned then into an ephemeral port.

Returns:

the implementation (server) information

setImplementation

public void setImplementation(ProtocolAddressHolder implementation)

Defines the implementation (server) information. [required by data mapper, snakeyaml]

Parameters:

implementation - the implementation (server) information

createLocalEphemeralSetup

public static AasPartRegistry.AasSetup createLocalEphemeralSetup()

Returns a default setup with all hosts to ServerAddress.LOCALHOST and all ports to ephemeral while the registry port is the same as the aas port.

Returns:

the local ephemeral setup

createLocalEphemeralSetup

public static AasPartRegistry.AasSetup createLocalEphemeralSetup(AasPartRegistry.AasSetup setup,
                                                                 boolean regPortSame)

Returns a default setup with all hosts to ServerAddress.LOCALHOST and all ports to ephemeral.

Parameters:

setup - the instance to set up (if null a new one is created)

regPortSame - shall the registry port be the same as the AAS port

Returns:

the local ephemeral setup

createLocalEphemeralSetup

public static <A extends AasPartRegistry.AasSetup> A createLocalEphemeralSetup(A setup,
                                                                               boolean regPortSame,
                                                                               Supplier<A> supplier)

Returns a default setup with all hosts to ServerAddress.LOCALHOST and all ports to ephemeral.

Type Parameters:

A - the AAS setup type

Parameters:

setup - the instance to set up (if null a new one is created via supplier)

regPortSame - shall the registry port be the same as the AAS port

supplier - a supplier for a new instance

Returns:

the local ephemeral setup