org.apache.nifi.nar

Class StandardExtensionDiscoveringManager

java.lang.Object

org.apache.nifi.nar.StandardExtensionDiscoveringManager

All Implemented Interfaces:

ExtensionDiscoveringManager, ExtensionManager

public class StandardExtensionDiscoveringManager
extends Object
implements ExtensionDiscoveringManager

Scans through the classpath to load all FlowFileProcessors, FlowFileComparators, and ReportingTasks using the service provider API and running through all classloaders (root, NARs).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	StandardExtensionDiscoveringManager.BaseClassLoaderKey

Field Summary

Fields

Modifier and Type	Field and Description
private Map<BundleCoordinate,Bundle>	bundleCoordinateBundleLookup
private Map<BundleCoordinate,Set<ExtensionDefinition>>	bundleCoordinateClassesLookup
private Map<ClassLoader,Bundle>	classLoaderBundleLookup
private Map<String,List<Bundle>>	classNameBundleLookup
private Map<Class,Set<ExtensionDefinition>>	definitionMap
private Map<String,InstanceClassLoader>	instanceClassloaderLookup
private static org.slf4j.Logger	logger
private ConcurrentMap<StandardExtensionDiscoveringManager.BaseClassLoaderKey,SharedInstanceClassLoader>	sharedBaseClassloaders
private Map<String,ConfigurableComponent>	tempComponentLookup

Constructor Summary

Constructors

Constructor and Description
StandardExtensionDiscoveringManager()
StandardExtensionDiscoveringManager(Collection<Class<? extends ConfigurableComponent>> additionalExtensionTypes)

Method Summary

Modifier and Type	Method and Description
private void	buildClassLoaderDetails(Bundle bundle, StringBuilder sb, int indentLevel)
void	closeURLClassLoader(String instanceIdentifier, ClassLoader classLoader) Closes the given ClassLoader if it is an instance of URLClassLoader.
InstanceClassLoader	createInstanceClassLoader(String classType, String instanceIdentifier, Bundle bundle, Set<URL> additionalUrls, boolean register, String classloaderIsolationKey) Creates the ClassLoader for the instance of the given type.
void	discoverExtensions(Bundle systemBundle, Set<Bundle> narBundles) Discovers all extensions available in the provided bundles.
void	discoverExtensions(Set<Bundle> narBundles, boolean logDetails) Discovers extensions in the provided bundles.
protected Set<BundleCoordinate>	findReachableApiBundles(ConfigurableComponent component) Find the bundle coordinates for any service APIs that are referenced by this component and not part of the same bundle.
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
private static String	getClassBundleKey(String classType, BundleCoordinate bundleCoordinate)
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.
private Set<String>	getServiceFileImplementationClassNames(URL serviceFileUrl)
private Set<URL>	getServiceFileURLs(Bundle bundle, Class<?> extensionType) Returns a Set of URL's for all Service Files (i.e., META-INF/services/<interface name> files) that define the extensions that exist for the given bundle.
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.
protected void	initializeTempComponent(ConfigurableComponent configurableComponent)
protected boolean	isInstanceClassLoaderRequired(String classType, Bundle bundle)
protected void	loadExtension(String extensionClassName, Class<?> extensionType, Bundle bundle)
private void	loadExtensions(Bundle bundle) Loads extensions from the specified bundle.
void	logClassLoaderDetails() Logs details about the files loaded by the class loaders
void	logClassLoaderMapping() Logs the available class loaders.
private static boolean	multipleVersionsAllowed(Class<?> type)
protected void	registerExtensionClass(Class<?> extensionType, String implementationClassName, Bundle bundle)
void	registerInstanceClassLoader(String instanceIdentifier, InstanceClassLoader instanceClassLoader) Registers the given instance class loader so that it can be later retrieved via ExtensionManager.getInstanceClassLoader(String)
private void	registerServiceClass(String className, Class<?> extensionType, Map<String,List<Bundle>> classNameBundleMap, Map<BundleCoordinate,Set<ExtensionDefinition>> bundleCoordinateClassesMap, Bundle bundle, Set<ExtensionDefinition> classes) Registers extension for the specified type from the specified Bundle.
InstanceClassLoader	removeInstanceClassLoader(String instanceIdentifier) Removes the InstanceClassLoader for a given component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.nar.ExtensionDiscoveringManager

discoverExtensions

Methods inherited from interface org.apache.nifi.nar.ExtensionManager

createInstanceClassLoader

Field Detail

logger

private static final org.slf4j.Logger logger

definitionMap

