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

Class AasOperationsProvider

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

de.iip_ecosphere.platform.support.aas.basyx2.AasOperationsProvider

All Implemented Interfaces:

de.iip_ecosphere.platform.support.aas.OperationsProvider, Serializable, Cloneable, Map<String,Object>

public class AasOperationsProvider
extends HashMap<String,Object>
implements de.iip_ecosphere.platform.support.aas.OperationsProvider

Implements a simple operations provider still following a simple status/operations/service structure. The idea is to attach the relevant operations of an implementing object to this provider, whereby the implementing object is actually providing the functionality and this provider just acts as an intermediary. For this purpose, you can register function objects for operations and supplier/consumer objects of the implementing object in the provider. The provider then offers the respective access under

• "status"/propertyName
• "operations"/"service"/operationName

while ""service"" is just seen as a category of many potential operation categories that you can register. Use "/" as path separator, which is available as constant. The respective invocables must follow this naming schema for access.

Author:

Holger Eichelberger, SSE

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	AasOperationsProvider.AasRestOperationsBuilder	The protocol server builder for this provider.
private static class	AasOperationsProvider.Entry	An entry as last element of a potentially hierarchically nested access path.
private static enum	AasOperationsProvider.Kind	The main kinds of entries.
private static class	AasOperationsProvider.Property	Represents a property consisting of a consumer and a supplier function.

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface de.iip_ecosphere.platform.support.aas.OperationsProvider

de.iip_ecosphere.platform.support.aas.OperationsProvider.Interceptor

Field Summary

Fields

Modifier and Type	Field	Description
private de.iip_ecosphere.platform.support.aas.OperationsProvider.Interceptor	interceptor
private Map<String,Function<Object[],Object>>	operationFunctions
private Map<String,Map<String,AasOperationsProvider.Entry>>	operations
static final String	OPERATIONS	The path prefix for operations.
static final String	PREFIX_OPERATIONS	A convenient combination of OPERATIONS + SEPARATOR.
static final String	PREFIX_SERVICE	A convenient combination of OPERATIONS + SEPARATOR + SEPARATOR + SERVICE .
static final String	PREFIX_STATUS	A convenient combination of STATUS + SEPARATOR.
private Map<String,AasOperationsProvider.Property>	properties
static final String	SEPARATOR	The path separator.
private static final long	serialVersionUID
private Map<String,AasOperationsProvider.Entry>	service
static final String	SERVICE	The operations category sub-path for operations.
private Map<String,AasOperationsProvider.Entry>	status
static final String	STATUS	The path prefix for status/properties.

Constructor Summary

Constructors

Constructor	Description
AasOperationsProvider()	Creates a VAB operations provider instance.

Method Summary

Modifier and Type	Method	Description
private Set<String>	addOperations(String category, boolean qualified, Set<String> result)	Adds all operations known for category to result.
AasOperationsProvider	defineOperation(String category, String name, Function<Object[],Object> function)
AasOperationsProvider	defineProperty(String name, Supplier<Object> get, Consumer<Object> set)
AasOperationsProvider	defineServiceFunction(String name, Function<Object[],Object> function)
Supplier<Object>	getGetter(String name)
Function<Object[],Object>	getOperation(String category, String name)
Set<String>	getOperations(boolean qualified)
Set<String>	getOperations(String category, boolean qualified)
protected String	getOperationsPath()	Returns the base path name for operations.
Function<Object[],Object>	getServiceFunction(String name)
Set<String>	getServiceOperations(boolean qualified)
protected String	getServicePath()	Returns the base (sub-)path name for services.
Consumer<Object>	getSetter(String name)
protected String	getStatusPath()	Returns the base path name for status/properties.
private String	makeUnique(Map<String,?> map, String baseName)	Makes a name unique within its kind, i.e., the given map.
void	setInterceptor(de.iip_ecosphere.platform.support.aas.OperationsProvider.Interceptor interceptor)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Details

SEPARATOR

public static final String SEPARATOR

The path separator.

See Also:

• Constant Field Values

STATUS

public static final String STATUS

The path prefix for status/properties.

See Also:

• Constant Field Values

PREFIX_STATUS

public static final String PREFIX_STATUS

A convenient combination of STATUS + SEPARATOR.

See Also:

• Constant Field Values

