net.cnri.repository.syncing

Class SyncingRepository

java.lang.Object

net.cnri.repository.wrapper.RepositoryWrapper

net.cnri.repository.wrapper.DirectRepositoryWrapper

net.cnri.repository.syncing.SyncingRepository

All Implemented Interfaces:

DirectRepository, Repository

public class SyncingRepository
extends DirectRepositoryWrapper

Given two other repositories, a local and a remote this repository manages pulling objects from remote to local and pushing objects from local to remote. Which objects are pulled and pushed is determined by the queries that are added to the SyncingConfig object. For example you might have a query to pull all objects that have been modified on remote and push all objects that have been modified on local.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncingRepository.ModifiedSinceLastSyncQuery

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INTERNAL_DELETE_LOCAL_AFTER_SYNC
static java.lang.String	INTERNAL_SYNC
static java.lang.String	LOCAL_CONFIG_HANDLE

Constructor Summary

Constructors

Constructor and Description
SyncingRepository(Repository remote, DirectRepository local, SyncingConfig syncingConfig)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the repository and release all resources.
void	createDataElement(java.lang.String handle, java.lang.String name) Creates a new data element with the given name in this digital object.
DigitalObject	createDigitalObject(java.lang.String handle) Creates a new digital object with the given identifier in this repository.
void	deleteAttribute(java.lang.String handle, java.lang.String elementName, java.lang.String name) Deletes a particular attribute.
void	deleteAttributes(java.lang.String handle, java.lang.String elementName, java.util.List<java.lang.String> names) Deletes multiple attributes.
void	deleteDataElement(java.lang.String handle, java.lang.String name) Deletes any data element of the given name.
SyncingConfig	getConfig()
long	getGreatestModifiedFromRemote()
long	getLastSyncTime()
long	getPriorLastSyncTime()
void	lock(java.lang.String handle)
void	setAttribute(java.lang.String handle, java.lang.String elementName, java.lang.String name, java.lang.String value) Sets a particular attribute.
void	setAttributes(java.lang.String handle, java.lang.String elementName, java.util.Map<java.lang.String,java.lang.String> attributes) Sets the value of multiple attributes.
void	startSyncing()
void	stopSyncing()
void	syncNow()
void	unlock(java.lang.String handle)
long	write(java.lang.String handle, java.lang.String elementName, java.io.InputStream data, boolean append) Writes new data into the data element.

Methods inherited from class net.cnri.repository.wrapper.DirectRepositoryWrapper

getAttribute, getAttributes, getFile, getSize, listAttributes, listDataElementNames, read, verifyDataElement

Methods inherited from class net.cnri.repository.wrapper.RepositoryWrapper

deleteDigitalObject, getDigitalObject, getHandle, getOrCreateDigitalObject, listHandles, listObjects, search, search, search, searchHandles, searchHandles, searchHandles, searchMapping, verifyDigitalObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.cnri.repository.Repository

deleteDigitalObject, getDigitalObject, getHandle, getOrCreateDigitalObject, listHandles, listObjects, search, search, search, searchHandles, searchHandles, searchHandles, searchMapping, verifyDigitalObject

Field Detail

LOCAL_CONFIG_HANDLE

public static final java.lang.String LOCAL_CONFIG_HANDLE

See Also:

Constant Field Values

INTERNAL_SYNC

public static final java.lang.String INTERNAL_SYNC

See Also:

Constant Field Values

INTERNAL_DELETE_LOCAL_AFTER_SYNC

public static final java.lang.String INTERNAL_DELETE_LOCAL_AFTER_SYNC

See Also:

Constant Field Values

Constructor Detail

SyncingRepository

public SyncingRepository(Repository remote,
                 DirectRepository local,
                 SyncingConfig syncingConfig)
                  throws RepositoryException

Throws:

RepositoryException

Method Detail

lock

public void lock(java.lang.String handle)

getConfig

public SyncingConfig getConfig()

getGreatestModifiedFromRemote

public long getGreatestModifiedFromRemote()

getLastSyncTime

public long getLastSyncTime()

getPriorLastSyncTime

public long getPriorLastSyncTime()

unlock

public void unlock(java.lang.String handle)

