de.iip_ecosphere.platform.support.iip_aas

Class AasPartRegistry

java.lang.Object

de.iip_ecosphere.platform.support.iip_aas.AasPartRegistry

public class AasPartRegistry
extends Object

A registry for AasContributor instances to be loaded via the Java Service loader.

Author:

Holger Eichelberger, SSE

See Also:

ExcludeFirst

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AasPartRegistry.AasBuildResult Represents the result of building the platform AAS.
static class	AasPartRegistry.AasMode Aas installation/setup modes.
static class	AasPartRegistry.AasSetup The technical setup of the AAS/VAB endpoints as data class to be used with a usual configuration format/YAML parser.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_AAS_ENDPOINT
static String	DEFAULT_HOST
static int	DEFAULT_PORT
static String	DEFAULT_PROTOCOL
static int	DEFAULT_PROTOCOL_PORT
static String	DEFAULT_REGISTRY_ENDPOINT
static int	DEFAULT_REGISTRY_PORT
static de.iip_ecosphere.platform.support.Schema	DEFAULT_SCHEMA
static String	NAME_AAS The name of the top-level AAS created by this registry in build().
static String	NAME_SUBMODEL_RESOURCES
private static AasPartRegistry.AasSetup	setup
static String	URN_AAS The URN of the top-level AAS created by this registry in build().

Constructor Summary

Constructors

Constructor and Description
AasPartRegistry()

Method Summary

Modifier and Type	Method and Description
static AasPartRegistry.AasBuildResult	build() Build up all AAS of the currently running platform part including all contributors.
static AasPartRegistry.AasBuildResult	build(boolean startImplServer) Build up all AAS of the currently running platform part including all contributors.
static AasPartRegistry.AasBuildResult	build(Predicate<AasContributor> filter) Build up all AAS of the currently running platform part.
static AasPartRegistry.AasBuildResult	build(Predicate<AasContributor> filter, boolean startImplServer) Build up all AAS of the currently running platform part.
static Set<Class<? extends AasContributor>>	contributorClasses() Returns the contributor classes.
static Iterator<AasContributor>	contributors() Returns the contributors.
static de.iip_ecosphere.platform.support.Server	deploy(List<de.iip_ecosphere.platform.support.aas.Aas> aas, String... options) Deploy the given AAS to a local server.
static de.iip_ecosphere.platform.support.aas.Aas	getAas(List<de.iip_ecosphere.platform.support.aas.Aas> list, String idShort) Returns the first AAS in list matching the given name.
private static ServiceLoader<AasContributor>	getContributorLoader() Returns the contributor loader.
static de.iip_ecosphere.platform.support.Server	register(List<de.iip_ecosphere.platform.support.aas.Aas> aas, de.iip_ecosphere.platform.support.Endpoint registry, String... options) Registers the given AAS to a remote registry and creates a local server for the AAS.
static void	remoteDeploy(List<de.iip_ecosphere.platform.support.aas.Aas> aas) Performs a remote deployment of the given aas.
static de.iip_ecosphere.platform.support.aas.Aas	retrieveIipAas() Obtains the IIP-Ecosphere platform AAS.
static de.iip_ecosphere.platform.support.Endpoint	setAasEndpoint(de.iip_ecosphere.platform.support.Endpoint endpoint) Deprecated. use setAasSetup(AasSetup) instead
static AasPartRegistry.AasSetup	setAasSetup(AasPartRegistry.AasSetup aasSetup) Defines the AAS setup.
static de.iip_ecosphere.platform.support.ServerAddress	setProtocolAddress(de.iip_ecosphere.platform.support.ServerAddress address) Deprecated. use setAasSetup(AasSetup) instead

Methods inherited from class java.lang.Object

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

Field Detail

NAME_AAS

public static final String NAME_AAS

The name of the top-level AAS created by this registry in build().

See Also:

Constant Field Values

NAME_SUBMODEL_RESOURCES

public static final String NAME_SUBMODEL_RESOURCES

See Also:

Constant Field Values

URN_AAS

public static final String URN_AAS

The URN of the top-level AAS created by this registry in build().

See Also:

Constant Field Values

DEFAULT_SCHEMA

public static final de.iip_ecosphere.platform.support.Schema DEFAULT_SCHEMA

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_REGISTRY_PORT

public static final int DEFAULT_REGISTRY_PORT

See Also:

Constant Field Values

DEFAULT_PROTOCOL_PORT

public static final int DEFAULT_PROTOCOL_PORT

See Also:

Constant Field Values

DEFAULT_AAS_ENDPOINT

public static final String DEFAULT_AAS_ENDPOINT

See Also:

Constant Field Values

DEFAULT_REGISTRY_ENDPOINT

public static final String DEFAULT_REGISTRY_ENDPOINT

