de.iip_ecosphere.platform.support.iip_aas

Class PlatformAas

java.lang.Object

de.iip_ecosphere.platform.support.iip_aas.PlatformAas

All Implemented Interfaces:

AasContributor

public class PlatformAas
extends Object
implements AasContributor

The platform name/typeplate.

Author:

Holger Eichelberger, SSE

Nested Class Summary

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
private static AasUtils.ResourceResolver	imageResolver
private static String	MAVEN_SNAPSHOT_POSTFIX
static String	NAME_OPERATION_SNAPSHOTAAS
static String	NAME_PROPERTY_BUILDID
static String	NAME_PROPERTY_CITYTOWN
static String	NAME_PROPERTY_DEPARTMENT
static String	NAME_PROPERTY_ID
static String	NAME_PROPERTY_MANUFACTURER_LOGO
static String	NAME_PROPERTY_MANUFACTURER_NAME
static String	NAME_PROPERTY_MANUFACTURER_PRODUCT_DESIGNATION
static String	NAME_PROPERTY_NAME
static String	NAME_PROPERTY_PRODUCTIMAGE
static String	NAME_PROPERTY_RELEASE
static String	NAME_PROPERTY_STREET
static String	NAME_PROPERTY_VERSION
static String	NAME_PROPERTY_ZIPCODE
static String	NAME_SMC_ADDRESS
static String	NAME_SUBMODEL
static String	SUBMODEL_NAMEPLATE

Constructor Summary

Constructors

Constructor and Description
PlatformAas()

Method Summary

Modifier and Type	Method and Description
static void	addSoftwareInfo(de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder smB, ApplicationSetup appSetup) Add software-related information to the given submodel.
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.
static void	createAddress(de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder smBuilder, ApplicationSetup.Address address) Creates (part) of a nameplate address.
static de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder	createNameplate(de.iip_ecosphere.platform.support.aas.Aas.AasBuilder aasBuilder, ApplicationSetup appSetup) Creates the "nameplate".
static AasUtils.ResourceResolver	getImageResolver() Returns the image resolver.
AasContributor.Kind	getKind() Returns the kind of AAS being created.
boolean	isValid() Allow the AAS contributor to declare itself as invalid.
static void	setImageResolver(AasUtils.ResourceResolver resolver) Changes the image resolver.
(package private) static String	snapshotAas(String id) Snapshots an AAS, i.e., the AasPartRegistry.getIipAasInstance().

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

SUBMODEL_NAMEPLATE

public static final String SUBMODEL_NAMEPLATE

See Also:

Constant Field Values

NAME_PROPERTY_NAME

public static final String NAME_PROPERTY_NAME

See Also:

Constant Field Values

NAME_PROPERTY_VERSION

public static final String NAME_PROPERTY_VERSION

See Also:

Constant Field Values

NAME_PROPERTY_RELEASE

public static final String NAME_PROPERTY_RELEASE

See Also:

Constant Field Values

NAME_PROPERTY_BUILDID

public static final String NAME_PROPERTY_BUILDID

See Also:

Constant Field Values

NAME_OPERATION_SNAPSHOTAAS

public static final String NAME_OPERATION_SNAPSHOTAAS

See Also:

Constant Field Values

NAME_PROPERTY_ID

public static final String NAME_PROPERTY_ID

See Also:

Constant Field Values

NAME_PROPERTY_PRODUCTIMAGE

public static final String NAME_PROPERTY_PRODUCTIMAGE

See Also:

Constant Field Values

NAME_PROPERTY_MANUFACTURER_LOGO

public static final String NAME_PROPERTY_MANUFACTURER_LOGO

See Also:

Constant Field Values

NAME_PROPERTY_MANUFACTURER_NAME

public static final String NAME_PROPERTY_MANUFACTURER_NAME

See Also:

Constant Field Values

NAME_PROPERTY_MANUFACTURER_PRODUCT_DESIGNATION

public static final String NAME_PROPERTY_MANUFACTURER_PRODUCT_DESIGNATION

See Also:

Constant Field Values

NAME_SMC_ADDRESS

public static final String NAME_SMC_ADDRESS

See Also:

Constant Field Values

NAME_PROPERTY_CITYTOWN

public static final String NAME_PROPERTY_CITYTOWN

See Also:

Constant Field Values

NAME_PROPERTY_DEPARTMENT

public static final String NAME_PROPERTY_DEPARTMENT

See Also:

Constant Field Values

NAME_PROPERTY_STREET

public static final String NAME_PROPERTY_STREET

See Also:

Constant Field Values

NAME_PROPERTY_ZIPCODE

public static final String NAME_PROPERTY_ZIPCODE

See Also:

Constant Field Values

MAVEN_SNAPSHOT_POSTFIX

private static final String MAVEN_SNAPSHOT_POSTFIX

See Also:

Constant Field Values

imageResolver

private static AasUtils.ResourceResolver imageResolver

Constructor Detail

PlatformAas

public PlatformAas()

Method Detail

setImageResolver

public static void setImageResolver(AasUtils.ResourceResolver resolver)

Changes the image resolver. [public for testing]

Parameters:

resolver - the resolver

getImageResolver

public static AasUtils.ResourceResolver getImageResolver()

Returns the image resolver. [public for testing]

Returns:

the image resolver

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

addSoftwareInfo

public static void addSoftwareInfo(de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder smB,
                                   ApplicationSetup appSetup)

Add software-related information to the given submodel.

Parameters:

smB - the submodel builder

appSetup - the application setup

createNameplate

public static de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder createNameplate(de.iip_ecosphere.platform.support.aas.Aas.AasBuilder aasBuilder,
                                                                                             ApplicationSetup appSetup)

Creates the "nameplate". A bit of ZVEI Digital Nameplate for industrial equipment V1.0.

Parameters:

aasBuilder - the AAS builder, do not call Builder.build() in here!

appSetup - application setup

Returns:

submodel builder if something needs to be added

createAddress

public static void createAddress(de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder smBuilder,
                                 ApplicationSetup.Address address)

Creates (part) of a nameplate address. A bit of ZVEI Digital Nameplate for industrial equipment V1.0.

Parameters:

smBuilder - the builder, do not call Builder.build() in here!

address - the address to use

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

snapshotAas

static String snapshotAas(String id)
                   throws ExecutionException

Snapshots an AAS, i.e., the AasPartRegistry.getIipAasInstance().

Parameters:

id - an optional id to be placed into the file name, may be null or empty

Returns:

the name of the file written, may be empty for none

Throws:

ExecutionException - if there is no IIP AAS instance or writing the instance fails for some reason

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