OPERATIONS

public static final String OPERATIONS

The path prefix for operations.

See Also:

• Constant Field Values

PREFIX_OPERATIONS

public static final String PREFIX_OPERATIONS

A convenient combination of OPERATIONS + SEPARATOR.

See Also:

• Constant Field Values

SERVICE

public static final String SERVICE

The operations category sub-path for operations.

See Also:

• Constant Field Values

PREFIX_SERVICE

public static final String PREFIX_SERVICE

A convenient combination of OPERATIONS + SEPARATOR + SEPARATOR + SERVICE .

See Also:

• Constant Field Values

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

status

private Map<String,AasOperationsProvider.Entry> status

operations

private Map<String,Map<String,AasOperationsProvider.Entry>> operations

service

private Map<String,AasOperationsProvider.Entry> service

properties

private Map<String,AasOperationsProvider.Property> properties

operationFunctions

private Map<String,Function<Object[],Object>> operationFunctions

interceptor

private de.iip_ecosphere.platform.support.aas.OperationsProvider.Interceptor interceptor

Constructor Details

AasOperationsProvider

public AasOperationsProvider()

Creates a VAB operations provider instance.

Method Details

getStatusPath

protected String getStatusPath()

Returns the base path name for status/properties. Allows for overriding the default settings.

Returns:

the path name, by default STATUS

getOperationsPath

protected String getOperationsPath()

Returns the base path name for operations. Allows for overriding the default settings.

Returns:

the path name, by default OPERATIONS

getServicePath

protected String getServicePath()

Returns the base (sub-)path name for services. Allows for overriding the default settings.

Returns:

the path name, by default SERVICE (interpreted as sub-path of getOperationsPath().

makeUnique

private String makeUnique(Map<String,?> map,
 String baseName)

Makes a name unique within its kind, i.e., the given map.

Parameters:

map - the map

baseName - the (base) name to be made unique

Returns:

the unique name

defineOperation

public AasOperationsProvider defineOperation(String category,
 String name,
 Function<Object[],Object> function)

Specified by:

defineOperation in interface de.iip_ecosphere.platform.support.aas.OperationsProvider

getOperation

public Function<Object[],Object> getOperation(String category,
 String name)

Specified by:

getOperation in interface de.iip_ecosphere.platform.support.aas.OperationsProvider

getServiceFunction

public Function<Object[],Object> getServiceFunction(String name)

Specified by:

getServiceFunction in interface de.iip_ecosphere.platform.support.aas.OperationsProvider

getOperations

public Set<String> getOperations(boolean qualified)

Specified by:

getOperations in interface de.iip_ecosphere.platform.support.aas.OperationsProvider

getOperations

public Set<String> getOperations(String category,
 boolean qualified)

Specified by:

getOperations in interface de.iip_ecosphere.platform.support.aas.OperationsProvider

addOperations

private Set<String> addOperations(String category,
 boolean qualified,
 Set<String> result)

Adds all operations known for category to result.

Parameters:

category - the category

qualified - add qualified or unqualified names

result - the result set to modify

Returns:

result

getServiceOperations

public Set<String> getServiceOperations(boolean qualified)

Specified by:

getServiceOperations in interface de.iip_ecosphere.platform.support.aas.OperationsProvider

defineServiceFunction

public AasOperationsProvider defineServiceFunction(String name,
 Function<Object[],Object> function)

Specified by:

defineServiceFunction in interface de.iip_ecosphere.platform.support.aas.OperationsProvider

defineProperty

public AasOperationsProvider defineProperty(String name,
 Supplier<Object> get,
 Consumer<Object> set)

Specified by:

defineProperty in interface de.iip_ecosphere.platform.support.aas.OperationsProvider

getGetter

public Supplier<Object> getGetter(String name)

Specified by:

getGetter in interface de.iip_ecosphere.platform.support.aas.OperationsProvider

getSetter

public Consumer<Object> getSetter(String name)

Specified by:

getSetter in interface de.iip_ecosphere.platform.support.aas.OperationsProvider

setInterceptor

public void setInterceptor(de.iip_ecosphere.platform.support.aas.OperationsProvider.Interceptor interceptor)

Specified by:

setInterceptor in interface de.iip_ecosphere.platform.support.aas.OperationsProvider