de.iip_ecosphere.platform.support.iip_aas

Class AasUtils

java.lang.Object

de.iip_ecosphere.platform.support.iip_aas.AasUtils

public class AasUtils
extends Object

Helper functions for active AAS.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AasUtils.ResourceHandler Handles a resolved resource.
static interface	AasUtils.ResourceResolver Resolves resources.

Field Summary

Fields

Modifier and Type	Field and Description
static AasUtils.ResourceResolver	CLASSPATH_RESOLVER Resolves a resource from the main classpath.
static AasUtils.ResourceResolver	CLASSPATH_RESOURCE_RESOLVER Resolves a resource from the resources directory in the main classpath.
static URI	EMPTY_URI An empty URI for readUri(Object[], int, URI).

Constructor Summary

Constructors

Constructor and Description
AasUtils()

Method Summary

Modifier and Type	Method and Description
static String	fixId(String id) Modifies a given id so that it fits the needs of the implementation.
static String	prependSlash(String text) Prepends a "/" if there is none at the beginning of text.
static int	readInt(Object[] args, int index, int dflt) Reads the index argument from args as int.
static Map<String,String>	readMap(Object[] args, int index, Map<String,String> dflt) Reads the index argument from args as map of strings.
static String	readString(Object[] args) Reads the first argument from args as String with default value empty.
static String	readString(Object[] args, int index) Reads the index argument from args as String with default value empty.
static String	readString(Object[] args, int index, String dflt) Reads the index argument from args as String.
static URI	readUri(Object[] args, int index, URI dflt) Reads the index argument from args as URI.
static URI	readUriEx(Object[] args, int index, URI dflt) Reads the index argument from args as URI.
static void	resolveImage(String image, AasUtils.ResourceResolver resolver, boolean handleAlways, AasUtils.ResourceHandler handler) Resolves an image from a nameplate/application JAML file.
static String	writeMap(Map<String,String> map) Writes a map to JSON.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_URI

public static final URI EMPTY_URI

An empty URI for readUri(Object[], int, URI).

CLASSPATH_RESOLVER

public static final AasUtils.ResourceResolver CLASSPATH_RESOLVER

Resolves a resource from the main classpath.

CLASSPATH_RESOURCE_RESOLVER

public static final AasUtils.ResourceResolver CLASSPATH_RESOURCE_RESOLVER

Resolves a resource from the resources directory in the main classpath.

Constructor Detail

AasUtils

public AasUtils()

Method Detail

prependSlash

public static final String prependSlash(String text)

Prepends a "/" if there is none at the beginning of text.

Parameters:

text - the text to use as basis

Returns:

test with "/" prepended

readString

public static String readString(Object[] args)

Reads the first argument from args as String with default value empty.

Parameters:

args - the array to take the value from

Returns:

the value

readString

public static String readString(Object[] args,
                                int index)

Reads the index argument from args as String with default value empty.

Parameters:

args - the array to take the value from

index - the 0-based index into args

Returns:

the value

readString

public static String readString(Object[] args,
                                int index,
                                String dflt)

Reads the index argument from args as String.

Parameters:

args - the array to take the value from

index - the 0-based index into args

dflt - default value if the index is wrong, there is no value/null ...

Returns:

the value

readInt

public static int readInt(Object[] args,
                          int index,
                          int dflt)

Reads the index argument from args as int.

Parameters:

args - the array to take the value from

index - the 0-based index into args

dflt - default value if the index is wrong, there is no value/null, the value is no int...

Returns:

the value

readUriEx

public static URI readUriEx(Object[] args,
                            int index,
                            URI dflt)
                     throws URISyntaxException

Reads the index argument from args as URI.

Parameters:

args - the array to take the value from

index - the 0-based index into args

dflt - default value if the index is wrong, there is no value/null

Returns:

the value

Throws:

URISyntaxException - if the value cannot be turned into an URI...

readUri

public static URI readUri(Object[] args,
                          int index,
                          URI dflt)

Reads the index argument from args as URI.

Parameters:

args - the array to take the value from

index - the 0-based index into args

dflt - default value if the index is wrong, there is no value/null, the value cannot be turned into an URI...

Returns:

the value

fixId

public static String fixId(String id)

Modifies a given id so that it fits the needs of the implementation. Uses AasFactory.fixId(String).

Parameters:

id - the id

Returns:

the fixed id

readMap

public static Map<String,String> readMap(Object[] args,
                                         int index,
                                         Map<String,String> dflt)

Reads the index argument from args as map of strings.

Parameters:

args - the array to take the value from

index - the 0-based index into args

dflt - default value if the index is wrong, there is no value/null ...

Returns:

the map

writeMap

public static String writeMap(Map<String,String> map)

Writes a map to JSON.

Parameters:

map - the map

Returns:

the JSON representation

resolveImage

public static void resolveImage(String image,
                                AasUtils.ResourceResolver resolver,
                                boolean handleAlways,
                                AasUtils.ResourceHandler handler)

Resolves an image from a nameplate/application JAML file. May call #upload(File, String) to upload the file to the AAS server.

Parameters:

image - the image as URL or as local resource name (may be null or empty)

resolver - the resolver to use, CLASSPATH_RESOURCE_RESOLVER used as default

handleAlways - whether the handler shall also be called for an empty/no resolution result

handler - handles the resolved resource