org.fusesource.hawtjni.runtime

Class Library

java.lang.Object

org.fusesource.hawtjni.runtime.Library

public class Library
extends Object

Used to find and load a JNI library, eventually after having extracted it. It will search for the library in order at the following locations:

1. in the custom library path: If the "library.${name}.path" System property is set to a directory, subdirectories are searched:
   1. "${platform}/${arch}"
   2. "${platform}"
   3. "${os}"
   4. ""
   for 2 namings of the library:
   1. as "${name}-${version}" library name if the version can be determined.
   2. as "${name}" library name
2. system library path: This is where the JVM looks for JNI libraries by default.
   1. as "${name}${bit-model}-${version}" library name if the version can be determined.
   2. as "${name}-${version}" library name if the version can be determined.
   3. as "${name}" library name
3. classpath path: If the JNI library can be found on the classpath, it will get extracted and then loaded. This way you can embed your JNI libraries into your packaged JAR files. They are looked up as resources in this order:
   1. "META-INF/native/${platform}/${arch}/${library[-version]}": Store your library here if you want to embed more than one platform JNI library on different processor archs in the jar.
   2. "META-INF/native/${platform}/${library[-version]}": Store your library here if you want to embed more than one platform JNI library in the jar.
   3. "META-INF/native/${os}/${library[-version]}": Store your library here if you want to embed more than one platform JNI library in the jar but don't want to take bit model into account.
   4. "META-INF/native/${library[-version]}": Store your library here if your JAR is only going to embedding one platform library.
   The file extraction is attempted until it succeeds in the following directories.
   1. The directory pointed to by the "library.${name}.path" System property (if set)
   2. a temporary directory (uses the "java.io.tmpdir" System property)

where:

• "${name}" is the name of library
• "${version}" is the value of "library.${name}.version" System property if set. Otherwise it is set to the ImplementationVersion property of the JAR's Manifest
• "${os}" is your operating system, for example "osx", "linux", or "windows"
• "${bit-model}" is "64" if the JVM process is a 64 bit process, otherwise it's "32" if the JVM is a 32 bit process
• "${arch}" is the architecture for the processor, for example "amd64" or "sparcv9"
• "${platform}" is "${os}${bit-model}", for example "linux32" or "osx64"
• "${library[-version]}": is the normal jni library name for the platform (eventually with -${version}) suffix. For example "${name}.dll" on windows, "lib${name}.jnilib" on OS X, and "lib${name}.so" on linux

Author:

Hiram Chirino

See Also:

System.mapLibraryName(String)

Field Summary

Fields

Modifier and Type	Field and Description
static String	STRATEGY_PROPERTY
static String	STRATEGY_SHA1
static String	STRATEGY_TEMP

Constructor Summary

Constructors

Constructor and Description
Library(String name)
Library(String name, Class<?> clazz)
Library(String name, String version)
Library(String name, String version, ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
String	getArchSpecifcResourcePath() Deprecated.
String	getArchSpecificResourcePath()
static int	getBitModel()
String	getLibraryFileName()
String	getNativeLibraryPath() Get the path to the native library loaded.
URL	getNativeLibrarySourceUrl() Get the URL to the native library source that has been extracted (if it was extracted).
static String	getOperatingSystem()
String	getOperatingSystemSpecifcResourcePath() Deprecated.
String	getOperatingSystemSpecificResourcePath()
static String	getPlatform()
String	getPlatformSpecifcResourcePath() Deprecated.
String	getPlatformSpecifcResourcePath(String platform) Deprecated.
String	getPlatformSpecificResourcePath()
String	getPlatformSpecificResourcePath(String platform)
String	getResorucePath() Deprecated.
String	getResourcePath()
String[]	getSpecificSearchDirs() Search directories for library: ${platform}/${arch} to enable platform JNI library for different processor archs ${platform} to enable platform JNI library ${os} to enable OS JNI library no directory
void	load() Load the native library.

Methods inherited from class java.lang.Object

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

Field Detail

STRATEGY_PROPERTY

public static final String STRATEGY_PROPERTY

See Also:

Constant Field Values

STRATEGY_SHA1

public static final String STRATEGY_SHA1

See Also:

Constant Field Values

STRATEGY_TEMP

public static final String STRATEGY_TEMP

See Also:

Constant Field Values

Constructor Detail

Library

public Library(String name)

Library

public Library(String name,
               Class<?> clazz)

Library

public Library(String name,
               String version)

Library

public Library(String name,
               String version,
               ClassLoader classLoader)

Method Detail

getNativeLibraryPath

public String getNativeLibraryPath()

Get the path to the native library loaded.

Returns:

the path (should not be null once the library is loaded)

Since:

1.16

getNativeLibrarySourceUrl

public URL getNativeLibrarySourceUrl()

Get the URL to the native library source that has been extracted (if it was extracted).

Returns:

the url to the source (in classpath)

Since:

1.16

getOperatingSystem

public static String getOperatingSystem()

getPlatform

public static String getPlatform()

getBitModel

public static int getBitModel()

load

public void load()

Load the native library.

getArchSpecifcResourcePath

@Deprecated
public final String getArchSpecifcResourcePath()

Deprecated.

getArchSpecificResourcePath

public final String getArchSpecificResourcePath()

getOperatingSystemSpecifcResourcePath

@Deprecated
public final String getOperatingSystemSpecifcResourcePath()

Deprecated.

getOperatingSystemSpecificResourcePath

public final String getOperatingSystemSpecificResourcePath()

getPlatformSpecifcResourcePath

@Deprecated
public final String getPlatformSpecifcResourcePath()

Deprecated.

getPlatformSpecificResourcePath

public final String getPlatformSpecificResourcePath()

getPlatformSpecifcResourcePath

@Deprecated
public final String getPlatformSpecifcResourcePath(String platform)

Deprecated.

getPlatformSpecificResourcePath

public final String getPlatformSpecificResourcePath(String platform)

getResorucePath

@Deprecated
public final String getResorucePath()

Deprecated.

getResourcePath

public final String getResourcePath()

getLibraryFileName

public final String getLibraryFileName()

getSpecificSearchDirs

public final String[] getSpecificSearchDirs()

Search directories for library:

• ${platform}/${arch} to enable platform JNI library for different processor archs
• ${platform} to enable platform JNI library
• ${os} to enable OS JNI library
• no directory

Returns:

the list

Since:

1.15