Provides bundling of:

The to-be-glued native library, eg OpenGL32.dll. From here on this is referred as the Tool.
The JNI glue-code native library, eg jogl_desktop.dll. From here on this is referred as the Glue

An DynamicLibraryBundleInfo instance is being passed in the constructor, providing the required information about the tool and glue libraries. The ClassLoader of it's implementation is also being used to help locating the native libraries.

An instance provides a complete com.jogamp.common.os.DynamicLookupHelper to reset the com.jogamp.gluegen.runtime.ProcAddressTable.
At construction, it:

loads the Tool native library via NativeLibrary's open method
loads the Glue native library
resolves the Tool's GetProcAddress. (optional)

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	DynamicLibraryBundle.GlueJNILibLoader Inherit access

Field Summary

Modifier and Type	Field and Description
private final DynamicLinker	dynLinkGlobal
private final boolean[]	glueLibLoaded
private int	glueLibLoadedNumber
private final List<String>	glueLibNames
private final DynamicLibraryBundleInfo	info
protected final List<NativeLibrary>	nativeLibraries
private boolean	toolGetProcAddressComplete
private final List<String>	toolGetProcAddressFuncNameList
private HashSet<String>	toolGetProcAddressFuncNameSet
private long	toolGetProcAddressHandle
private final boolean[]	toolLibLoaded
private int	toolLibLoadedNumber
private final List<List<String>>	toolLibNames

Constructor Summary

Access	Constructor and Description
public	DynamicLibraryBundle(final DynamicLibraryBundleInfo info) Instantiates and loads all `NativeLibrary`s incl.

Method Summary

Modifier and Type	Method and Description
public final void	claimAllLinkPermission() Implements com.jogamp.common.os.DynamicLookupHelper.claimAllLinkPermission.
public final void	destroy() Unload all `NativeLibrary`s, and remove all references.
public final long	dynamicLookupFunction(final String funcName) Implements com.jogamp.common.os.DynamicLookupHelper.dynamicLookupFunction. Returns the function handle for function 'funcName'.
private final long	dynamicLookupFunctionOnLibs(final String funcName)
public final DynamicLibraryBundleInfo	getBundleInfo()
public static RunnableExecutor	getDefaultRunnableExecutor() Returns an AWT-EDT `RunnableExecutor` implementation if AWT is available, otherwise `RunnableExecutor#currentThreadExecutor`.
public final int	getGlueLibLoadedNumber()
public final int	getGlueLibNumber()
protected final long	getToolGetProcAddressHandle()
public final int	getToolLibLoadedNumber()
public final int	getToolLibNumber()
public final boolean	isFunctionAvailable(final String funcName) Implements com.jogamp.common.os.DynamicLookupHelper.isFunctionAvailable. Queries whether function 'funcName' is available.
public final boolean	Returns: true if the last entry has been loaded, while ignoring the preload dependencies. Otherwise false. isGlueLibComplete()
public final boolean	isGlueLibLoaded(final int i)
public final boolean	isLibComplete()
public final boolean	Returns: true if all tool libraries are loaded, otherwise false. isToolLibComplete()
public final boolean	isToolLibLoaded()
public final boolean	isToolLibLoaded(final int i)
protected static final NativeLibrary	loadFirstAvailable(final List<String> libNames, final ClassLoader loader, final boolean global)
pack-priv final DynamicLinker	loadLibraries()
public final void	releaseAllLinkPermission() Implements com.jogamp.common.os.DynamicLookupHelper.releaseAllLinkPermission.
private final long	toolDynamicLookupFunction(final String funcName)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dynLinkGlobal	back to summary
private final DynamicLinker dynLinkGlobal

glueLibLoaded	back to summary
private final boolean[] glueLibLoaded

glueLibLoadedNumber	back to summary
private int glueLibLoadedNumber

glueLibNames	back to summary
private final List<String> glueLibNames

info	back to summary
private final DynamicLibraryBundleInfo info

nativeLibraries	back to summary
protected final List<NativeLibrary> nativeLibraries

toolGetProcAddressComplete	back to summary
private boolean toolGetProcAddressComplete

toolGetProcAddressFuncNameList	back to summary
private final List<String> toolGetProcAddressFuncNameList

toolGetProcAddressFuncNameSet	back to summary
private HashSet<String> toolGetProcAddressFuncNameSet

toolGetProcAddressHandle	back to summary
private long toolGetProcAddressHandle

toolLibLoaded	back to summary
private final boolean[] toolLibLoaded

