public class NativeLibrary extends Object implements DynamicLookupHelper
System.load()
and System.loadLibrary()
in general provide suitable functionality for applications using
native code, but are not flexible enough to support certain kinds
of glue code generation and deployment strategies. This class
supports direct linking of native libraries to other shared
objects not necessarily installed on the system (in particular,
via the use of dlopen(RTLD_GLOBAL) on Unix platforms) as well as
manual lookup of function names to support e.g. GlueGen's
ProcAddressTable glue code generation style without additional
supporting code needed in the generated library.Modifier and Type | Field and Description |
---|---|
protected static boolean |
DEBUG |
protected static boolean |
DEBUG_LOOKUP |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this native library.
|
long |
dynamicLookupFunction(String funcName)
Looks up the given function name in this native library.
|
static long |
dynamicLookupFunctionGlobal(String funcName)
Looks up the given function name in all loaded libraries.
|
long |
getLibraryHandle()
Retrieves the low-level library handle from this NativeLibrary
object.
|
String |
getLibraryPath()
Retrieves the path under which this library was opened.
|
static String |
isValidNativeLibraryName(String libName,
boolean isLowerCaseAlready)
Comparison of prefix and suffix of the given libName's basename
is performed case insensitive
|
static NativeLibrary |
open(String libName,
ClassLoader loader)
Opens the given native library, assuming it has the same base
name on all platforms, looking first in the system's search
path, and in the context of the specified ClassLoader, which is
used to help find the library in the case of e.g.
|
static NativeLibrary |
open(String libName,
ClassLoader loader,
boolean global)
Opens the given native library, assuming it has the same base
name on all platforms, looking first in the system's search
path, and in the context of the specified ClassLoader, which is
used to help find the library in the case of e.g.
|
static NativeLibrary |
open(String windowsLibName,
String unixLibName,
String macOSXLibName,
boolean searchSystemPathFirst,
ClassLoader loader)
Opens the given native library, assuming it has the given base
names (no "lib" prefix or ".dll/.so/.dylib" suffix) on the
Windows, Unix and Mac OS X platforms, respectively, and in the
context of the specified ClassLoader, which is used to help find
the library in the case of e.g.
|
static NativeLibrary |
open(String windowsLibName,
String unixLibName,
String macOSXLibName,
boolean searchSystemPathFirst,
ClassLoader loader,
boolean global) |
String |
toString() |
protected static final boolean DEBUG
protected static final boolean DEBUG_LOOKUP
public static NativeLibrary open(String libName, ClassLoader loader)
public static NativeLibrary open(String libName, ClassLoader loader, boolean global)
public static NativeLibrary open(String windowsLibName, String unixLibName, String macOSXLibName, boolean searchSystemPathFirst, ClassLoader loader)
public static NativeLibrary open(String windowsLibName, String unixLibName, String macOSXLibName, boolean searchSystemPathFirst, ClassLoader loader, boolean global)
public long dynamicLookupFunction(String funcName)
dynamicLookupFunction
in interface DynamicLookupHelper
public static long dynamicLookupFunctionGlobal(String funcName)
public long getLibraryHandle()
public String getLibraryPath()
public void close()
public static String isValidNativeLibraryName(String libName, boolean isLowerCaseAlready)
libName
- the full path library name with prefix and suffixisLowerCaseAlready
- indicates if libName is already lower-case