Package de.iip_ecosphere.platform.support.aas.basyx2

Class BaSyxAas.BaSyxAasBuilder

java.lang.Object

de.iip_ecosphere.platform.support.aas.basyx2.AbstractAas.BaSyxAbstractAasBuilder

de.iip_ecosphere.platform.support.aas.basyx2.BaSyxAas.BaSyxAasBuilder

All Implemented Interfaces:

de.iip_ecosphere.platform.support.aas.Aas.AasBuilder, de.iip_ecosphere.platform.support.aas.RbacReceiver<de.iip_ecosphere.platform.support.aas.Aas.AasBuilder>, de.iip_ecosphere.platform.support.Builder<de.iip_ecosphere.platform.support.aas.Aas>

Enclosing class:

BaSyxAas

static class BaSyxAas.BaSyxAasBuilder
extends AbstractAas.BaSyxAbstractAasBuilder

Builder for BaSyxAas.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private BaSyxAas	instance

Constructor Summary

Constructors

Constructor	Description
BaSyxAasBuilder(BaSyxAas instance)	Creates an instance from an existing BaSyx instance.
BaSyxAasBuilder(String idShort, String identifier)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
de.iip_ecosphere.platform.support.aas.Aas	build()
(package private) void	buildMyDeferred()	Calls Builder.build() on all deferred builders.
de.iip_ecosphere.platform.support.aas.AssetInformation.AssetInformationBuilder	createAssetInformationBuilder(String idShort, String urn, de.iip_ecosphere.platform.support.aas.AssetKind kind)
de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder	createSubmodelBuilder(String idShort, String identifier)
de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder	createSubmodelBuilder(String idShort, String identifier, de.iip_ecosphere.platform.support.aas.SetupSpec spec)
(package private) void	defer(String shortId, de.iip_ecosphere.platform.support.Builder<?> builder)	Registers a sub-build as deferred.
(package private) BaSyxAas	getInstance()	Returns the instance under creation.
BaSyxSubmodelParent	getSubmodelParent()	Returns the sub-model parent.
de.iip_ecosphere.platform.support.aas.Aas.AasBuilder	rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth)
de.iip_ecosphere.platform.support.aas.Aas.AasBuilder	rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth, de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.Role role, de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.RbacAction... actions)
de.iip_ecosphere.platform.support.aas.Submodel	register(BaSyxSubmodel submodel)	Registers a sub-model.
(package private) void	setAsset(BaSyxAssetInformation asset)	Defines the asset for the AAS being under construction.

Methods inherited from class de.iip_ecosphere.platform.support.aas.basyx2.AbstractAas.BaSyxAbstractAasBuilder

createReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.iip_ecosphere.platform.support.aas.Aas.AasBuilder

rbac

Methods inherited from interface de.iip_ecosphere.platform.support.aas.RbacReceiver

rbacAll, rbacAllAuthenticated, rbacDevice, rbacPlatform

Field Details

instance

private BaSyxAas instance

Constructor Details

BaSyxAasBuilder

BaSyxAasBuilder(String idShort,
 String identifier)

Creates an instance. Prevents external creation.

Parameters:

idShort - the shortId of the AAS

identifier - the identifier of the AAS (may be null or empty for an identification based on idShort, interpreted as an URN if this starts with urn)

Throws:

IllegalArgumentException - if idShort or urn is null or empty

BaSyxAasBuilder

BaSyxAasBuilder(BaSyxAas instance)

Creates an instance from an existing BaSyx instance. Prevents external creation.

Parameters:

instance - the BaSyx instance

Method Details

build

public de.iip_ecosphere.platform.support.aas.Aas build()

createSubmodelBuilder

public de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder createSubmodelBuilder(String idShort,
 String identifier)

createSubmodelBuilder

public de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder createSubmodelBuilder(String idShort,
 String identifier,
 de.iip_ecosphere.platform.support.aas.SetupSpec spec)

register

public de.iip_ecosphere.platform.support.aas.Submodel register(BaSyxSubmodel submodel)
                                                        throws IOException

Description copied from class: AbstractAas.BaSyxAbstractAasBuilder

Registers a sub-model.

Specified by:

register in class AbstractAas.BaSyxAbstractAasBuilder

Parameters:

submodel - the sub-model

Returns:

submodel

Throws:

IOException - if the submodel cannot be registered, e.g. due to permission issues

getInstance

BaSyxAas getInstance()

Returns the instance under creation.

Specified by:

getInstance in class AbstractAas.BaSyxAbstractAasBuilder

Returns:

the instance

getSubmodelParent

public BaSyxSubmodelParent getSubmodelParent()

Description copied from class: AbstractAas.BaSyxAbstractAasBuilder

Returns the sub-model parent.

Specified by:

getSubmodelParent in class AbstractAas.BaSyxAbstractAasBuilder

Returns:

the sub-model parent

createAssetInformationBuilder

public de.iip_ecosphere.platform.support.aas.AssetInformation.AssetInformationBuilder createAssetInformationBuilder(String idShort,
 String urn,
 de.iip_ecosphere.platform.support.aas.AssetKind kind)

setAsset

void setAsset(BaSyxAssetInformation asset)

Description copied from class: AbstractAas.BaSyxAbstractAasBuilder

Defines the asset for the AAS being under construction.

Specified by:

setAsset in class AbstractAas.BaSyxAbstractAasBuilder

Parameters:

asset - the asset

defer

void defer(String shortId,
 de.iip_ecosphere.platform.support.Builder<?> builder)

Description copied from class: AbstractAas.BaSyxAbstractAasBuilder

Registers a sub-build as deferred.

Specified by:

defer in class AbstractAas.BaSyxAbstractAasBuilder

Parameters:

shortId - the shortId of the element

builder - the sub-builder to be registered

See Also:

• AbstractAas.BaSyxAbstractAasBuilder.buildMyDeferred()

buildMyDeferred

void buildMyDeferred()

Description copied from class: AbstractAas.BaSyxAbstractAasBuilder

Calls Builder.build() on all deferred builders.

Specified by:

buildMyDeferred in class AbstractAas.BaSyxAbstractAasBuilder

See Also:

• AbstractAas.BaSyxAbstractAasBuilder.defer(String, Builder)

rbac

public de.iip_ecosphere.platform.support.aas.Aas.AasBuilder rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth,
 de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.Role role,
 de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.RbacAction... actions)

rbac

public de.iip_ecosphere.platform.support.aas.Aas.AasBuilder rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth)