Package org.ametys.plugins.contentio.synchronize

Interface SynchronizableContentsCollection

All Known Implementing Classes:

AbstractApogeeSynchronizableContentsCollection, AbstractApogeeSynchronizableContentsWithCatalogCollection, AbstractCDMFrSynchronizableContentsCollection, AbstractDataSourceSynchronizableContentsCollection, AbstractSimpleSynchronizableContentsCollection, AbstractStaticSynchronizableContentsCollection, AbstractSynchronizableContentsCollection, CDMFrSynchronizableContentsCollection, ContainerSynchronizableContentsCollection, CourseListSynchronizableContentsCollection, CoursePartSynchronizableContentsCollection, CourseSynchronizableContentsCollection, LDAPSynchronizableContentsCollection, LDAPSynchronizableUsersCollection, OrgUnitSynchronizableContentsCollection, PegaseSynchronizableContentsCollection, PersonSynchronizableContentsCollection, ProgramSynchronizableContentsCollection, RemoteCDMFrSynchronizableContentsCollection, SQLSynchronizableContentsCollection, SQLSynchronizableUDOrgunitCollection, SQLSynchronizableUsersCollection, SubProgramSynchronizableContentsCollection, UserPopulationSynchronizableContentsCollection

public interface SynchronizableContentsCollection

This interface represents a synchronizable collection of contents

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTION_ID_DATA_NAME	The name for the metadata indicating the ids of the collections
static final String	LAST_SYNCHRONIZATION_DATA_NAME	The name of the metadata indicating the date of the last synchronization
static final String	LAST_SYNCHRONIZATION_USER_DATA_NAME	The name of the metadata indicating the user that launched the last synchronization
static final String	RESULT_NB_CREATED_CONTENTS	The result map key for number of created contents
static final String	RESULT_NB_DELETED_CONTENTS	The result map key for number of deleted contents
static final String	RESULT_NB_NOT_CHANGED_CONTENTS	The result map key for number of synchronized contents
static final String	RESULT_NB_SYNCHRONIZED_CONTENTS	The result map key for number of synchronized contents

Method Summary

Modifier and Type	Method	Description
default ContentSynchronizationResult	additionalCommonOperations(ModifiableContent content, Map<String,Object> additionalParameters, Logger logger)	Add specific fields to the content during import or synchronization.
default ContentSynchronizationResult	additionalImportOperations(ModifiableContent content, Map<String,Object> additionalParameters, Logger logger)	Add specific fields to the content.
default ContentSynchronizationResult	additionalSynchronizeOperations(ModifiableContent content, Map<String,Object> additionalParameters, Logger logger)	Add specific fields to the content.
void	empty(Logger logger)	Empty the collection of its synchronized contents
ModifiableContent	getContent(String lang, String idValue)	Gets the content in the repository
String	getContentPrefix()	Get the prefix to use for the creation of contents
String	getContentType()	Get the type of content handled by this collection
String	getId()	Get the id of synchronizable collection.
String	getIdField()	Get the path of metadata holding the unique identifier
int	getInitialActionId()	Get the id of the initial action of the workflow
I18nizableText	getLabel()	Get the label of synchronizable collection
List<String>	getLanguages()	Get the languages handled by this collection
Set<String>	getLocalAndExternalFields(Map<String,Object> additionalParameters)	Get the path of tri-state fields (with local and external values)
Map<String,Object>	getParameterValues()	Get the untyped values of parameters for controller
String	getReportMails()	If an exception occurs during synchronization, an error report mail will be sent to those email addresses (separated by new lines)
String	getRestrictedField()	Get the path of boolean metadata for restricted content.
SCCSearchModelConfiguration	getSearchModelConfiguration()	Get the search UI model for search tool (columns, criterias, url for buttons, etc.)
Map<String,Integer>	getSynchronizationResult()	Retrieves the result of the synchronization as a map of key / content count containing The number of created contents The number of synchronized contents The number of unchanged contents The number of deleted contents
int	getSynchronizeActionId()	Get the id of the synchronize action of the workflow
String	getSynchronizeCollectionModelId()	Get the id of controller responsible of synchronization of this collection
String	getSynchronizingContentOperator()	Gets the id of the SynchronizingContentOperator extension to use during synchronization
int	getTotalCount(Map<String,Object> searchParameters, Logger logger)	Return the total number of results for the search.
int	getValidateActionId()	Get the id of the validate action of the workflow
String	getWorkflowName()	Get the name of the workflow to use for the synchronized contents
default boolean	handleRightAssignmentContext()	Return true if a RightAssignmentContext should be automatically generated for the contents of this SCC
boolean	ignoreRestrictions()	When returns true, the process ignore restrictions on attributes to synchronize it.
List<ModifiableContent>	importContent(String idValue, Map<String,Object> additionalParameters, Logger logger)	Import a content from remote values.
List<ModifiableContent>	populate(Logger logger, ContainerProgressionTracker progressionTracker)	Populates contents
boolean	removalSync()	When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.
Map<String,Map<String,Object>>	search(Map<String,Object> searchParameters, int offset, int limit, List<Object> sort, Logger logger)	Search the data to import from parameters.
void	synchronizeContent(ModifiableContent content, Logger logger)	Synchronize a content with remove values.
boolean	synchronizeExistingContentsOnly()	True to synchronize only existing contents
void	updateSyncInformations(ModifiableContent content, String syncCode, Logger logger)	Method to update the synchronisation informations (collection and value of the ID field).
boolean	validateAfterImport()	True to validate the contents after import

