org.fryske_akademy.exist.jobs

Class DataSyncTask

java.lang.Object

org.fryske_akademy.exist.jobs.DataSyncTask

All Implemented Interfaces:

org.exist.storage.SystemTask

Direct Known Subclasses:

DataSyncTaskCron

public class DataSyncTask
extends Object
implements org.exist.storage.SystemTask

Files in a directory specified by the parameter DATA_DIR will be synchronized to a collection specified by the parameter COLLECTION_PARAM recursively. If the target collection does not exist it will be created. Files and collections that are new or newer than the one in the target collection will be written to that collection. Files and collections that are not present in the source directory will be removed from the collection, this can be turned off via a boolean parameter REMOVE_FROM_COLLECTION_PARAM. Owner and group of collections and documents can be provided in parameters OWNERPARAM and GROUPPARAM, otherwise they will be the same as the owner and group of the parent collection of the provided collection parameter. After syncing cache is cleared to prevent problems, this can be turned off via boolean parameter CLEAR_CACHE_PARAM. NOTE that the sync will partially succeed when during syncing an exception occurs, collections and files added or removed before the exception will remain added/removed. Meant to be used as a start-up task, DataSyncTaskCron is meant to be scheduled as a cronjob.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLEAR_CACHE_PARAM
static String	CLEAR_CACHE_XQ should be placed in the root of your jar
static String	COLLECTION_PARAM
static String	DATA_DIR default data dir on filesystem (i.e.
static String	DATADIR_PARAM
static String	GROUPPARAM
static String	OWNERPARAM
static String	REMOVE_FROM_COLLECTION_PARAM
static String	XMLDBPREFIX

Constructor Summary

Constructors

Constructor and Description
DataSyncTask()

Method Summary

Modifier and Type	Method and Description
boolean	afterCheckpoint()
void	configure(org.exist.util.Configuration config, Properties properties)
void	execute(org.exist.storage.DBBroker broker, org.exist.storage.txn.Txn transaction)
String	getName()
protected void	storeInCollection(Path fileToStore, org.exist.xmldb.XmldbURI documentInCollection, org.exist.collections.Collection collection, org.exist.storage.txn.Txn transaction, org.exist.storage.DBBroker broker) This method uses either Collection.store(Txn, DBBroker, IndexInfo, InputSource) after validation to store the document, or Collection.addBinaryResource(Txn, DBBroker, XmldbURI, InputStream, String, long) for file types other than xml.

Methods inherited from class java.lang.Object

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

Field Detail

DATA_DIR

public static final String DATA_DIR

default data dir on filesystem (i.e. docker mount)

See Also:

Constant Field Values

COLLECTION_PARAM

public static final String COLLECTION_PARAM

See Also:

Constant Field Values

DATADIR_PARAM

public static final String DATADIR_PARAM

See Also:

Constant Field Values

REMOVE_FROM_COLLECTION_PARAM

public static final String REMOVE_FROM_COLLECTION_PARAM

See Also:

Constant Field Values

OWNERPARAM

public static final String OWNERPARAM

See Also:

Constant Field Values

GROUPPARAM

public static final String GROUPPARAM

See Also:

Constant Field Values

XMLDBPREFIX

public static final String XMLDBPREFIX

See Also:

Constant Field Values

CLEAR_CACHE_XQ

public static final String CLEAR_CACHE_XQ

should be placed in the root of your jar

See Also:

Constant Field Values

CLEAR_CACHE_PARAM

public static final String CLEAR_CACHE_PARAM

See Also:

Constant Field Values

Constructor Detail

DataSyncTask

public DataSyncTask()

Method Detail

getName

public String getName()

Specified by:

getName in interface org.exist.storage.SystemTask

configure

public void configure(org.exist.util.Configuration config,
                      Properties properties)
               throws org.exist.EXistException

Specified by:

configure in interface org.exist.storage.SystemTask

Throws:

org.exist.EXistException

execute

public void execute(org.exist.storage.DBBroker broker,
                    org.exist.storage.txn.Txn transaction)
             throws org.exist.EXistException

Specified by:

execute in interface org.exist.storage.SystemTask

Throws:

org.exist.EXistException

storeInCollection

protected void storeInCollection(Path fileToStore,
                                 org.exist.xmldb.XmldbURI documentInCollection,
                                 org.exist.collections.Collection collection,
                                 org.exist.storage.txn.Txn transaction,
                                 org.exist.storage.DBBroker broker)
                          throws org.exist.EXistException,
                                 org.exist.security.PermissionDeniedException,
                                 SAXException,
                                 org.exist.util.LockException,
                                 IOException

This method uses either Collection.store(Txn, DBBroker, IndexInfo, InputSource) after validation to store the document, or Collection.addBinaryResource(Txn, DBBroker, XmldbURI, InputStream, String, long) for file types other than xml.

Parameters:

fileToStore -

documentInCollection -

collection -

transaction -

broker -

Throws:

org.exist.EXistException

org.exist.security.PermissionDeniedException

SAXException

org.exist.util.LockException

IOException

afterCheckpoint

public boolean afterCheckpoint()

Specified by:

afterCheckpoint in interface org.exist.storage.SystemTask