startSyncing

public void startSyncing()

stopSyncing

public void stopSyncing()

syncNow

public void syncNow()
             throws RepositoryException,
                    java.io.IOException

Throws:

RepositoryException

java.io.IOException

close

public void close()

Description copied from interface: Repository

Close the repository and release all resources.

Specified by:

close in interface Repository

Overrides:

close in class RepositoryWrapper

createDigitalObject

public DigitalObject createDigitalObject(java.lang.String handle)
                                  throws CreationException,
                                         RepositoryException

Description copied from interface: Repository

Creates a new digital object with the given identifier in this repository. Passing null requests that the repository assign a new unique identifier; this method will throw UnsupportedOperationException if the given repository does not support that functionality.

Specified by:

createDigitalObject in interface Repository

Overrides:

createDigitalObject in class RepositoryWrapper

Parameters:

handle - the identifier for the new digital object, or null to request that the repository assign a new unique identifier.

Returns:

the newly-created digital object

Throws:

CreationException - if an object with the given identifier already exists within the repository

RepositoryException

setAttributes

public void setAttributes(java.lang.String handle,
                 java.lang.String elementName,
                 java.util.Map<java.lang.String,java.lang.String> attributes)
                   throws RepositoryException

Description copied from interface: DirectRepository

Sets the value of multiple attributes. Attributes mapped to null will be deleted.

Specified by:

setAttributes in interface DirectRepository

Overrides:

setAttributes in class DirectRepositoryWrapper

attributes - the attributes to set, mapped to their new values

Throws:

RepositoryException

setAttribute

public void setAttribute(java.lang.String handle,
                java.lang.String elementName,
                java.lang.String name,
                java.lang.String value)
                  throws RepositoryException

Description copied from interface: DirectRepository

Sets a particular attribute.

Specified by:

setAttribute in interface DirectRepository

Overrides:

setAttribute in class DirectRepositoryWrapper

name - the attribute name

value - the attribute value; if null, the attribute will be deleted.

Throws:

RepositoryException

deleteAttributes

public void deleteAttributes(java.lang.String handle,
                    java.lang.String elementName,
                    java.util.List<java.lang.String> names)
                      throws RepositoryException

Description copied from interface: DirectRepository

Deletes multiple attributes.

Specified by:

deleteAttributes in interface DirectRepository

Overrides:

deleteAttributes in class DirectRepositoryWrapper

names - the names of the attributes to delete

Throws:

RepositoryException

deleteAttribute

public void deleteAttribute(java.lang.String handle,
                   java.lang.String elementName,
                   java.lang.String name)
                     throws RepositoryException

Description copied from interface: DirectRepository

Deletes a particular attribute.

Specified by:

deleteAttribute in interface DirectRepository

Overrides:

deleteAttribute in class DirectRepositoryWrapper

name - the name of the attribute to delete

Throws:

RepositoryException

createDataElement

public void createDataElement(java.lang.String handle,
                     java.lang.String name)
                       throws CreationException,
                              RepositoryException

Description copied from interface: DirectRepository

Creates a new data element with the given name in this digital object.

Specified by:

createDataElement in interface DirectRepository

Overrides:

createDataElement in class DirectRepositoryWrapper

name - the identifier for the new data element

Throws:

CreationException - if a data element with the given name already exists

RepositoryException

deleteDataElement

public void deleteDataElement(java.lang.String handle,
                     java.lang.String name)
                       throws RepositoryException

Description copied from interface: DirectRepository

Deletes any data element of the given name.

Specified by:

deleteDataElement in interface DirectRepository

Overrides:

deleteDataElement in class DirectRepositoryWrapper

name - the identifier for the data element

Throws:

RepositoryException

write

public long write(java.lang.String handle,
         java.lang.String elementName,
         java.io.InputStream data,
         boolean append)
           throws java.io.IOException,
                  RepositoryException

Description copied from interface: DirectRepository

Writes new data into the data element.

Specified by:

write in interface DirectRepository

Overrides:

write in class DirectRepositoryWrapper

data - an InputStream streaming the new data

append - whether to append the new data to the existing data

Returns:

the number of bytes of data written

Throws:

java.io.IOException

RepositoryException