org.ametys.runtime.plugin

Interface ExtensionPoint<T>

Type Parameters:

T - the type of the managed extensions

All Known Implementing Classes:

AbstractClientSideExtensionPoint, AbstractComponentExtensionPoint, AbstractExtensionPoint, AbstractSelectorExtensionPoint, AbstractThreadSafeComponentExtensionPoint, AccessControllerExtensionPoint, AdditionalParameterFOSearchExtensionPoint, AdditionalPropertyIndexerExtensionPoint, AdditionalSiteResourcesProviderExtensionPoint, AdministratorNotificatorExtensionPoint, AdminSkinActionExtensionPoint, AllowedUsersActionAdditionalOperationsExtensionPoint, AmetysObjectFactoryExtensionPoint, AutomaticNewsletterExtensionPoint, BackgroundEngineHookExtensionPoint, BackOfficeRequestProxyExtensionPoint, CategoryProviderExtensionPoint, CDMfrExtensionPoint, CDMFrSyncExtensionPoint, ContentFilterExtensionPoint, ContentImporterExtensionPoint, ContentImporterExtensionPoint, ContentInputDataExtensionPoint, ContentTypeExtensionPoint, CopyCatalogUpdaterExtensionPoint, CopyUpdaterExtensionPoint, CreateSkinActionExtensionPoint, CredentialProviderFactory, DataSourceConsumerExtensionPoint, DataSourceFactoryExtensionPoint, DispatchProcessExtensionPoint, DocbookEnhancementExtensionPoint, DocbookUpdateHandlerExtensionPoint, DocumentProviderExtensionPoint, DynamicContentTypeDescriptorExtentionPoint, DynamicInformationProviderExtensionPoint, EnhancementHandlersExtensionPoint, EventTypeExtensionPoint, ExplorerApplicationExtensionPoint, ExternalizableMetadataProviderExtensionPoint, ExternalLogExtensionPoint, FilterCompatibleContentMetadataExtensionPoint, GetTokenExtensionPoint, GroupDirectoryFactory, HTMLEditionHandlerExtensionPoint, HTMLEnhancementExtensionPoint, HTMLEnhancementExtensionPoint, HTMLExpertToolbarExtensionPoint, HTMLUpdateHandlerExtensionPoint, ImportModelActionExtensionPoint, ImportSkinActionExtensionPoint, InitExtensionPoint, InputDataExtensionPoint, InputModulesExtensionPoint, LivePopulatorExtensionPoint, MenuSkinActionExtensionPoint, MessageTargetFactoriesManager, MonitoringExtensionPoint, NodeTypeDefinitionsExtensionPoint, OaiSetExtensionPoint, ObserverExtensionPoint, PageElementCachePolicyExtensionPoint, PageFilterExtensionPoint, PopulationConsumerExtensionPoint, ProfileAssignmentStorageExtensionPoint, QueryAdapterFOSearchExtensionPoint, RelationsManager, RemoteUrlExtensionPoint, RepositoryViewExtensionPoint, ResourceHandlerExtensionPoint, ResourceMetadataPopulatorExtensionPoint, RibbonControlsManager, RibbonImportManager, RibbonManager, RibbonTabsManager, RichTextConfigurationExtensionPoint, RightAssignmentContextExtensionPoint, RightContextConvertorExtensionPoint, RightsExtensionPoint, RunnableExtensionPoint, SassFunctionsProviderExtensionPoint, SchedulableExtensionPoint, SchemaDefinitionProviderExtensionPoint, ScriptBindingExtensionPoint, SearchUIModelExtensionPoint, ServiceExtensionPoint, SiteConfigurationExtensionPoint, SiteDocumentProviderExtensionPoint, SitemapConfigurationExtensionPoint, SiteTypesExtensionPoint, SourceFactoriesExtensionPoint, SQLDatabaseTypeExtensionPoint, StaticFileImportsManager, SynchronizeContentsCollectionModelExtensionPoint, SynchronizingContentOperatorExtensionPoint, SystemPropertyExtensionPoint, TagProviderExtensionPoint, TagTargetTypeExtensionPoint, TreeExtensionPoint, UIToolsFactoriesManager, URIResolverExtensionPoint, UserDirectoryFactory, UserPreferencesExtensionPoint, WelcomeStepExtensionPoint, WidgetsManager, WorkspaceModuleExtensionPoint, XHTMLSerializerExtensionPoint

public interface ExtensionPoint<T>

Superclass of all known extension points.

This class contains all required methods to build an extension point :

• configure(Configuration) to configure the extension point itself
• configureExtension(Configure) to add an extension to this point

Method Summary

Modifier and Type	Method and Description
void	addExtension(String id, String pluginName, String featureName, Configuration configuration) Add an extension to this point.
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	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.

Method Detail

addExtension

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

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

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

initializeExtensions

void initializeExtensions()
                   throws Exception

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.

Throws:

Exception - if something wrong occurs

hasExtension

boolean hasExtension(String id)

Returns true if the named extension exists

Parameters:

id - the unique id of the extension

Returns:

true if the named extension exists

getExtension

T getExtension(String id)

Returns the named extension

Parameters:

id - the unique id of the extension

Returns:

the named extension

getExtensionsIds

Set<String> getExtensionsIds()

Returns a Set containing the ids of all known extensions

Returns:

a Set containing the ids of all known extensions