org.ametys.plugins.contentio.synchronize.impl

Class UserPopulationSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.impl.UserPopulationSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, Configurable, Serviceable

public class UserPopulationSynchronizableContentsCollection
extends AbstractSynchronizableContentsCollection

Implementation of SynchronizableContentsCollection to be synchronized with a UserPopulation of the CMS.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	__LDAP_DEFAULT_PAGE_SIZE
protected static String	__PARAM_EMAIL_METADATA_NAME Name of parameter for the email metadata
protected static String	__PARAM_FIRSTNAME_METADATA_NAME Name of parameter for the firstname metadata
protected static String	__PARAM_LASTNAME_METADATA_NAME Name of parameter for the lastname metadata
protected static String	__PARAM_LOGIN_METADATA_NAME Name of parameter for the login metadata
protected static String	__PARAM_MAPPING Name of parameter holding the fields mapping
protected static String	__PARAM_MAPPING_ATTRIBUTE_PREFIX Name of parameter into mapping holding the remote attribute
protected static String	__PARAM_MAPPING_METADATA_REF Name of parameter into mapping holding the path of metadata
protected static String	__PARAM_MAPPING_SYNCHRO Name of parameter into mapping holding the synchronized property
protected static String	__PARAM_POPULATION_ID Name of parameter holding the id of population
protected JSONUtils	_jsonUtils The JSON utils
protected ServiceManager	_manager The service manager
protected UserPopulationDAO	_userPopulationDAO The DAO for user populations

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

_contentDAO, _contentPrefix, _contentType, _contentTypeEP, _contentTypesHelper, _currentUserProvider, _hasGlobalError, _i18nUtils, _id, _initialActionId, _label, _languagesManager, _modelId, _modelParamValues, _nbError, _observationManager, _removalSync, _reportMails, _resolver, _restrictedField, _synchronizingContentOperator, _synchronizingContentOperatorEP, _validateActionId, _validateAfterImport, _workflowName, _workflowProvider

Fields inherited from interface org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollection

COLLECTION_ID_PROPERTY

Constructor Summary

Constructors

Constructor and Description
UserPopulationSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method and Description
private Set<String>	_getUserDirectoryKeys(Map<String,Object> field, String prefix)
protected void	_internalPopulate(Logger logger) Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger)
String	getEmailMetadata() Get the metadata name for the email
Set<String>	getExternalOnlyFields() Get the path of field that are valued externally only.
String	getFirstNameMetadata() Get the metadata name for the first name
String	getIdField() Get the path of metadata holding the unique identifier
String	getLastNameMetadata() Get the metadata name for the last name
Set<String>	getLocalAndExternalFields() Get the path of tri-state fields (with local and external values)
String	getLoginMetadata() Get the metadata name for the login
Map<String,Map<String,List<String>>>	getMapping() Get the field mapping
String	getPopulationId() Get the id of the user population
protected void	importContentFromLdap(LdapUserDirectory userDirectory, Logger logger) Populate contents from a LDAP user directory of the population
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

_getContent, _getContentName, _getIdFieldValue, _handleContent, _isHandled, _parseParameters, applyChanges, configure, createContentAction, deleteUnexistingContents, getContentPrefix, getContentType, getId, getInitialActionId, getLabel, getParameterValues, getReportMails, getRestrictedField, getSynchronizeCollectionModelId, getSynchronizingContentOperator, getValidateActionId, getWorkflowName, importContent, importContent, populate, removalSync, sendErrorMail, synchronizeContent, updateSCCProperty, validateAfterImport, validateContent

Methods inherited from class java.lang.Object

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

Field Detail

__PARAM_POPULATION_ID

protected static final String __PARAM_POPULATION_ID

Name of parameter holding the id of population

See Also:

Constant Field Values

__PARAM_LOGIN_METADATA_NAME

protected static final String __PARAM_LOGIN_METADATA_NAME

Name of parameter for the login metadata

See Also:

Constant Field Values

__PARAM_FIRSTNAME_METADATA_NAME

protected static final String __PARAM_FIRSTNAME_METADATA_NAME

Name of parameter for the firstname metadata

See Also:

Constant Field Values

__PARAM_LASTNAME_METADATA_NAME

protected static final String __PARAM_LASTNAME_METADATA_NAME

Name of parameter for the lastname metadata

See Also:

Constant Field Values

__PARAM_EMAIL_METADATA_NAME

protected static final String __PARAM_EMAIL_METADATA_NAME

Name of parameter for the email metadata

See Also:

Constant Field Values

__PARAM_MAPPING

protected static final String __PARAM_MAPPING

Name of parameter holding the fields mapping

See Also:

Constant Field Values

__PARAM_MAPPING_SYNCHRO

protected static final String __PARAM_MAPPING_SYNCHRO

Name of parameter into mapping holding the synchronized property

See Also:

Constant Field Values

__PARAM_MAPPING_METADATA_REF

protected static final String __PARAM_MAPPING_METADATA_REF

Name of parameter into mapping holding the path of metadata

See Also:

Constant Field Values

__PARAM_MAPPING_ATTRIBUTE_PREFIX

protected static final String __PARAM_MAPPING_ATTRIBUTE_PREFIX

Name of parameter into mapping holding the remote attribute

See Also:

Constant Field Values

__LDAP_DEFAULT_PAGE_SIZE

private static final int __LDAP_DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

_userPopulationDAO

protected UserPopulationDAO _userPopulationDAO

The DAO for user populations

_manager

protected ServiceManager _manager

The service manager

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils

Constructor Detail

UserPopulationSynchronizableContentsCollection

public UserPopulationSynchronizableContentsCollection()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSynchronizableContentsCollection

Throws:

ServiceException

_internalPopulate

protected void _internalPopulate(Logger logger)

Description copied from class: AbstractSynchronizableContentsCollection

Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger)

Specified by:

_internalPopulate in class AbstractSynchronizableContentsCollection

Parameters:

logger - The logger

importContentFromLdap

protected void importContentFromLdap(LdapUserDirectory userDirectory,
                                     Logger logger)

Populate contents from a LDAP user directory of the population

Parameters:

userDirectory - The LDAP user directory

logger - The logger

getPopulationId

public String getPopulationId()

Get the id of the user population

Returns:

The id of user population

getIdField

public String getIdField()

Description copied from interface: SynchronizableContentsCollection

Get the path of metadata holding the unique identifier

Returns:

the path to the metadata. Can be null.

getLoginMetadata

public String getLoginMetadata()

Get the metadata name for the login

Returns:

The the metadata name for the login

getFirstNameMetadata

public String getFirstNameMetadata()

Get the metadata name for the first name

Returns:

The the metadata name for the first name

getLastNameMetadata

public String getLastNameMetadata()

Get the metadata name for the last name

Returns:

The the metadata name for the last name

getEmailMetadata

public String getEmailMetadata()

Get the metadata name for the email

Returns:

The the metadata name for the email

getExternalOnlyFields

public Set<String> getExternalOnlyFields()

Description copied from interface: SynchronizableContentsCollection

Get the path of field that are valued externally only.

Returns:

the external fields

getLocalAndExternalFields

public Set<String> getLocalAndExternalFields()

Description copied from interface: SynchronizableContentsCollection

Get the path of tri-state fields (with local and external values)

Returns:

the synchronized fields

getMapping

public Map<String,Map<String,List<String>>> getMapping()

Get the field mapping

Returns:

The mapping

_getUserDirectoryKeys

private Set<String> _getUserDirectoryKeys(Map<String,Object> field,
                                          String prefix)