toolLibLoadedNumber	back to summary
private int toolLibLoadedNumber

toolLibNames	back to summary
private final List<List<String>> toolLibNames

Constructor Detail

DynamicLibraryBundle back to summary

DynamicLibraryBundle	back to summary
public DynamicLibraryBundle(final DynamicLibraryBundleInfo info) Instantiates and loads all `NativeLibrary`s incl. JNI libraries. The ClassLoader of the `DynamicLibraryBundleInfo` implementation class is being used to help locating the native libraries.

public DynamicLibraryBundle(final DynamicLibraryBundleInfo info)

Instantiates and loads all NativeLibrarys incl. JNI libraries.

The ClassLoader of the DynamicLibraryBundleInfo implementation class is being used to help locating the native libraries.

Method Detail

claimAllLinkPermission	back to summary
public final void claimAllLinkPermission() throws SecurityException Implements com.jogamp.common.os.DynamicLookupHelper.claimAllLinkPermission. Annotations @Override Exceptions SecurityException: Doc from com.jogamp.common.os.DynamicLookupHelper.claimAllLinkPermission. if user is not granted access for the library set.

claimAllLinkPermission

back to summary

public final void claimAllLinkPermission() throws SecurityException

Implements com.jogamp.common.os.DynamicLookupHelper.claimAllLinkPermission.

Annotations

@Override

Exceptions

SecurityException:

Doc from com.jogamp.common.os.DynamicLookupHelper.claimAllLinkPermission.

if user is not granted access for the library set.

destroy	back to summary
public final void destroy() Unload all `NativeLibrary`s, and remove all references.

dynamicLookupFunction	back to summary
public final long dynamicLookupFunction(final String funcName) throws SecurityException Implements com.jogamp.common.os.DynamicLookupHelper.dynamicLookupFunction. Doc from com.jogamp.common.os.DynamicLookupHelper.dynamicLookupFunction. Returns the function handle for function 'funcName'. Annotations @Override Exceptions SecurityException: if user is not granted access for the library set.

dynamicLookupFunction

back to summary

public final long dynamicLookupFunction(final String funcName) throws SecurityException

Implements com.jogamp.common.os.DynamicLookupHelper.dynamicLookupFunction.

Doc from com.jogamp.common.os.DynamicLookupHelper.dynamicLookupFunction.

Returns the function handle for function 'funcName'.

Annotations

@Override

Exceptions

SecurityException:: if user is not granted access for the library set.

dynamicLookupFunctionOnLibs	back to summary
private final long dynamicLookupFunctionOnLibs(final String funcName) throws SecurityException Exceptions SecurityException: if user is not granted access for the library set.

getBundleInfo	back to summary
public final DynamicLibraryBundleInfo getBundleInfo()

getDefaultRunnableExecutor	back to summary
public static RunnableExecutor getDefaultRunnableExecutor() Returns an AWT-EDT `RunnableExecutor` implementation if AWT is available, otherwise `RunnableExecutor#currentThreadExecutor`.

getGlueLibLoadedNumber	back to summary
public final int getGlueLibLoadedNumber()

getGlueLibNumber	back to summary
public final int getGlueLibNumber()

getToolGetProcAddressHandle	back to summary
protected final long getToolGetProcAddressHandle() throws SecurityException

getToolLibLoadedNumber	back to summary
public final int getToolLibLoadedNumber()

getToolLibNumber	back to summary
public final int getToolLibNumber()

isFunctionAvailable	back to summary
public final boolean isFunctionAvailable(final String funcName) throws SecurityException Implements com.jogamp.common.os.DynamicLookupHelper.isFunctionAvailable. Doc from com.jogamp.common.os.DynamicLookupHelper.isFunctionAvailable. Queries whether function 'funcName' is available. Annotations @Override Exceptions SecurityException: if user is not granted access for the library set.

isFunctionAvailable

back to summary

public final boolean isFunctionAvailable(final String funcName) throws SecurityException

Implements com.jogamp.common.os.DynamicLookupHelper.isFunctionAvailable.

Doc from com.jogamp.common.os.DynamicLookupHelper.isFunctionAvailable.

Queries whether function 'funcName' is available.

Annotations

@Override

Exceptions

SecurityException:: if user is not granted access for the library set.

isGlueLibComplete	back to summary
public final boolean isGlueLibComplete() Returns:boolean true if the last entry has been loaded, while ignoring the preload dependencies. Otherwise false. See Also `DynamicLibraryBundleInfo#getGlueLibNames()`

