tools.aqua.turnkey.support

Class TurnKey

java.lang.Object

tools.aqua.turnkey.support.TurnKey

public final class TurnKey
extends Object

Handles automatic unpacking and loading for a bundle of native libraries.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TURNKEY_FILE_NAME The conventional file name for turnkey metadata.

Method Summary

Modifier and Type	Method and Description
static void	load(String libraryPrefix, Function<String,InputStream> getResourceAsStream) Execute the unpack-and-load algorithm.

Methods inherited from class java.lang.Object

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

Field Detail

TURNKEY_FILE_NAME

public static final String TURNKEY_FILE_NAME

The conventional file name for turnkey metadata.

See Also:

Constant Field Values

Method Detail

load

public static void load(String libraryPrefix,
                        Function<String,InputStream> getResourceAsStream)

Execute the unpack-and-load algorithm. In essence, this does

1. Identify the current OS and CPU architecture the JVM runs on.
2. Check if matching native libraries are present. If not, abort.
3. Unpack the native libraries to a temporary directory and schedule the resulting files for deletion on JVM exit.
4. Load the native libraries.

This must be called before the first operation that uses native code (e.g., in a static initializer).

Parameters:

libraryPrefix - the library-specific prefix to use when loading files without leading or terminal /. This is usually the package name of the library with . replaced by /.

getResourceAsStream - the function to use for loading resources. This is necessary in case of, e.g., modularity restrictions on the visibility of the metadata and libraries.

Throws:

UnsupportedPlatformException - if the current platform is not supported.

TurnkeyException - if library unpacking or linking fails.

TurnkeyException - if the TurnKey library distribution is incomplete, indicating a packaging error.