org.opends.server.admin

Class ClassLoaderProvider

java.lang.Object

org.opends.server.admin.ClassLoaderProvider

public final class ClassLoaderProvider
extends Object

Manages the class loader which should be used for loading configuration definition classes and associated extensions.

For extensions which define their own extended configuration definitions, the class loader will make sure that the configuration definition classes are loaded and initialized.

Initially the class loader provider is disabled, and calls to the getClassLoader() will return the system default class loader.

Applications MUST NOT maintain persistent references to the class loader as it can change at run-time.

Method Summary

Methods

Modifier and Type	Method and Description
void	disable() Disable this class loader provider and removed any registered extensions.
void	enable() Enable this class loader provider using the application's class loader as the parent class loader.
void	enable(ClassLoader parent) Enable this class loader provider using the provided parent class loader.
ClassLoader	getClassLoader() Gets the class loader which should be used for loading classes and resources.
static ClassLoaderProvider	getInstance() Get the single application wide class loader provider instance.
boolean	isEnabled() Indicates whether this class loader provider is enabled.
String	printExtensionInformation() Prints out all information about extensions.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ClassLoaderProvider getInstance()

Get the single application wide class loader provider instance.

Returns:

Returns the single application wide class loader provider instance.

disable

public void disable()
             throws IllegalStateException

Disable this class loader provider and removed any registered extensions.

Throws:

IllegalStateException - If this class loader provider is already disabled.

enable

public void enable()
            throws InitializationException,
                   IllegalStateException

Enable this class loader provider using the application's class loader as the parent class loader.

Throws:

InitializationException - If the class loader provider could not initialize successfully.

IllegalStateException - If this class loader provider is already enabled.

enable

public void enable(ClassLoader parent)
            throws InitializationException,
                   IllegalStateException

Enable this class loader provider using the provided parent class loader.

Parameters:

parent - The parent class loader.

Throws:

InitializationException - If the class loader provider could not initialize successfully.

IllegalStateException - If this class loader provider is already enabled.

getClassLoader

public ClassLoader getClassLoader()

Gets the class loader which should be used for loading classes and resources. When this class loader provider is disabled, the system default class loader will be returned by default.

Applications MUST NOT maintain persistent references to the class loader as it can change at run-time.

Returns:

Returns the class loader which should be used for loading classes and resources.

isEnabled

public boolean isEnabled()

Indicates whether this class loader provider is enabled.

Returns:

Returns true if this class loader provider is enabled.

printExtensionInformation

public String printExtensionInformation()

Prints out all information about extensions.

Returns:

a String instance representing all information about extensions; null if there is no information available.