org.ametys.runtime.plugin.component

Class AbstractThreadSafeComponentExtensionPoint<T>

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint<T>

Type Parameters:

T - the type of the managed extensions

All Implemented Interfaces:

LogEnabled, ExtensionPoint<T>, Disposable, Initializable, Component, Contextualizable, Serviceable, ThreadSafe

Direct Known Subclasses:

AbstractClientSideExtensionPoint, AbstractSelectorExtensionPoint, AccessControllerExtensionPoint, AdditionalPropertyIndexerExtensionPoint, AdditionalSiteResourcesProviderExtensionPoint, AdministratorNotificatorExtensionPoint, AllowedUsersActionAdditionalOperationsExtensionPoint, AmetysObjectFactoryExtensionPoint, AutomaticNewsletterExtensionPoint, BackgroundEngineHookExtensionPoint, BackOfficeRequestProxyExtensionPoint, CategoryProviderExtensionPoint, CDMfrExtensionPoint, CDMFrSyncExtensionPoint, ContentFilterExtensionPoint, ContentImporterExtensionPoint, ContentImporterExtensionPoint, ContentInputDataExtensionPoint, ContentTypeExtensionPoint, CopyCatalogUpdaterExtensionPoint, CopyUpdaterExtensionPoint, DataSourceConsumerExtensionPoint, DataSourceFactoryExtensionPoint, DispatchProcessExtensionPoint, DocbookUpdateHandlerExtensionPoint, DocumentProviderExtensionPoint, DynamicContentTypeDescriptorExtentionPoint, DynamicInformationProviderExtensionPoint, EventTypeExtensionPoint, ExplorerApplicationExtensionPoint, ExternalizableMetadataProviderExtensionPoint, ExternalLogExtensionPoint, GetTokenExtensionPoint, HTMLUpdateHandlerExtensionPoint, InitExtensionPoint, InputDataExtensionPoint, LivePopulatorExtensionPoint, MonitoringExtensionPoint, OaiSetExtensionPoint, ObserverExtensionPoint, PageElementCachePolicyExtensionPoint, PageFilterExtensionPoint, PopulationConsumerExtensionPoint, ProfileAssignmentStorageExtensionPoint, QueryAdapterFOSearchExtensionPoint, RemoteUrlExtensionPoint, ResourceMetadataPopulatorExtensionPoint, RibbonImportManager, RichTextConfigurationExtensionPoint, RightContextConvertorExtensionPoint, RunnableExtensionPoint, SassFunctionsProviderExtensionPoint, SchedulableExtensionPoint, SchemaDefinitionProviderExtensionPoint, ScriptBindingExtensionPoint, SearchUIModelExtensionPoint, ServiceExtensionPoint, SiteConfigurationExtensionPoint, SiteDocumentProviderExtensionPoint, SiteTypesExtensionPoint, SQLDatabaseTypeExtensionPoint, SynchronizingContentOperatorExtensionPoint, SystemPropertyExtensionPoint, TagProviderExtensionPoint, TagTargetTypeExtensionPoint, TreeExtensionPoint, URIResolverExtensionPoint, UserPreferencesExtensionPoint, WelcomeStepExtensionPoint, WidgetsManager, WorkspaceModuleExtensionPoint

public abstract class AbstractThreadSafeComponentExtensionPoint<T>
extends AbstractLogEnabled
implements ExtensionPoint<T>, Component, ThreadSafe, Serviceable, Initializable, Disposable, Contextualizable

Avalon based implementation of an ExtensionPoint.
Subclasses only need to call addComponent() for each new extension.

Field Summary

Fields

Modifier and Type	Field and Description
protected ServiceManager	_cocoonManager Avalon service manager
protected Context	_context Avalon context
private Set<String>	_ids
protected ThreadSafeComponentManager<T>	_manager Avalon ComponentManager

Constructor Summary

Constructors

Constructor and Description
AbstractThreadSafeComponentExtensionPoint()

Method Summary

Modifier and Type	Method and Description
protected void	addComponent(String pluginName, String featureName, String role, Class<? extends T> clazz, Configuration configuration) Adds a Component to the underlying ComponentManager.
void	addExtension(String id, String pluginName, String featureName, Configuration configuration) Add an extension to this point.
void	contextualize(Context context)
void	dispose()
T	getExtension(String id) Returns the named extension
Set<String>	getExtensionsIds() Returns a Set containing the ids of all known extensions
boolean	hasExtension(String id) Returns true if the named extension exists
void	initialize()
void	initializeExtensions() Finalize the initialization of the extensions. This method is called after all addExtension() calls. This is the last step before the actual startup of the application.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

_manager

protected ThreadSafeComponentManager<T> _manager

Avalon ComponentManager

_cocoonManager

protected ServiceManager _cocoonManager

Avalon service manager

_context

protected Context _context

Avalon context

_ids

private Set<String> _ids

Constructor Detail

AbstractThreadSafeComponentExtensionPoint

public AbstractThreadSafeComponentExtensionPoint()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

dispose

public void dispose()

Specified by:

dispose in interface Disposable

addComponent

protected void addComponent(String pluginName,
                            String featureName,
                            String role,
                            Class<? extends T> clazz,
                            Configuration configuration)
                     throws ComponentException

Adds a Component to the underlying ComponentManager. Each extension to this ExtensionPoint may be considered as a Component.

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - The feature name (unique for a given pluginName).

role - the Avalon role

clazz - the class of the component

configuration - the configuration of the component

Throws:

ComponentException - if an error occured whil setting up components

initializeExtensions

public void initializeExtensions()
                          throws Exception

Description copied from interface: ExtensionPoint

Finalize the initialization of the extensions.
This method is called after all addExtension() calls.
This is the last step before the actual startup of the application.

Specified by:

initializeExtensions in interface ExtensionPoint<T>

Throws:

Exception - if something wrong occurs

getExtension

public T getExtension(String id)

Description copied from interface: ExtensionPoint

Returns the named extension

Specified by:

getExtension in interface ExtensionPoint<T>

Parameters:

id - the unique id of the extension

Returns:

the named extension

hasExtension

public boolean hasExtension(String id)

Description copied from interface: ExtensionPoint

Returns true if the named extension exists

Specified by:

hasExtension in interface ExtensionPoint<T>

Parameters:

id - the unique id of the extension

Returns:

true if the named extension exists

addExtension

public void addExtension(String id,
                         String pluginName,
                         String featureName,
                         Configuration configuration)
                  throws ConfigurationException

Description copied from interface: ExtensionPoint

Add an extension to this point. Each implementation knows the meaning of the given configuration.

Specified by:

addExtension in interface ExtensionPoint<T>

Parameters:

id - the unique identifier of the extension.

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

configuration - the information about the extension to be added

Throws:

ConfigurationException - when a configuration problem occurs

getExtensionsIds

public Set<String> getExtensionsIds()

Description copied from interface: ExtensionPoint

Returns a Set containing the ids of all known extensions

Specified by:

getExtensionsIds in interface ExtensionPoint<T>

Returns:

a Set containing the ids of all known extensions