org.ametys.plugins.contentio.synchronize

Class SynchronizableContentsCollectionDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollectionDAO

All Implemented Interfaces:

LogEnabled, Disposable, Initializable, Component, Contextualizable, Serviceable

public class SynchronizableContentsCollectionDAO
extends AbstractLogEnabled
implements Component, Serviceable, Initializable, Contextualizable, Disposable

DAO for accessing SynchronizableContentsCollection

Field Summary

Fields

Modifier and Type	Field and Description
private static File	__CONFIGURATION_FILE
private ContentTypeExtensionPoint	_contentTypeEP
private Context	_context
private long	_lastFileReading
private ServiceManager	_smanager
private SynchronizeContentsCollectionModelExtensionPoint	_syncCollectionModelEP
private Map<String,SynchronizableContentsCollection>	_synchronizableCollections
private SynchronizingContentOperatorExtensionPoint	_synchronizingContentOperatorEP
private UserDirectoryFactory	_userDirectoryFactory
private UserPopulationDAO	_userPopulationDAO
private WorkflowProvider	_workflowProvider
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
SynchronizableContentsCollectionDAO()

Method Summary

Modifier and Type	Method and Description
private boolean	_addCollection(String id, Map<String,Object> values)
private File	_createBackup()
private void	_createFile(File file)
private SynchronizableContentsCollection	_createSynchronizableCollection(Configuration collectionConfig)
private String	_generateUniqueId(String label)
private List<String>	_getDatasourceBasedUserDirectories(List<UserDirectory> userDirectories)
private TransformerHandler	_getTransformerHandler(OutputStream os)
private boolean	_isValidContentType(ContentType cType)
private void	_readFile(boolean forceRead)
private void	_restoreBackup(File backup, boolean errorOccured)
private void	_saxCollection(ContentHandler handler, String id, Map<String,Object> parameters)
private void	_saxCollection(ContentHandler handler, SynchronizableContentsCollection collection)
private void	_saxModel(ContentHandler handler, String modelId, Map<String,Object> paramValues, boolean withPrefix)
private void	_saxNonNullValue(ContentHandler handler, String tagName, Object value)
private void	_toSAX(TransformerHandler handler)
private boolean	_writeFile()
String	addCollection(Map<String,Object> values) Add a new SynchronizableContentsCollection
void	contextualize(Context context)
void	dispose()
Map<String,Object>	editCollection(String id, Map<String,Object> values) Edit a SynchronizableContentsCollection
Map<String,Object>	getCollectionParameterValues(String collectionId) Gets the values of the parameters of the given collection
Map<String,Object>	getEditionConfiguration() Gets the configuration for creating/editing a collection of synchronizable contents.
List<Map<String,Object>>	getSupportedUserDirectories(String populationId) Gets the supported user directories (i.e.
SynchronizableContentsCollection	getSynchronizableContentsCollection(String collectionId) Get a synchronizable contents collection by its id
Map<String,Object>	getSynchronizableContentsCollectionAsJson(String collectionId) Gets a synchronizable contents collection to JSON format
Map<String,Object>	getSynchronizableContentsCollectionAsJson(SynchronizableContentsCollection collection) Gets a synchronizable contents collection to JSON format
List<SynchronizableContentsCollection>	getSynchronizableContentsCollections() Get the synchronizable contents collections
void	initialize()
Map<String,Object>	removeCollection(String id) Removes the given collection
void	service(ServiceManager smanager)

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

Field Detail

ROLE

public static final String ROLE

Avalon Role

__CONFIGURATION_FILE

private static final File __CONFIGURATION_FILE

_synchronizableCollections

private Map<String,SynchronizableContentsCollection> _synchronizableCollections

_lastFileReading

private long _lastFileReading

_syncCollectionModelEP

private SynchronizeContentsCollectionModelExtensionPoint _syncCollectionModelEP

_contentTypeEP

private ContentTypeExtensionPoint _contentTypeEP

_userPopulationDAO

private UserPopulationDAO _userPopulationDAO

_userDirectoryFactory

private UserDirectoryFactory _userDirectoryFactory

_workflowProvider

private WorkflowProvider _workflowProvider

_synchronizingContentOperatorEP

private SynchronizingContentOperatorExtensionPoint _synchronizingContentOperatorEP

_smanager

private ServiceManager _smanager

_context

private Context _context

Constructor Detail

SynchronizableContentsCollectionDAO

public SynchronizableContentsCollectionDAO()

Method Detail

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getSynchronizableContentsCollectionAsJson

public Map<String,Object> getSynchronizableContentsCollectionAsJson(String collectionId)

Gets a synchronizable contents collection to JSON format

Parameters:

collectionId - The id of the synchronizable contents collection to get

Returns:

An object representing a SynchronizableContentsCollection

getSynchronizableContentsCollectionAsJson

public Map<String,Object> getSynchronizableContentsCollectionAsJson(SynchronizableContentsCollection collection)

Gets a synchronizable contents collection to JSON format

Parameters:

collection - The synchronizable contents collection to get

Returns:

An object representing a SynchronizableContentsCollection

getSynchronizableContentsCollections

public List<SynchronizableContentsCollection> getSynchronizableContentsCollections()

Get the synchronizable contents collections

Returns:

the synchronizable contents collections

getSynchronizableContentsCollection

public SynchronizableContentsCollection getSynchronizableContentsCollection(String collectionId)

Get a synchronizable contents collection by its id

Parameters:

collectionId - The id of collection

Returns:

the synchronizable contents collection or null if not found

_readFile

private void _readFile(boolean forceRead)

_createFile

private void _createFile(File file)
                  throws IOException,
                         TransformerConfigurationException,
                         SAXException

Throws:

IOException

TransformerConfigurationException

SAXException

_createSynchronizableCollection

private SynchronizableContentsCollection _createSynchronizableCollection(Configuration collectionConfig)
                                                                  throws ConfigurationException

Throws:

ConfigurationException

getEditionConfiguration

public Map<String,Object> getEditionConfiguration()
                                           throws Exception

Gets the configuration for creating/editing a collection of synchronizable contents.

Returns:

A map containing information about what is needed to create/edit a collection of synchronizable contents

Throws:

Exception - If an error occurs.

_isValidContentType

private boolean _isValidContentType(ContentType cType)

getCollectionParameterValues

public Map<String,Object> getCollectionParameterValues(String collectionId)

Gets the values of the parameters of the given collection

Parameters:

collectionId - The id of the collection

Returns:

The values of the parameters

getSupportedUserDirectories

public List<Map<String,Object>> getSupportedUserDirectories(String populationId)

Gets the supported user directories (i.e. user directories based on a datasource) of the population in a json map

Parameters:

populationId - The id of the user population

Returns:

the supported user directories (i.e. user directories based on a datasource) of the population in a json map

_getDatasourceBasedUserDirectories

private List<String> _getDatasourceBasedUserDirectories(List<UserDirectory> userDirectories)

_writeFile

private boolean _writeFile()

_createBackup

private File _createBackup()

_restoreBackup

private void _restoreBackup(File backup,
                            boolean errorOccured)

addCollection

public String addCollection(Map<String,Object> values)
                     throws ProcessingException

Add a new SynchronizableContentsCollection

Parameters:

values - The parameters' values

Returns:

The id of new created collection or null in case of error

Throws:

ProcessingException - if creation failed

editCollection

public Map<String,Object> editCollection(String id,
                                         Map<String,Object> values)
                                  throws ProcessingException

Edit a SynchronizableContentsCollection

Parameters:

id - The id of collection to edit

values - The parameters' values

Returns:

The id of new created collection or null in case of error

Throws:

ProcessingException - if edition failed

_addCollection

private boolean _addCollection(String id,
                               Map<String,Object> values)
                        throws FileNotFoundException,
                               IOException,
                               TransformerConfigurationException,
                               SAXException

Throws:

FileNotFoundException

IOException

TransformerConfigurationException

SAXException

_getTransformerHandler

private TransformerHandler _getTransformerHandler(OutputStream os)
                                           throws TransformerConfigurationException

Throws:

TransformerConfigurationException

removeCollection

public Map<String,Object> removeCollection(String id)

Removes the given collection

Parameters:

id - The id of the collection to remove

Returns:

A map containing the id of the removed collection, or an error

_generateUniqueId

private String _generateUniqueId(String label)

_toSAX

private void _toSAX(TransformerHandler handler)
             throws SAXException

Throws:

SAXException

_saxCollection

private void _saxCollection(ContentHandler handler,
                            String id,
                            Map<String,Object> parameters)
                     throws SAXException

Throws:

SAXException

_saxCollection

private void _saxCollection(ContentHandler handler,
                            SynchronizableContentsCollection collection)
                     throws SAXException

Throws:

SAXException

_saxNonNullValue

private void _saxNonNullValue(ContentHandler handler,
                              String tagName,
                              Object value)
                       throws SAXException

Throws:

SAXException

_saxModel

private void _saxModel(ContentHandler handler,
                       String modelId,
                       Map<String,Object> paramValues,
                       boolean withPrefix)
                throws SAXException

Throws:

SAXException

dispose

public void dispose()

Specified by:

dispose in interface Disposable