Package aQute.bnd.osgi

Class PluginsContainer

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<java.lang.Object>

aQute.bnd.osgi.PluginsContainer

All Implemented Interfaces:

Registry, java.lang.Iterable<java.lang.Object>, java.util.Collection<java.lang.Object>, java.util.Set<java.lang.Object>

public class PluginsContainer
extends java.util.AbstractSet<java.lang.Object>
implements java.util.Set<java.lang.Object>, Registry

The plugin set for a Processor. Plugins are general service objects and can be any type. The PluginsContainer treats the @{link PluginsContainer.PluginProvider special. If it is used with a type, it will expand when it encounters a PluginsContainer.PluginProvider plugin, see getPlugin(Class) and getPlugins(Class). These provided plugins are _not_ part of the this set so they won't be explicitly returned when plugins() is called.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	PluginsContainer.AbstractPlugin<T>
static interface	PluginsContainer.PluginProvider	A Plugin Provider provides plugins when accessed with a type selector.
(package private) class	PluginsContainer.PluginsSpliterator<T>	A spliterator of plugins of the specified type ordered by the processor hierarchy.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Set<java.lang.AutoCloseable>	closeablePlugins
private static java.lang.invoke.MethodType	defaultConstructor
private static org.slf4j.Logger	logger
private java.util.Set<java.lang.String>	missingCommand
private java.util.Set<java.lang.Object>	plugins
(package private) Processor	processor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PluginsContainer()

Method Summary

Modifier and Type	Method	Description
boolean	add(java.lang.Object plugin)
boolean	addAll(java.util.Collection<? extends java.lang.Object> collection)
protected void	close()
<T> T	getPlugin(java.lang.Class<T> type)	Return the first plugin of the specified type.
<T> java.util.List<T>	getPlugins(java.lang.Class<T> type)	Return all plugins of the specified type.
protected void	init(Processor processor)	Init actions occur inside of the first-level memoizer.
(package private) boolean	isMissingPlugin(java.lang.String name)
java.util.Iterator<java.lang.Object>	iterator()
private java.lang.Object	loadPlugin(Processor processor, java.lang.ClassLoader loader, Attrs attrs, java.lang.String className, boolean ignoreError)	Load a plugin and customize it.
private void	loadPluginPath(Processor processor, java.lang.String pluginPath, Processor.CL loader)	Add the @link Constants.PLUGINPATH entries (which are file names) to the class loader.
protected void	loadPlugins(Processor processor, java.lang.String pluginString, java.lang.String pluginPathString)	Magic to load the plugins.
protected java.util.Set<java.lang.Object>	plugins()	Return the set of plugins added to this container.
protected void	postInit(Processor processor)	Post init actions must occur outside of the first level memoizer.
boolean	remove(java.lang.Object plugin)
int	size()
java.util.Spliterator<java.lang.Object>	spliterator()
protected <T> java.util.Spliterator<T>	spliterator(java.lang.Class<T> type)	Returns a spliterator of plugins of the specified type ordered by the processor hierarchy.
java.util.stream.Stream<java.lang.Object>	stream()
protected <T> java.util.stream.Stream<T>	stream(java.lang.Class<T> type)	Returns a stream of plugins of the specified type ordered by the processor hierarchy.
java.lang.String	toString()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

clear, contains, containsAll, isEmpty, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

clear, contains, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray

Field Detail

logger

private static final org.slf4j.Logger logger

defaultConstructor

private static final java.lang.invoke.MethodType defaultConstructor

plugins

private final java.util.Set<java.lang.Object> plugins

missingCommand

private final java.util.Set<java.lang.String> missingCommand

closeablePlugins

private final java.util.Set<java.lang.AutoCloseable> closeablePlugins

processor

Processor processor

Constructor Detail

PluginsContainer

protected PluginsContainer()

Method Detail

init

protected void init(Processor processor)

Init actions occur inside of the first-level memoizer.

postInit

protected void postInit(Processor processor)

Post init actions must occur outside of the first level memoizer. This means these actions can reentrantly see the current state of the PluginsContainer, through the Processor, which may be partially complete if addExtensions adds more plugins.

plugins

protected java.util.Set<java.lang.Object> plugins()

Return the set of plugins added to this container.

This will include PluginsContainer.PluginProviders themselves, if any, rather than any plugins the PluginsContainer.PluginProviders may provide.

Use stream(Class) or @{link spliterator(Class) to return the complete plugins including any plugins the PluginsContainer.PluginProviders may provide as well as the plugins from the parent processor. The complete plugins may have duplicates if the same plugin is added into different processors in the hierarchy.

stream

protected <T> java.util.stream.Stream<T> stream(java.lang.Class<T> type)

Returns a stream of plugins of the specified type ordered by the processor hierarchy.

The supplied plugins may have duplicates if the same plugin is added into different processors in the hierarchy.

spliterator

protected <T> java.util.Spliterator<T> spliterator(java.lang.Class<T> type)

Returns a spliterator of plugins of the specified type ordered by the processor hierarchy.

The supplied plugins may have duplicates if the same plugin is added into different processors in the hierarchy.

getPlugin

public <T> T getPlugin(java.lang.Class<T> type)

Return the first plugin of the specified type.

This may invoke any PluginsContainer.PluginProviders that match the specified type.

Specified by:

getPlugin in interface Registry

getPlugins

public <T> java.util.List<T> getPlugins(java.lang.Class<T> type)

Return all plugins of the specified type. Duplicates are removed.

This will invoke any PluginsContainer.PluginProviders that match the specified type.

Specified by:

getPlugins in interface Registry

add

public boolean add(java.lang.Object plugin)

Specified by:

add in interface java.util.Collection<java.lang.Object>

Specified by:

add in interface java.util.Set<java.lang.Object>

Overrides:

add in class java.util.AbstractCollection<java.lang.Object>

addAll

public boolean addAll(java.util.Collection<? extends java.lang.Object> collection)

Specified by:

addAll in interface java.util.Collection<java.lang.Object>

Specified by:

addAll in interface java.util.Set<java.lang.Object>

Overrides:

addAll in class java.util.AbstractCollection<java.lang.Object>

remove

public boolean remove(java.lang.Object plugin)

Specified by:

remove in interface java.util.Collection<java.lang.Object>

Specified by:

remove in interface java.util.Set<java.lang.Object>

Overrides:

remove in class java.util.AbstractCollection<java.lang.Object>

iterator

public java.util.Iterator<java.lang.Object> iterator()

Specified by:

iterator in interface java.util.Collection<java.lang.Object>

Specified by:

iterator in interface java.lang.Iterable<java.lang.Object>

Specified by:

iterator in interface java.util.Set<java.lang.Object>

Specified by:

iterator in class java.util.AbstractCollection<java.lang.Object>

spliterator

public java.util.Spliterator<java.lang.Object> spliterator()

Specified by:

spliterator in interface java.util.Collection<java.lang.Object>

Specified by:

spliterator in interface java.lang.Iterable<java.lang.Object>

Specified by:

spliterator in interface java.util.Set<java.lang.Object>

stream

public java.util.stream.Stream<java.lang.Object> stream()

Specified by:

stream in interface java.util.Collection<java.lang.Object>

size

public int size()

Specified by:

size in interface java.util.Collection<java.lang.Object>

Specified by:

size in interface java.util.Set<java.lang.Object>

Specified by:

size in class java.util.AbstractCollection<java.lang.Object>

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<java.lang.Object>

loadPlugins

protected void loadPlugins(Processor processor,
                           java.lang.String pluginString,
                           java.lang.String pluginPathString)

Magic to load the plugins. This is quite tricky actually since we allow plugins to be downloaded (this is mainly intended for repositories since in general plugins should use extensions, however to bootstrap the extensions we need more). Since downloads might need plugins for passwords and protocols we need to first load the paths specified on the plugin clause, then check if there are any local plugins (starting with aQute.bnd and be able to load from our own class loader).

After that, we load the plugin paths, these can use the built in connectors.

Last but not least, we load the remaining plugins.

loadPluginPath

private void loadPluginPath(Processor processor,
                            java.lang.String pluginPath,
                            Processor.CL loader)

Add the @link Constants.PLUGINPATH entries (which are file names) to the class loader. If this file does not exist, and there is a Constants.PLUGINPATH_URL_ATTR attribute then we download it first from that url. You can then also specify a Constants.PLUGINPATH_SHA1_ATTR attribute to verify the file.

Parameters:

pluginPath - the clauses for the plugin path

loader - The class loader to extend

See Also:

PLUGINPATH

loadPlugin

private java.lang.Object loadPlugin(Processor processor,
                                    java.lang.ClassLoader loader,
                                    Attrs attrs,
                                    java.lang.String className,
                                    boolean ignoreError)

Load a plugin and customize it. If the plugin cannot be loaded then we return null.

Parameters:

loader - Name of the loader

attrs -

className -

isMissingPlugin

boolean isMissingPlugin(java.lang.String name)

close

protected void close()