Package org.dspace.ctask.replicate

Class ReplicaManager

java.lang.Object

org.dspace.ctask.replicate.ReplicaManager

public class ReplicaManager
extends Object

Singleton access point for communicating with replication access providers. ReplicaManager adds a thin accounting or bookkeeping layer, recording activity with the storage provider.

Author:

richardrodgers

Method Summary

Modifier and Type	Method	Description
String	canonicalId(String storageId)	Convert a Storage ID back into a Canonical Identifier (opposite of 'storageId()' method).
String	deletionCatalogId(String objId, String fileExtension)	Determine the ID of an object's deletion catalog in storage.
File	fetchObject(org.dspace.core.Context context, String group, String objId)
Odometer	getOdometer()
static ReplicaManager	instance()
boolean	moveObject(String srcGroup, String destGroup, String objId)
String	objectAttribute(String group, String objId, String attrName)
boolean	objectExists(String group, String objId)
void	removeObject(String group, String objId)
File	stage(org.dspace.core.Context context, String group, String id)
String	storageId(org.dspace.core.Context context, String objId, String fileExtension)	Determine the Identifier of an object once it is placed in storage.
void	transferObject(String group, File file)

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static ReplicaManager instance()
                               throws IOException

Throws:

IOException

stage

public File stage(org.dspace.core.Context context,
                  String group,
                  String id)

storageId

public String storageId(org.dspace.core.Context context,
                        String objId,
                        String fileExtension)

Determine the Identifier of an object once it is placed in storage. This method ensures any special characters are escaped. It also ensures all objects are named in a similar manner once they are in a given store (so that they can similarly be retrieved from storage using this same 'storageId').

Parameters:

context - the context to use

objId - - original object id (canonical ID)

fileExtension - - file extension, if any (may be null)

Returns:

reformatted storage ID for this object (including file extension)

canonicalId

public String canonicalId(String storageId)

Convert a Storage ID back into a Canonical Identifier (opposite of 'storageId()' method).

Parameters:

storageId - the given object's storage ID

Returns:

the objects canonical identifier

deletionCatalogId

public String deletionCatalogId(String objId,
                                String fileExtension)

Determine the ID of an object's deletion catalog in storage. This method ensures any special characters are escaped. It also ensures all objects are named in a similar manner once they are in a given store (so that they can similarly be retrieved from storage using this same 'storageId').

Parameters:

objId - - original object id (canonical ID)

fileExtension - - file extension, if any (may be null)

Returns:

reformatted storage ID for this object (including file extension)

getOdometer

public Odometer getOdometer()
                     throws IOException

Throws:

IOException

fetchObject

public File fetchObject(org.dspace.core.Context context,
                        String group,
                        String objId)
                 throws IOException

Throws:

IOException

transferObject

public void transferObject(String group,
                           File file)
                    throws IOException

Throws:

IOException

objectExists

public boolean objectExists(String group,
                            String objId)
                     throws IOException

Throws:

IOException

objectAttribute

public String objectAttribute(String group,
                              String objId,
                              String attrName)
                       throws IOException

Throws:

IOException

removeObject

public void removeObject(String group,
                         String objId)
                  throws IOException

Throws:

IOException

moveObject

public boolean moveObject(String srcGroup,
                          String destGroup,
                          String objId)
                   throws IOException

Throws:

IOException