private final Map<Class,Set<ExtensionDefinition>> definitionMap

classNameBundleLookup

private final Map<String,List<Bundle>> classNameBundleLookup

bundleCoordinateClassesLookup

private final Map<BundleCoordinate,Set<ExtensionDefinition>> bundleCoordinateClassesLookup

bundleCoordinateBundleLookup

private final Map<BundleCoordinate,Bundle> bundleCoordinateBundleLookup

classLoaderBundleLookup

private final Map<ClassLoader,Bundle> classLoaderBundleLookup

tempComponentLookup

private final Map<String,ConfigurableComponent> tempComponentLookup

instanceClassloaderLookup

private final Map<String,InstanceClassLoader> instanceClassloaderLookup

sharedBaseClassloaders

private final ConcurrentMap<StandardExtensionDiscoveringManager.BaseClassLoaderKey,SharedInstanceClassLoader> sharedBaseClassloaders

Constructor Detail

StandardExtensionDiscoveringManager

public StandardExtensionDiscoveringManager()

StandardExtensionDiscoveringManager

public StandardExtensionDiscoveringManager(Collection<Class<? extends ConfigurableComponent>> additionalExtensionTypes)

Method Detail

getAllBundles

public Set<Bundle> getAllBundles()

Description copied from interface: ExtensionManager

Retrieves all bundles known to this ExtensionManager.

Specified by:

getAllBundles in interface ExtensionManager

Returns:

the set of known bundles

discoverExtensions

public void discoverExtensions(Bundle systemBundle,
                               Set<Bundle> narBundles)

Description copied from interface: ExtensionDiscoveringManager

Discovers all extensions available in the provided bundles. This method is intended to be called only once during application start-up.

Specified by:

discoverExtensions in interface ExtensionDiscoveringManager

Parameters:

systemBundle - the system bundle

narBundles - the bundles to use for discovering extensions

discoverExtensions

public void discoverExtensions(Set<Bundle> narBundles,
                               boolean logDetails)

Description copied from interface: ExtensionDiscoveringManager

Discovers extensions in the provided bundles. This method is intended to be used to discover additional extensions after the application is running.

Specified by:

discoverExtensions in interface ExtensionDiscoveringManager

Parameters:

narBundles - the bundles to use for discovering extensions

logDetails - whether or not to log the details about what is loaded

loadExtensions

private void loadExtensions(Bundle bundle)

Loads extensions from the specified bundle.

Parameters:

bundle - from which to load extensions

getServiceFileImplementationClassNames

private Set<String> getServiceFileImplementationClassNames(URL serviceFileUrl)
                                                    throws IOException

Throws:

IOException

getServiceFileURLs

private Set<URL> getServiceFileURLs(Bundle bundle,
                                    Class<?> extensionType)
                             throws IOException

Returns a Set of URL's for all Service Files (i.e., META-INF/services/<interface name> files) that define the extensions that exist for the given bundle. The returned set will only contain URL's for which the services file live in the given bundle directly and NOT the parent/ancestor bundle.

Parameters:

bundle - the bundle whose extensions are of interest

extensionType - the type of extension (I.e., Processor, ControllerService, ParameterProvider, ReportingTask, etc.)

Returns:

the set of URL's that point to Service Files for the given extension type in the given bundle. An empty set will be returned if no service files exist

Throws:

IOException - if unable to read the services file from the given bundle's classloader.

loadExtension

protected void loadExtension(String extensionClassName,
                             Class<?> extensionType,
                             Bundle bundle)

registerExtensionClass

protected void registerExtensionClass(Class<?> extensionType,
                                      String implementationClassName,
                                      Bundle bundle)

initializeTempComponent

protected void initializeTempComponent(ConfigurableComponent configurableComponent)

registerServiceClass

private void registerServiceClass(String className,
                                  Class<?> extensionType,
                                  Map<String,List<Bundle>> classNameBundleMap,
                                  Map<BundleCoordinate,Set<ExtensionDefinition>> bundleCoordinateClassesMap,
                                  Bundle bundle,
                                  Set<ExtensionDefinition> classes)

Registers extension for the specified type from the specified Bundle.

Parameters:

className - the fully qualified class name of the extension implementation

classNameBundleMap - mapping of classname to Bundle

bundle - the Bundle being mapped to

classes - to map to this classloader but which come from its ancestors

getClass

public Class<?> getClass(ExtensionDefinition extensionDefinition)

Description copied from interface: ExtensionManager

Returns the Class that is described by the given definition

Specified by:

getClass in interface ExtensionManager

Parameters:

extensionDefinition - the extension definition

