net.cnri.apps.doserver

Interface Storage

All Known Implementing Classes:

AbstractStorage, HashDirectoryStorage

public interface Storage

This interface specifies an interface to the back-end storage system for a registry.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
java.lang.String	createObject(java.lang.String objectID, java.lang.String objectName, boolean logTxn) Creates a new digital object with the given ID, if one does not already exist.
java.lang.String	createObject(java.lang.String objectID, java.lang.String objectName, boolean logTxn, long timestamp) Creates a new digital object with the given ID, if one does not already exist.
java.lang.String	createObject(java.lang.String objectID, java.lang.String objectName, HeaderSet txnMetadata, long timestamp) Version with enhanced logging (stores txnMetadata in transaction)
void	deleteAttributes(java.lang.String objectID, java.lang.String elementID, java.lang.String[] attributeKeys, boolean logTxn, long timestamp) Remove the attributes with the given keys from the object or data element.
void	deleteAttributes(java.lang.String objectID, java.lang.String elementID, java.lang.String[] attributeKeys, HeaderSet txnMetadata, long timestamp) Version with enhanced logging (stores txnMetadata in transaction)
boolean	deleteDataElement(java.lang.String objectID, java.lang.String elementID, boolean logTxn) Deletes the specified data element from the given object.
boolean	deleteDataElement(java.lang.String objectID, java.lang.String elementID, boolean logTxn, long timestamp) Deletes the specified data element from the given object.
boolean	deleteDataElement(java.lang.String objectID, java.lang.String elementID, HeaderSet txnMetadata, long timestamp) Version with enhanced logging (stores txnMetadata in transaction)
void	deleteObject(java.lang.String objectID, boolean logTxn) Deletes the digital object along with all data elements or files that are associated with it.
void	deleteObject(java.lang.String objectID, boolean logTxn, long asOfTimestamp) Deletes the digital object along with all data elements or files that are associated with it.
void	deleteObject(java.lang.String objectID, HeaderSet txnMetadata, long asOfTimestamp) Version with enhanced logging (stores txnMetadata in transaction)
void	deserializeObject(java.lang.String objectID, java.lang.String format, java.io.InputStream in) Reset the object's state and re-initialize the object with the data in the given InputStream in the given format.
boolean	doesDataElementExist(java.lang.String objectID, java.lang.String elementID) Returns true if the given data element exists
boolean	doesObjectExist(java.lang.String objectID) Returns true if the given digital object exists.
HeaderSet	getAttributes(java.lang.String objectID, java.lang.String elementID, HeaderSet container) Get the attributes for the given object or element within the object.
java.io.InputStream	getDataElement(java.lang.String objectID, java.lang.String elementID) Returns the identified data element for the given object.
java.io.File	getFileForDataElement(java.lang.String objectID, java.lang.String elementID) Returns the File in which the given data element is stored, if any.
DOMetadata	getObjectInfo(java.lang.String objectID, DOMetadata metadata) Returns any known metadata for the digital object with the given identifier.
AbstractTransactionQueue	getTransactionQueue() Returns the transaction queue set up by this storage
void	initTransactionQueue(java.io.File txnDir) Initialize the transaction queue in the given directory---server calls this after initializing storage
void	initWithDirectory(Main server, java.io.File baseDirectory) Initializes the storage for use with server based in the given storage directory.
java.util.Enumeration	listDataElements(java.lang.String objectID) Returns an Enumeration (so that not all elements have to be loaded at once)
java.util.Enumeration	listObjects() Returns an Enumeration of all of the object IDs in the repository.
void	serializeObject(java.lang.String objectID, java.lang.String format, java.io.OutputStream out) Write the entire object into the given OutputStream in the given format
void	setAttributes(java.lang.String objectID, java.lang.String elementID, HeaderSet attributes, boolean logTxn, long timestamp) Add the given key-value attribute to the object, replacing any existing attribute that has the same key.
void	setAttributes(java.lang.String objectID, java.lang.String elementID, HeaderSet attributes, HeaderSet txnMetadata, long timestamp) Version with enhanced logging (stores txnMetadata in transaction)
void	setObjectInfo(DOMetadata metadata) Sets the metadata for the object specified by the given DOMetadata.
void	setTransactionQueue(AbstractTransactionQueue txnQueue) Set the transaction queue (used e.g.
void	storeDataElement(java.lang.String objectID, java.lang.String elementID, java.io.InputStream input, boolean logTxn, boolean append) Stores the data read from the given InputStream into the given data element for the object identified by objectID.
void	storeDataElement(java.lang.String objectID, java.lang.String elementID, java.io.InputStream input, boolean logTxn, boolean append, long timestamp) Stores the data read from the given InputStream into the given data element for the object identified by objectID.
void	storeDataElement(java.lang.String objectID, java.lang.String elementID, java.io.InputStream input, HeaderSet txnMetadata, boolean append, long timestamp) Version with enhanced logging (stores txnMetadata in transaction)

Method Detail

initWithDirectory

void initWithDirectory(Main server,
                     java.io.File baseDirectory)
                       throws DOException

Initializes the storage for use with server based in the given storage directory.

Throws:

DOException

close

void close()

getTransactionQueue

AbstractTransactionQueue getTransactionQueue()

Returns the transaction queue set up by this storage

setTransactionQueue

void setTransactionQueue(AbstractTransactionQueue txnQueue)

Set the transaction queue (used e.g. by Multi-Storage to arrange for a unique queue)

initTransactionQueue

void initTransactionQueue(java.io.File txnDir)
                          throws java.lang.Exception

Initialize the transaction queue in the given directory---server calls this after initializing storage

Throws:

java.lang.Exception

createObject

java.lang.String createObject(java.lang.String objectID,
                            java.lang.String objectName,
                            boolean logTxn)
                              throws DOException

Creates a new digital object with the given ID, if one does not already exist. Returns the object identifier. If logTxn is set, this change will be recorded in the transaction log, and therefore replicated to the other servers.

Throws:

DOException

createObject

java.lang.String createObject(java.lang.String objectID,
                            java.lang.String objectName,
                            boolean logTxn,
                            long timestamp)
                              throws DOException

Creates a new digital object with the given ID, if one does not already exist. Returns the object identifier. If logTxn is set, this change will be recorded in the transaction log, and therefore replicated to the other servers. The timestamp parameter refers to the date/time that this create operation was supposed to have happened. The timestamp parameter should only be used by the replication manager.

Throws:

DOException

getObjectInfo

DOMetadata getObjectInfo(java.lang.String objectID,
                       DOMetadata metadata)
                         throws DOException

Returns any known metadata for the digital object with the given identifier. If the given DOMetadata object is non-null then the metadata is stored in that object which is also returned. Otherwise, a new DOMetadata instance is constructed and returned. Note that this method returns a non-null value whether or not the object exists.

Throws:

DOException

setObjectInfo

void setObjectInfo(DOMetadata metadata)
                   throws DOException

Sets the metadata for the object specified by the given DOMetadata.

Throws:

DOException

deleteObject

void deleteObject(java.lang.String objectID,
                boolean logTxn)
                  throws DOException

Deletes the digital object along with all data elements or files that are associated with it. If logTxn is set, this change will be recorded in the transaction log, and therefore replicated to the other servers.

Throws:

DOException

deleteObject

void deleteObject(java.lang.String objectID,
                boolean logTxn,
                long asOfTimestamp)
                  throws DOException

Deletes the digital object along with all data elements or files that are associated with it. If logTxn is set, this change will be recorded in the transaction log, and therefore replicated to the other servers. The asOfTimestamp parameter is provided in order to delete the given object as of a certain date/time for replication purposes.

Throws:

DOException

doesObjectExist

boolean doesObjectExist(java.lang.String objectID)
                        throws DOException

Returns true if the given digital object exists.

Throws:

DOException

listObjects

java.util.Enumeration listObjects()
                                  throws DOException

Returns an Enumeration of all of the object IDs in the repository.

Throws:

DOException

listDataElements

java.util.Enumeration listDataElements(java.lang.String objectID)
                                       throws DOException

Returns an Enumeration (so that not all elements have to be loaded at once)

Throws:

DOException

doesDataElementExist

boolean doesDataElementExist(java.lang.String objectID,
                           java.lang.String elementID)
                             throws DOException

Returns true if the given data element exists

Throws:

DOException

getFileForDataElement

java.io.File getFileForDataElement(java.lang.String objectID,
                                 java.lang.String elementID)
                                   throws DOException

Returns the File in which the given data element is stored, if any. This can return null on servers where data elements are not stored in files. This is used where operators need to do more with a data element than simple read and write operations. Examples inlude indexes, databases, etc.

Throws:

DOException

getDataElement

java.io.InputStream getDataElement(java.lang.String objectID,
                                 java.lang.String elementID)
                                   throws DOException

Returns the identified data element for the given object.

Throws:

DOException

storeDataElement

void storeDataElement(java.lang.String objectID,
                    java.lang.String elementID,
                    java.io.InputStream input,
                    boolean logTxn,
                    boolean append)
                      throws DOException

Stores the data read from the given InputStream into the given data element for the object identified by objectID. This reads from the InputStream until the end of the stream has been reached. If logTxn is set, this change will be recorded in the transaction log, and therefore replicated to the other servers. If append is true, then this will append the bytes from the given input stream to the existing data element.

Throws:

DOException

storeDataElement

void storeDataElement(java.lang.String objectID,
                    java.lang.String elementID,
                    java.io.InputStream input,
                    boolean logTxn,
                    boolean append,
                    long timestamp)
                      throws DOException

Stores the data read from the given InputStream into the given data element for the object identified by objectID. This reads from the InputStream until the end of the stream has been reached. If logTxn is set, this change will be recorded in the transaction log, and therefore replicated to the other servers. If append is true, then this will append the bytes from the given input stream to the existing data element. The given timestamp is used to record the date that the data element was updated, if not now. The timestamp parameter should only be used by the replication manager.

Throws:

DOException

deleteDataElement

boolean deleteDataElement(java.lang.String objectID,
                        java.lang.String elementID,
                        boolean logTxn)
                          throws DOException

Deletes the specified data element from the given object. Returns true if the specified data element ever existed in the first place. If logTxn is set, this change will be recorded in the transaction log, and therefore replicated to the other servers.

Throws:

DOException

deleteDataElement

boolean deleteDataElement(java.lang.String objectID,
                        java.lang.String elementID,
                        boolean logTxn,
                        long timestamp)
                          throws DOException

Deletes the specified data element from the given object. Returns true if the specified data element ever existed in the first place. If logTxn is set, this change will be recorded in the transaction log, and therefore replicated to the other servers. The given timestamp is used to record the date that the data element was deleted, if not now. The timestamp parameter should only be used by the replication manager.

Throws:

DOException

getAttributes

HeaderSet getAttributes(java.lang.String objectID,
                      java.lang.String elementID,
                      HeaderSet container)
                        throws DOException

Get the attributes for the given object or element within the object. If elementID is null then this will get the attributes of the object. If the given container is non-null then the attributes will be added to it and returned.

Throws:

DOException

setAttributes

void setAttributes(java.lang.String objectID,
                 java.lang.String elementID,
                 HeaderSet attributes,
                 boolean logTxn,
                 long timestamp)
                   throws DOException

Add the given key-value attribute to the object, replacing any existing attribute that has the same key. If the elementID is non-null then the attribute is associated with the identified element within the object.

Throws:

DOException

deleteAttributes

void deleteAttributes(java.lang.String objectID,
                    java.lang.String elementID,
                    java.lang.String[] attributeKeys,
                    boolean logTxn,
                    long timestamp)
                      throws DOException

Remove the attributes with the given keys from the object or data element. If the elementID is null then the attributes are removed from the object, otherwise they are removed from the element.

Throws:

DOException

serializeObject

void serializeObject(java.lang.String objectID,
                   java.lang.String format,
                   java.io.OutputStream out)
                     throws DOException

Write the entire object into the given OutputStream in the given format

Throws:

DOException

deserializeObject

void deserializeObject(java.lang.String objectID,
                     java.lang.String format,
                     java.io.InputStream in)
                       throws DOException

Reset the object's state and re-initialize the object with the data in the given InputStream in the given format.

Throws:

DOException

createObject

java.lang.String createObject(java.lang.String objectID,
                            java.lang.String objectName,
                            HeaderSet txnMetadata,
                            long timestamp)
                              throws DOException

Version with enhanced logging (stores txnMetadata in transaction)

Throws:

DOException

deleteObject

void deleteObject(java.lang.String objectID,
                HeaderSet txnMetadata,
                long asOfTimestamp)
                  throws DOException

Version with enhanced logging (stores txnMetadata in transaction)

Throws:

DOException

storeDataElement

void storeDataElement(java.lang.String objectID,
                    java.lang.String elementID,
                    java.io.InputStream input,
                    HeaderSet txnMetadata,
                    boolean append,
                    long timestamp)
                      throws DOException

Version with enhanced logging (stores txnMetadata in transaction)

Throws:

DOException

deleteDataElement

boolean deleteDataElement(java.lang.String objectID,
                        java.lang.String elementID,
                        HeaderSet txnMetadata,
                        long timestamp)
                          throws DOException

Version with enhanced logging (stores txnMetadata in transaction)

Throws:

DOException

setAttributes

void setAttributes(java.lang.String objectID,
                 java.lang.String elementID,
                 HeaderSet attributes,
                 HeaderSet txnMetadata,
                 long timestamp)
                   throws DOException

Version with enhanced logging (stores txnMetadata in transaction)

Throws:

DOException

deleteAttributes

void deleteAttributes(java.lang.String objectID,
                    java.lang.String elementID,
                    java.lang.String[] attributeKeys,
                    HeaderSet txnMetadata,
                    long timestamp)
                      throws DOException

Version with enhanced logging (stores txnMetadata in transaction)

Throws:

DOException