Package org.ametys.plugins.contentio.synchronize.impl

Class DefaultSynchronizableContentsCollectionModel

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentio.synchronize.impl.DefaultSynchronizableContentsCollectionModel

All Implemented Interfaces:

SynchronizableContentsCollectionModel, Model, ModelItemAccessor, ModelItemContainer, LogEnabled, PluginAware, Disposable, Configurable, Contextualizable, Serviceable

public class DefaultSynchronizableContentsCollectionModel
extends AbstractLogEnabled
implements SynchronizableContentsCollectionModel, Serviceable, Contextualizable, PluginAware, Configurable, Disposable

Implementation of SynchronizableContentsCollectionModel able to populate contents from a LDAP source

Constructor Summary

Constructors

Constructor	Description
DefaultSynchronizableContentsCollectionModel()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
protected void	configureParameters(Configuration configuration)	Configure the SCC parameters
void	contextualize(Context context)
void	dispose()
I18nizableText	getDescription()	Get the description of this model
String	getId()	Retrieves the model id (an id must be unique in the family Model.getFamilyId()
I18nizableText	getLabel()	Get the label of this model
Collection<ModelItem>	getModelItems()	Retrieves all the model items of this accessor
String	getPluginName()	Returns the plugin name of declaration (for debug purpose)
Class<SynchronizableContentsCollection>	getSynchronizableCollectionClass()	Get the synchronizable collection class
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

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

Methods inherited from interface org.ametys.runtime.model.ModelItemAccessor

getChild, getModelItem, hasModelItem

Methods inherited from interface org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollectionModel

getFamilyId

Constructor Detail

DefaultSynchronizableContentsCollectionModel

public DefaultSynchronizableContentsCollectionModel()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

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

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

configureParameters

protected void configureParameters(Configuration configuration)
                            throws ConfigurationException

Configure the SCC parameters

Parameters:

configuration - the model configuration

Throws:

ConfigurationException - if a configuration exception occurred

dispose

public void dispose()

Specified by:

dispose in interface Disposable

getId

public String getId()

Description copied from interface: Model

Retrieves the model id (an id must be unique in the family Model.getFamilyId()

Specified by:

getId in interface Model

Returns:

model id (for example the content type id for a content)

getLabel

public I18nizableText getLabel()

Description copied from interface: SynchronizableContentsCollectionModel

Get the label of this model

Specified by:

getLabel in interface SynchronizableContentsCollectionModel

Returns:

the label of this model

getDescription

public I18nizableText getDescription()

Description copied from interface: SynchronizableContentsCollectionModel

Get the description of this model

Specified by:

getDescription in interface SynchronizableContentsCollectionModel

Returns:

the description

getModelItems

public Collection<ModelItem> getModelItems()

Description copied from interface: ModelItemAccessor

Retrieves all the model items of this accessor

Specified by:

getModelItems in interface ModelItemAccessor

Returns:

the model items

getPluginName

public String getPluginName()

Description copied from interface: SynchronizableContentsCollectionModel

Returns the plugin name of declaration (for debug purpose)

Specified by:

getPluginName in interface SynchronizableContentsCollectionModel

Returns:

the plugin name

getSynchronizableCollectionClass

public Class<SynchronizableContentsCollection> getSynchronizableCollectionClass()

Description copied from interface: SynchronizableContentsCollectionModel

Get the synchronizable collection class

Specified by:

getSynchronizableCollectionClass in interface SynchronizableContentsCollectionModel

Returns:

the synchronizable collection class