org.apache.nifi.nar

Interface ExtensionManager

All Known Subinterfaces:

ExtensionDiscoveringManager

All Known Implementing Classes:

StandardExtensionDiscoveringManager

public interface ExtensionManager

Provides the framework with access to extensions, bundles, and class loaders.

Method Summary

Modifier and Type	Method and Description
void	closeURLClassLoader(String instanceIdentifier, ClassLoader classLoader) Closes the given ClassLoader if it is an instance of URLClassLoader.
default InstanceClassLoader	createInstanceClassLoader(String classType, String instanceIdentifier, Bundle bundle, Set<URL> additionalUrls) Creates the ClassLoader for the instance of the given type.
InstanceClassLoader	createInstanceClassLoader(String classType, String instanceIdentifier, Bundle bundle, Set<URL> additionalUrls, boolean registerClassLoader, String classloaderIsolationKey) Creates the ClassLoader for the instance of the given type.
Set<Bundle>	getAllBundles() Retrieves all bundles known to this ExtensionManager.
Bundle	getBundle(BundleCoordinate bundleCoordinate) Retrieves the bundle with the given coordinate.
Bundle	getBundle(ClassLoader classLoader) Retrieves the bundle for the given class loader.
List<Bundle>	getBundles(String classType) Retrieves the bundles that have a class with the given name.
Class<?>	getClass(ExtensionDefinition extensionDefinition) Returns the Class that is described by the given definition
Set<ExtensionDefinition>	getExtensions(Class<?> definition) Retrieves the set of classes that have been loaded for the definition.
InstanceClassLoader	getInstanceClassLoader(String instanceIdentifier) Retrieves the InstanceClassLoader for the component with the given identifier.
ConfigurableComponent	getTempComponent(String classType, BundleCoordinate bundleCoordinate) Gets the temp component with the given type from the given bundle.
Set<ExtensionDefinition>	getTypes(BundleCoordinate bundleCoordinate) Retrieves the extension classes that were loaded from the bundle with the given coordinate.
void	logClassLoaderDetails() Logs details about the files loaded by the class loaders
void	logClassLoaderMapping() Logs the available class loaders.
void	registerInstanceClassLoader(String instanceIdentifier, InstanceClassLoader instanceClassLoader) Registers the given instance class loader so that it can be later retrieved via getInstanceClassLoader(String)
InstanceClassLoader	removeInstanceClassLoader(String instanceIdentifier) Removes the InstanceClassLoader for a given component.

Method Detail

getAllBundles

Set<Bundle> getAllBundles()

Retrieves all bundles known to this ExtensionManager.

Returns:

the set of known bundles

createInstanceClassLoader

default InstanceClassLoader createInstanceClassLoader(String classType,
                                                      String instanceIdentifier,
                                                      Bundle bundle,
                                                      Set<URL> additionalUrls)

Creates the ClassLoader for the instance of the given type.

Parameters:

classType - the type of class to create the ClassLoader for

instanceIdentifier - the identifier of the specific instance of the classType to look up the ClassLoader for

bundle - the bundle where the classType exists

additionalUrls - additional URLs to add to the instance class loader

Returns:

the ClassLoader for the given instance of the given type, or null if the type is not a detected extension type

createInstanceClassLoader

InstanceClassLoader createInstanceClassLoader(String classType,
                                              String instanceIdentifier,
                                              Bundle bundle,
                                              Set<URL> additionalUrls,
                                              boolean registerClassLoader,
                                              String classloaderIsolationKey)

Creates the ClassLoader for the instance of the given type.

Parameters:

classType - the type of class to create the ClassLoader for

instanceIdentifier - the identifier of the specific instance of the classType to look up the ClassLoader for

bundle - the bundle where the classType exists

additionalUrls - additional URLs to add to the instance class loader

registerClassLoader - whether or not to register the class loader as the new classloader for the component with the given ID

classloaderIsolationKey - a classloader key that can be used in order to specify which shared class loader can be used as the instance class loader's parent, or null if the parent class loader should be shared or if cloning ancestors is not necessary

Returns:

the ClassLoader for the given instance of the given type, or null if the type is not a detected extension type

getInstanceClassLoader

InstanceClassLoader getInstanceClassLoader(String instanceIdentifier)

Retrieves the InstanceClassLoader for the component with the given identifier.

Parameters:

instanceIdentifier - the identifier of a component

Returns:

the instance class loader for the component

removeInstanceClassLoader

InstanceClassLoader removeInstanceClassLoader(String instanceIdentifier)

Removes the InstanceClassLoader for a given component.

Parameters:

instanceIdentifier - the of a component

registerInstanceClassLoader

void registerInstanceClassLoader(String instanceIdentifier,
                                 InstanceClassLoader instanceClassLoader)

Registers the given instance class loader so that it can be later retrieved via getInstanceClassLoader(String)

Parameters:

instanceIdentifier - the instance identifier

instanceClassLoader - the class loader

closeURLClassLoader

void closeURLClassLoader(String instanceIdentifier,
                         ClassLoader classLoader)

Closes the given ClassLoader if it is an instance of URLClassLoader.

Parameters:

instanceIdentifier - the instance id the class loader corresponds to

classLoader - the class loader to close

getBundles

List<Bundle> getBundles(String classType)

Retrieves the bundles that have a class with the given name.

Parameters:

classType - the class name of an extension

Returns:

the list of bundles that contain an extension with the given class name

getBundle

Bundle getBundle(BundleCoordinate bundleCoordinate)

Retrieves the bundle with the given coordinate.

Parameters:

bundleCoordinate - a coordinate to look up

Returns:

the bundle with the given coordinate, or null if none exists

getTypes

Set<ExtensionDefinition> getTypes(BundleCoordinate bundleCoordinate)

Retrieves the extension classes that were loaded from the bundle with the given coordinate.

Parameters:

bundleCoordinate - the coordinate

Returns:

the definitions of the extensions from the bundle with that coordinate

getClass

Class<?> getClass(ExtensionDefinition extensionDefinition)

Returns the Class that is described by the given definition

Parameters:

extensionDefinition - the extension definition

Returns:

the extension's class

getBundle

Bundle getBundle(ClassLoader classLoader)

Retrieves the bundle for the given class loader.

Parameters:

classLoader - the class loader to look up the bundle for

Returns:

the bundle for the given class loader

getExtensions

Set<ExtensionDefinition> getExtensions(Class<?> definition)

Retrieves the set of classes that have been loaded for the definition. (i.e getExtensions(Processor.class)

Parameters:

definition - the extension definition, such as Processor.class

Returns:

the set of extension definitions that describe the the extensions implementing the defintion

getTempComponent

ConfigurableComponent getTempComponent(String classType,
                                       BundleCoordinate bundleCoordinate)

Gets the temp component with the given type from the given bundle.

Parameters:

classType - the class name

bundleCoordinate - the coordinate

Returns:

the temp component instance

logClassLoaderMapping

void logClassLoaderMapping()

Logs the available class loaders.

logClassLoaderDetails

void logClassLoaderDetails()

Logs details about the files loaded by the class loaders