See Also:

Constant Field Values

DEFAULT_PROTOCOL

public static final String DEFAULT_PROTOCOL

See Also:

Constant Field Values

setup

private static AasPartRegistry.AasSetup setup

Constructor Detail

AasPartRegistry

public AasPartRegistry()

Method Detail

setAasEndpoint

@Deprecated
public static de.iip_ecosphere.platform.support.Endpoint setAasEndpoint(de.iip_ecosphere.platform.support.Endpoint endpoint)

Deprecated. use setAasSetup(AasSetup) instead

Defines the AAS endpoint.

Parameters:

endpoint - the registry endpoint

Returns:

the endpoint before this call

setProtocolAddress

@Deprecated
public static de.iip_ecosphere.platform.support.ServerAddress setProtocolAddress(de.iip_ecosphere.platform.support.ServerAddress address)

Deprecated. use setAasSetup(AasSetup) instead

Defines the operation/property implementation protocol address.

Parameters:

address - the address

Returns:

the address before this call

setAasSetup

public static AasPartRegistry.AasSetup setAasSetup(AasPartRegistry.AasSetup aasSetup)

Defines the AAS setup.

Parameters:

aasSetup - the setup information

Returns:

the setup information before this call

getContributorLoader

private static ServiceLoader<AasContributor> getContributorLoader()

Returns the contributor loader.

Returns:

the loader instance

contributors

public static Iterator<AasContributor> contributors()

Returns the contributors.

Returns:

the contributors

contributorClasses

public static Set<Class<? extends AasContributor>> contributorClasses()

Returns the contributor classes.

Returns:

the contributor classes

build

public static AasPartRegistry.AasBuildResult build()

Build up all AAS of the currently running platform part including all contributors. No implementation server is started. [public for testing]

Returns:

the list of AAS

build

public static AasPartRegistry.AasBuildResult build(boolean startImplServer)

Build up all AAS of the currently running platform part including all contributors. [public for testing]

Parameters:

startImplServer - whether the implementation server shall be started before creating the AAS, this may be required for incremental deployment

Returns:

the list of AAS

build

public static AasPartRegistry.AasBuildResult build(Predicate<AasContributor> filter)

Build up all AAS of the currently running platform part. No implementation server is started. [public for testing]

Parameters:

filter - filter out contributors, in particular for testing, e.g., active AAS that require an implementation server

Returns:

the list of AAS

build

public static AasPartRegistry.AasBuildResult build(Predicate<AasContributor> filter,
                                                   boolean startImplServer)

Build up all AAS of the currently running platform part. [public for testing]

Parameters:

filter - filter out contributors, in particular for testing, e.g., active AAS that require an implementation server

startImplServer - whether the implementation server shall be started before creating the AAS, this may be required for incremental deployment

Returns:

the list of AAS

retrieveIipAas

public static de.iip_ecosphere.platform.support.aas.Aas retrieveIipAas()
                                                                throws IOException

Obtains the IIP-Ecosphere platform AAS. Be careful with the returned instance, as if the AAS is modified in the mean time, you may hold an outdated instance.

Returns:

the platform AAS (may be null for none)

Throws:

IOException - if the AAS cannot be read due to connection errors

deploy

public static de.iip_ecosphere.platform.support.Server deploy(List<de.iip_ecosphere.platform.support.aas.Aas> aas,
                                                              String... options)

Deploy the given AAS to a local server. [testing]

Parameters:

aas - the list of aas, e.g., from build()

options - optional server creation options

Returns:

the server instance

register

public static de.iip_ecosphere.platform.support.Server register(List<de.iip_ecosphere.platform.support.aas.Aas> aas,
                                                                de.iip_ecosphere.platform.support.Endpoint registry,
                                                                String... options)
                                                         throws IOException

Registers the given AAS to a remote registry and creates a local server for the AAS.

Parameters:

aas - the list of aas, e.g., from build()

registry - optional registry endpoint for remote registration, assuming a local in-memory registry if null

options - optional server creation options

Returns:

the server instance

Throws:

IOException - if access to the AAS registry fails

remoteDeploy

public static void remoteDeploy(List<de.iip_ecosphere.platform.support.aas.Aas> aas)
                         throws IOException

Performs a remote deployment of the given aas.

Parameters:

aas - the list of AAS, e.g., from build()

Throws:

IOException - if the deployment of an AAS fails or access to the AAS registry fails

getAas

public static de.iip_ecosphere.platform.support.aas.Aas getAas(List<de.iip_ecosphere.platform.support.aas.Aas> list,
                                                               String idShort)

Returns the first AAS in list matching the given name. [utility]

Parameters:

list - the list to consider

idShort - the short name to filter for

Returns:

the first AAS or null for none