Returns:

the extension's class

multipleVersionsAllowed

private static boolean multipleVersionsAllowed(Class<?> type)

Parameters:

type - a Class that we found from a service loader

Returns:

true if the given class is a processor, controller service, or reporting task

isInstanceClassLoaderRequired

protected boolean isInstanceClassLoaderRequired(String classType,
                                                Bundle bundle)

createInstanceClassLoader

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

Description copied from interface: ExtensionManager

Creates the ClassLoader for the instance of the given type.

Specified by:

createInstanceClassLoader in interface ExtensionManager

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

register - 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

findReachableApiBundles

protected Set<BundleCoordinate> findReachableApiBundles(ConfigurableComponent component)

Find the bundle coordinates for any service APIs that are referenced by this component and not part of the same bundle.

Parameters:

component - the component being instantiated

getInstanceClassLoader

public InstanceClassLoader getInstanceClassLoader(String instanceIdentifier)

Description copied from interface: ExtensionManager

Retrieves the InstanceClassLoader for the component with the given identifier.

Specified by:

getInstanceClassLoader in interface ExtensionManager

Parameters:

instanceIdentifier - the identifier of a component

Returns:

the instance class loader for the component

removeInstanceClassLoader

public InstanceClassLoader removeInstanceClassLoader(String instanceIdentifier)

Description copied from interface: ExtensionManager

Removes the InstanceClassLoader for a given component.

Specified by:

removeInstanceClassLoader in interface ExtensionManager

Parameters:

instanceIdentifier - the of a component

registerInstanceClassLoader

public void registerInstanceClassLoader(String instanceIdentifier,
                                        InstanceClassLoader instanceClassLoader)

Description copied from interface: ExtensionManager

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

Specified by:

registerInstanceClassLoader in interface ExtensionManager

Parameters:

instanceIdentifier - the instance identifier

instanceClassLoader - the class loader

closeURLClassLoader

public void closeURLClassLoader(String instanceIdentifier,
                                ClassLoader classLoader)

Description copied from interface: ExtensionManager

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

Specified by:

closeURLClassLoader in interface ExtensionManager

Parameters:

instanceIdentifier - the instance id the class loader corresponds to

classLoader - the class loader to close

getBundles

public List<Bundle> getBundles(String classType)

Description copied from interface: ExtensionManager

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

Specified by:

getBundles in interface ExtensionManager

Parameters:

classType - the class name of an extension

Returns:

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

getBundle

public Bundle getBundle(BundleCoordinate bundleCoordinate)

Description copied from interface: ExtensionManager

Retrieves the bundle with the given coordinate.

Specified by:

getBundle in interface ExtensionManager

Parameters:

bundleCoordinate - a coordinate to look up

Returns:

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

getTypes

public Set<ExtensionDefinition> getTypes(BundleCoordinate bundleCoordinate)

Description copied from interface: ExtensionManager

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

Specified by:

getTypes in interface ExtensionManager

Parameters:

bundleCoordinate - the coordinate

Returns:

the definitions of the extensions from the bundle with that coordinate

getBundle

public Bundle getBundle(ClassLoader classLoader)

Description copied from interface: ExtensionManager

Retrieves the bundle for the given class loader.

Specified by:

getBundle in interface ExtensionManager

Parameters:

classLoader - the class loader to look up the bundle for

Returns:

the bundle for the given class loader

getExtensions

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

Description copied from interface: ExtensionManager

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

Specified by:

getExtensions in interface ExtensionManager

Parameters:

definition - the extension definition, such as Processor.class

Returns:

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

getTempComponent

public ConfigurableComponent getTempComponent(String classType,
                                              BundleCoordinate bundleCoordinate)

Description copied from interface: ExtensionManager

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

Specified by:

getTempComponent in interface ExtensionManager

Parameters:

classType - the class name

bundleCoordinate - the coordinate

Returns:

the temp component instance

getClassBundleKey

private static String getClassBundleKey(String classType,
                                        BundleCoordinate bundleCoordinate)

logClassLoaderMapping

public void logClassLoaderMapping()

Description copied from interface: ExtensionManager

Logs the available class loaders.

Specified by:

logClassLoaderMapping in interface ExtensionManager

logClassLoaderDetails

public void logClassLoaderDetails()

Description copied from interface: ExtensionManager

Logs details about the files loaded by the class loaders

Specified by:

logClassLoaderDetails in interface ExtensionManager

buildClassLoaderDetails

private void buildClassLoaderDetails(Bundle bundle,
                                     StringBuilder sb,
                                     int indentLevel)