Class SynchronizeContentsCollectionModelExtensionPoint
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.plugins.contentio.synchronize.SynchronizeContentsCollectionModelExtensionPoint
- All Implemented Interfaces:
LogEnabled
,ExtensionPoint<SynchronizableContentsCollectionModel>
,Disposable
,Initializable
,Component
,Contextualizable
,Serviceable
,ThreadSafe
public class SynchronizeContentsCollectionModelExtensionPoint
extends AbstractLogEnabled
implements ExtensionPoint<SynchronizableContentsCollectionModel>, Initializable, ThreadSafe, Component, Serviceable, Contextualizable, Disposable
Extension point for
SynchronizableContentsCollectionModel
s.-
Nested Class Summary
Modifier and TypeClassDescriptionclass
Class for parsing parameters of aSynchronizableContentsCollectionModel
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addExtension
(String id, String pluginName, String featureName, Configuration configuration) Add an extension to this point.protected void
addModel
(String pluginName, Configuration configuration) Add a synchronizable contents collection modelprotected void
configureParameters
(SynchronizeContentsCollectionModelExtensionPoint.SynchronizableContentsCollectionModelParameterParser paramParser, Configuration configuration, String pluginName, Map<String, Parameter<ParameterHelper.ParameterType>> parameters) Configure a parameter to access the SynchronizableContentsCollectionvoid
contextualize
(Context context) void
dispose()
getExtension
(String id) Returns the named extensionReturns a Set containing the ids of all known extensionsboolean
hasExtension
(String id) Returns true if the named extension existsvoid
void
Finalize the initialization of the extensions.
This method is called after alladdExtension()
calls.
This is the last step before the actual startup of the application.void
service
(ServiceManager smanager) Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger
-
Field Details
-
ROLE
Avalon Role
-
-
Constructor Details
-
SynchronizeContentsCollectionModelExtensionPoint
-
-
Method Details
-
initialize
- Specified by:
initialize
in interfaceInitializable
- Throws:
Exception
-
dispose
- Specified by:
dispose
in interfaceDisposable
-
service
- Specified by:
service
in interfaceServiceable
- Throws:
ServiceException
-
contextualize
- Specified by:
contextualize
in interfaceContextualizable
- Throws:
ContextException
-
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 interfaceExtensionPoint<SynchronizableContentsCollectionModel>
- Parameters:
id
- the unique identifier of the extension.pluginName
- Unique identifier for the plugin hosting the extensionfeatureName
- Unique feature identifier (unique for a given pluginName)configuration
- the information about the extension to be added- Throws:
ConfigurationException
- when a configuration problem occurs
-
addModel
protected void addModel(String pluginName, Configuration configuration) throws ConfigurationException Add a synchronizable contents collection model- Parameters:
pluginName
- The plugin nameconfiguration
- The configuration- Throws:
ConfigurationException
- when a configuration problem occurs
-
configureParameters
protected void configureParameters(SynchronizeContentsCollectionModelExtensionPoint.SynchronizableContentsCollectionModelParameterParser paramParser, Configuration configuration, String pluginName, Map<String, Parameter<ParameterHelper.ParameterType>> parameters) throws ConfigurationExceptionConfigure a parameter to access the SynchronizableContentsCollection- Parameters:
paramParser
- the parameter parser.configuration
- The parameter configuration.pluginName
- The plugin nameparameters
- The model parameters- Throws:
ConfigurationException
- if configuration is incomplete or invalid.
-
initializeExtensions
Description copied from interface:ExtensionPoint
Finalize the initialization of the extensions.
This method is called after alladdExtension()
calls.
This is the last step before the actual startup of the application.- Specified by:
initializeExtensions
in interfaceExtensionPoint<SynchronizableContentsCollectionModel>
- Throws:
Exception
- if something wrong occurs
-
hasExtension
Description copied from interface:ExtensionPoint
Returns true if the named extension exists- Specified by:
hasExtension
in interfaceExtensionPoint<SynchronizableContentsCollectionModel>
- Parameters:
id
- the unique id of the extension- Returns:
- true if the named extension exists
-
getExtension
Description copied from interface:ExtensionPoint
Returns the named extension- Specified by:
getExtension
in interfaceExtensionPoint<SynchronizableContentsCollectionModel>
- Parameters:
id
- the unique id of the extension- Returns:
- the named extension
-
getExtensionsIds
Description copied from interface:ExtensionPoint
Returns a Set containing the ids of all known extensions- Specified by:
getExtensionsIds
in interfaceExtensionPoint<SynchronizableContentsCollectionModel>
- Returns:
- a Set containing the ids of all known extensions
-