Field Details

COLLECTION_ID_DATA_NAME

static final String COLLECTION_ID_DATA_NAME

The name for the metadata indicating the ids of the collections

See Also:

• Constant Field Values

LAST_SYNCHRONIZATION_DATA_NAME

static final String LAST_SYNCHRONIZATION_DATA_NAME

The name of the metadata indicating the date of the last synchronization

See Also:

• Constant Field Values

LAST_SYNCHRONIZATION_USER_DATA_NAME

static final String LAST_SYNCHRONIZATION_USER_DATA_NAME

The name of the metadata indicating the user that launched the last synchronization

See Also:

• Constant Field Values

RESULT_NB_CREATED_CONTENTS

static final String RESULT_NB_CREATED_CONTENTS

The result map key for number of created contents

See Also:

• Constant Field Values

RESULT_NB_SYNCHRONIZED_CONTENTS

static final String RESULT_NB_SYNCHRONIZED_CONTENTS

The result map key for number of synchronized contents

See Also:

• Constant Field Values

RESULT_NB_NOT_CHANGED_CONTENTS

static final String RESULT_NB_NOT_CHANGED_CONTENTS

The result map key for number of synchronized contents

See Also:

• Constant Field Values

RESULT_NB_DELETED_CONTENTS

static final String RESULT_NB_DELETED_CONTENTS

The result map key for number of deleted contents

See Also:

• Constant Field Values

Method Details

getId

String getId()

Get the id of synchronizable collection.

Returns:

the id

getLabel

I18nizableText getLabel()

Get the label of synchronizable collection

Returns:

the label

getContentType

String getContentType()

Get the type of content handled by this collection

Returns:

the type of content

getLanguages

List<String> getLanguages()

Get the languages handled by this collection

Returns:

the list of language

getSynchronizeCollectionModelId

String getSynchronizeCollectionModelId()

Get the id of controller responsible of synchronization of this collection

Returns:

The id of controller

getParameterValues

Map<String,Object> getParameterValues()

Get the untyped values of parameters for controller

Returns:

the untyped values

removalSync

boolean removalSync()

When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.

Returns:

true if a content created by a previous synchro has to be removed if it does not exist anymore during the current synchro.

ignoreRestrictions

boolean ignoreRestrictions()

When returns true, the process ignore restrictions on attributes to synchronize it.

Returns:

true to ignore restrictions on synchronization

getWorkflowName

String getWorkflowName()

Get the name of the workflow to use for the synchronized contents

Returns:

the name of the workflow to use for the synchronized contents

getInitialActionId

int getInitialActionId()

Get the id of the initial action of the workflow

Returns:

The id of the initial action of the workflow

getSynchronizeActionId

int getSynchronizeActionId()

Get the id of the synchronize action of the workflow

Returns:

The id of the synchronize action of the workflow

getValidateActionId

int getValidateActionId()

Get the id of the validate action of the workflow

Returns:

The id of the validate action of the workflow

getContentPrefix

String getContentPrefix()

Get the prefix to use for the creation of contents

Returns:

The prefix to use for the creation of contents

validateAfterImport

boolean validateAfterImport()

True to validate the contents after import

Returns:

True to validate the contents after import

getReportMails

String getReportMails()

If an exception occurs during synchronization, an error report mail will be sent to those email addresses (separated by new lines)

Returns:

The email addresses to send an error report if an exception occurs during synchronization (separated by new lines)

getSynchronizingContentOperator

String getSynchronizingContentOperator()

Gets the id of the SynchronizingContentOperator extension to use during synchronization

Returns:

the id of the SynchronizingContentOperator extension to use during synchronization

getRestrictedField

String getRestrictedField()

Get the path of boolean metadata for restricted content. If true, the content will be visible only for connected users.

Returns:

the path to the metadata. Can be null.

getIdField

String getIdField()

Get the path of metadata holding the unique identifier

Returns:

the path to the metadata. Can be null.

getLocalAndExternalFields

Set<String> getLocalAndExternalFields(Map<String,Object> additionalParameters)

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

Parameters:

additionalParameters - Additional parameters

Returns:

the synchronized fields

getSearchModelConfiguration

SCCSearchModelConfiguration getSearchModelConfiguration()

Get the search UI model for search tool (columns, criterias, url for buttons, etc.)

Returns:

A SCCSearchModelConfiguration

synchronizeExistingContentsOnly

boolean synchronizeExistingContentsOnly()

True to synchronize only existing contents

Returns:

True to synchronize only existing contents

empty

void empty(Logger logger)

Empty the collection of its synchronized contents

Parameters:

logger - The logger

populate

List<ModifiableContent> populate(Logger logger,
 ContainerProgressionTracker progressionTracker)

Populates contents

Parameters:

logger - The logger

progressionTracker - A progression tracker

Returns:

Return the populated contents (imported or synchronized)

importContent

List<ModifiableContent> importContent(String idValue,
 Map<String,Object> additionalParameters,
 Logger logger)
                               throws Exception

Import a content from remote values.

Parameters:

idValue - Id (for import/synchronization) of the content to import

additionalParameters - Additional parameters

logger - The logger

Returns:

A list of created contents

Throws:

Exception - if an error occurs.

synchronizeContent

void synchronizeContent(ModifiableContent content,
 Logger logger)
                 throws Exception

Synchronize a content with remove values.

Parameters:

content - The content to synchronize

logger - The logger

Throws:

Exception - if an error occurs.

additionalImportOperations

default ContentSynchronizationResult additionalImportOperations(ModifiableContent content,
 Map<String,Object> additionalParameters,
 Logger logger)

Add specific fields to the content.

Parameters:

content - Content to update

additionalParameters - Additional parameters

logger - The logger

Returns:

The synchronization result of the import additional operations

additionalSynchronizeOperations

default ContentSynchronizationResult additionalSynchronizeOperations(ModifiableContent content,
 Map<String,Object> additionalParameters,
 Logger logger)

Add specific fields to the content.

Parameters:

content - Content to update

additionalParameters - Additional parameters

logger - The logger

Returns:

The synchronization result of the synchronize additional operations

additionalCommonOperations

default ContentSynchronizationResult additionalCommonOperations(ModifiableContent content,
 Map<String,Object> additionalParameters,
 Logger logger)

Add specific fields to the content during import or synchronization.

Parameters:

content - Content to update

additionalParameters - Additional parameters

logger - The logger

Returns:

The synchronization result of the additional operations

getContent

ModifiableContent getContent(String lang,
 String idValue)

Gets the content in the repository

Parameters:

lang - the language

idValue - the content name

Returns:

the content in the repository, or null if does not exist

search

Map<String,Map<String,Object>> search(Map<String,Object> searchParameters,
 int offset,
 int limit,
 List<Object> sort,
 Logger logger)

Search the data to import from parameters.

Parameters:

searchParameters - Parameters for the search

offset - Begin of the search

limit - Number of results

sort - Sort of results (ignored for LDAP results)

logger - The logger

Returns:

A map of remote values by content

updateSyncInformations

void updateSyncInformations(ModifiableContent content,
 String syncCode,
 Logger logger)
                     throws Exception

Method to update the synchronisation informations (collection and value of the ID field).

Parameters:

content - Content to update

syncCode - New synchronization code

logger - The logger

Throws:

Exception - if an error occurs.

getTotalCount

int getTotalCount(Map<String,Object> searchParameters,
 Logger logger)

Return the total number of results for the search.

Parameters:

searchParameters - Parameters for the search

logger - The logger

Returns:

The total count

getSynchronizationResult

Map<String,Integer> getSynchronizationResult()

Retrieves the result of the synchronization as a map of key / content count containing

• The number of created contents
• The number of synchronized contents
• The number of unchanged contents
• The number of deleted contents

Returns:

the result of the synchronization

handleRightAssignmentContext

default boolean handleRightAssignmentContext()

Return true if a RightAssignmentContext should be automatically generated for the contents of this SCC

Returns:

true to automatically generate a RightAssignmentContext. Return false if the rights of contents of this SCC are handle by its own RightAssignmentContext