isGlueLibLoaded	back to summary
public final boolean isGlueLibLoaded(final int i)

isLibComplete	back to summary
public final boolean isLibComplete()

isToolLibComplete	back to summary
public final boolean isToolLibComplete() Returns:boolean true if all tool libraries are loaded, otherwise false. See Also `DynamicLibraryBundleInfo#getToolLibNames()`

isToolLibLoaded	back to summary
public final boolean isToolLibLoaded()

isToolLibLoaded	back to summary
public final boolean isToolLibLoaded(final int i)

loadFirstAvailable	back to summary
protected static final NativeLibrary loadFirstAvailable(final List<String> libNames, final ClassLoader loader, final boolean global) throws SecurityException

loadLibraries	back to summary
pack-priv final DynamicLinker loadLibraries() throws SecurityException

releaseAllLinkPermission	back to summary
public final void releaseAllLinkPermission() throws SecurityException Implements com.jogamp.common.os.DynamicLookupHelper.releaseAllLinkPermission. Annotations @Override Exceptions SecurityException: Doc from com.jogamp.common.os.DynamicLookupHelper.releaseAllLinkPermission. if user is not granted access for the library set.

releaseAllLinkPermission

back to summary

public final void releaseAllLinkPermission() throws SecurityException

Implements com.jogamp.common.os.DynamicLookupHelper.releaseAllLinkPermission.

Annotations

@Override

Exceptions

SecurityException:

Doc from com.jogamp.common.os.DynamicLookupHelper.releaseAllLinkPermission.

if user is not granted access for the library set.

toolDynamicLookupFunction	back to summary
private final long toolDynamicLookupFunction(final String funcName)

com.jogamp.common.os back to summary

pack-priv final Class DynamicLibraryBundle.GlueJNILibLoader

Class Inheritance

extends JNILibLoaderBase

java.lang.Object
com.jogamp.common.jvm.JNILibLoaderBase
com.jogamp.common.os.DynamicLibraryBundle.GlueJNILibLoader

Inherit access

Field Summary

Inherited from com.jogamp.common.jvm.JNILibLoaderBase:: DEBUG PERF

Constructor Summary

Access	Constructor and Description
pack-priv	GlueJNILibLoader()

Method Summary

Modifier and Type	Method and Description
protected static synchronized boolean	loadLibrary(final String the library to load libname, final boolean if true, errors during loading the library should be ignored ignoreError, final ClassLoader optional ClassLoader, used to locate the library cl) Hides com.jogamp.common.jvm.JNILibLoaderBase.loadLibrary. Loads the library specified by libname, using the `LoaderAction` set by `setLoadingAction(LoaderAction)`.

Inherited from com.jogamp.common.jvm.JNILibLoaderBase:: addLoaded addNativeJarLibs addNativeJarLibsJoglCfg disableLoading enableLoading isLoaded loadLibrary setLoadingAction

Constructor Detail

GlueJNILibLoader	back to summary
pack-priv GlueJNILibLoader()

Method Detail

loadLibrary back to summary

loadLibrary	back to summary
protected static synchronized boolean loadLibrary(final String libname, final boolean ignoreError, final ClassLoader cl) Hides com.jogamp.common.jvm.JNILibLoaderBase.loadLibrary. Doc from com.jogamp.common.jvm.JNILibLoaderBase.loadLibrary. Loads the library specified by libname, using the `LoaderAction` set by `setLoadingAction(LoaderAction)`. The implementation should ignore, if the library has been loaded already. Parameters libname:String the library to load ignoreError:boolean if true, errors during loading the library should be ignored cl:ClassLoader optional ClassLoader, used to locate the library Returns:boolean true if library loaded successful

protected static synchronized boolean loadLibrary(final String libname, final boolean ignoreError, final ClassLoader cl)

Hides com.jogamp.common.jvm.JNILibLoaderBase.loadLibrary.

Doc from com.jogamp.common.jvm.JNILibLoaderBase.loadLibrary.

Loads the library specified by libname, using the LoaderAction set by setLoadingAction(LoaderAction).
The implementation should ignore, if the library has been loaded already.

Parameters

libname:String: the library to load
ignoreError:boolean: if true, errors during loading the library should be ignored
cl:ClassLoader: optional ClassLoader, used to locate the library

Returns:boolean

true if library loaded successful

public Class DynamicLibraryBundle

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class DynamicLibraryBundle.GlueJNILibLoader

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail