org.fcrepo.server.journal

Class JournalCreator

java.lang.Object

org.fcrepo.server.journal.JournalCreator

All Implemented Interfaces:

JournalConstants, JournalWorker, Management

public class JournalCreator
extends Object
implements JournalWorker, JournalConstants

This is the worker class to use in Journaling mode (normal mode).

Each time a "writing" Management method is called, create a CreatorJournalEntry and ask it to invoke the method on the ManagementDelegate. If a "read-only" Management method is called, just pass it along to the ManagementDelegate.

Author:

Jim Blake

Field Summary

Fields inherited from interface org.fcrepo.server.journal.JournalConstants

ARGUMENT_NAME_ALT_IDS, ARGUMENT_NAME_CHECKSUM, ARGUMENT_NAME_CHECKSUM_TYPE, ARGUMENT_NAME_CONTEXT, ARGUMENT_NAME_CONTROL_GROUP, ARGUMENT_NAME_DATATYPE, ARGUMENT_NAME_DISSEMINATOR_ID, ARGUMENT_NAME_DISSEMINATOR_LABEL, ARGUMENT_NAME_DISSEMINATOR_STATE, ARGUMENT_NAME_DS_CONTENT, ARGUMENT_NAME_DS_ID, ARGUMENT_NAME_DS_LABEL, ARGUMENT_NAME_DS_LOCATION, ARGUMENT_NAME_DS_STATE, ARGUMENT_NAME_ENCODING, ARGUMENT_NAME_END_DATE, ARGUMENT_NAME_FORCE, ARGUMENT_NAME_FORMAT, ARGUMENT_NAME_FORMAT_URI, ARGUMENT_NAME_IN, ARGUMENT_NAME_IS_LITERAL, ARGUMENT_NAME_LABEL, ARGUMENT_NAME_LAST_MODIFIED_DATE, ARGUMENT_NAME_LOCATION, ARGUMENT_NAME_LOG_MESSAGE, ARGUMENT_NAME_MIME_TYPE, ARGUMENT_NAME_NAMESPACE, ARGUMENT_NAME_NEW_PID, ARGUMENT_NAME_NUM_PIDS, ARGUMENT_NAME_OBJECT, ARGUMENT_NAME_OWNERID, ARGUMENT_NAME_PID, ARGUMENT_NAME_RELATIONSHIP, ARGUMENT_NAME_SERIALIZATION, ARGUMENT_NAME_START_DATE, ARGUMENT_NAME_STATE, ARGUMENT_NAME_VERSION_DATE, ARGUMENT_NAME_VERSIONABLE, ARGUMENT_TYPE_BINDING_MAP, ARGUMENT_TYPE_BOOLEAN, ARGUMENT_TYPE_DATE, ARGUMENT_TYPE_INTEGER, ARGUMENT_TYPE_NULL, ARGUMENT_TYPE_STREAM, ARGUMENT_TYPE_STRING, ARGUMENT_TYPE_STRINGARRAY, CONTEXT_MAPNAME_ACTION, CONTEXT_MAPNAME_ENVIRONMENT, CONTEXT_MAPNAME_RECOVERY, CONTEXT_MAPNAME_RESOURCE, CONTEXT_MAPNAME_SUBJECT, DEFAULT_AGE_LIMIT, DEFAULT_FILENAME_PREFIX, DEFAULT_SIZE_LIMIT, DOCUMENT_ENCODING, DOCUMENT_VERSION, FORMAT_JOURNAL_FILENAME_TIMESTAMP, METHOD_ADD_DATASTREAM, METHOD_ADD_DISSEMINATOR, METHOD_ADD_RELATIONSHIP, METHOD_GET_NEXT_PID, METHOD_INGEST, METHOD_MODIFY_DATASTREAM_BY_REFERENCE, METHOD_MODIFY_DATASTREAM_BY_VALUE, METHOD_MODIFY_DISSEMINATOR, METHOD_MODIFY_OBJECT, METHOD_PURGE_DATASTREAM, METHOD_PURGE_DISSEMINATOR, METHOD_PURGE_OBJECT, METHOD_PURGE_RELATIONSHIP, METHOD_PUT_TEMP_STREAM, METHOD_SET_DATASTREAM_STATE, METHOD_SET_DATASTREAM_VERSIONABLE, METHOD_SET_DISSEMINATOR_STATE, PARAMETER_IGNORE_HASH, PARAMETER_JOURNAL_FILE_AGE_LIMIT, PARAMETER_JOURNAL_FILE_SIZE_LIMIT, PARAMETER_JOURNAL_FILENAME_PREFIX, PARAMETER_JOURNAL_MODE, PARAMETER_JOURNAL_READER_CLASSNAME, PARAMETER_JOURNAL_RECOVERY_LOG_CLASSNAME, PARAMETER_JOURNAL_WRITER_CLASSNAME, PARAMETER_RECOVERY_LOG_FILENAME, PARAMETER_RECOVERY_LOG_LEVEL, PASSWORD_CIPHER_TYPE, QNAME_ATTR_BIND_KEY_NAME, QNAME_ATTR_BIND_LABEL, QNAME_ATTR_CLIENT_IP, QNAME_ATTR_DATASTREAM_ID, QNAME_ATTR_DS_BIND_MAP_ID, QNAME_ATTR_DS_BIND_MAP_LABEL, QNAME_ATTR_DS_BIND_MECHANISM_PID, QNAME_ATTR_LOGIN_ID, QNAME_ATTR_METHOD, QNAME_ATTR_NAME, QNAME_ATTR_PASSWORD_TYPE, QNAME_ATTR_REPOSITORY_HASH, QNAME_ATTR_SEQ_NO, QNAME_ATTR_STATE, QNAME_ATTR_TIMESTAMP, QNAME_ATTR_TYPE, QNAME_ATTR_USERID, QNAME_TAG_ARGUMENT, QNAME_TAG_ARRAYELEMENT, QNAME_TAG_CONTEXT, QNAME_TAG_DS_BINDING, QNAME_TAG_DS_BINDING_MAP, QNAME_TAG_JOURNAL, QNAME_TAG_JOURNAL_ENTRY, QNAME_TAG_MULTI_VALUE_MAP, QNAME_TAG_MULTI_VALUE_MAP_KEY, QNAME_TAG_MULTI_VALUE_MAP_VALUE, QNAME_TAG_NOOP, QNAME_TAG_NOW, QNAME_TAG_PASSWORD, SYSTEM_PROPERTY_PREFIX, TIMESTAMP_FORMAT, VALUE_FALSE, VALUE_JOURNAL_MODE_NORMAL, VALUE_JOURNAL_MODE_RECOVER, VALUE_RECOVERY_LOG_LEVEL_HIGH, VALUE_RECOVERY_LOG_LEVEL_LOW, VALUE_RECOVERY_LOG_LEVEL_MEDIUM, VALUE_TRUE

Constructor Summary

Constructors

Constructor and Description
JournalCreator(Map<String,String> parameters, String role, ServerInterface server) Get a JournalWriter to use, based on the server parameters.

Method Summary

Methods

Modifier and Type	Method and Description
String	addDatastream(Context context, String pid, String dsID, String[] altIDs, String dsLabel, boolean versionable, String MIMEType, String formatURI, String location, String controlGroup, String dsState, String checksumType, String checksum, String logMessage) Create a journal entry, add the arguments, and invoke the method.
boolean	addRelationship(Context context, String pid, String relationship, String objURI, boolean isLiteral, String datatype)
String	compareDatastreamChecksum(Context context, String pid, String dsID, Date versionDate) Let the delegate do it.
InputStream	export(Context context, String pid, String format, String exportContext, String encoding) Let the delegate do it.
Datastream	getDatastream(Context context, String pid, String datastreamID, Date asOfDateTime) Let the delegate do it.
Datastream[]	getDatastreamHistory(Context context, String pid, String datastreamID) Let the delegate do it.
Datastream[]	getDatastreams(Context context, String pid, Date asOfDateTime, String dsState) Let the delegate do it.
String[]	getNextPID(Context context, int numPIDs, String namespace) Create a journal entry, add the arguments, and invoke the method.
InputStream	getObjectXML(Context context, String pid, String encoding) Let the delegate do it.
RelationshipTuple[]	getRelationships(Context context, String pid, String relationship) Let the delegate do it.
InputStream	getTempStream(String id) Let the delegate do it.
String	ingest(Context context, InputStream serialization, String logMessage, String format, String encoding, String pid) Let the delegate do it, and then write a journal entry.
Date	modifyDatastreamByReference(Context context, String pid, String datastreamID, String[] altIDs, String dsLabel, String mimeType, String formatURI, String dsLocation, String checksumType, String checksum, String logMessage, Date lastModifiedDate) Create a journal entry, add the arguments, and invoke the method.
Date	modifyDatastreamByValue(Context context, String pid, String datastreamID, String[] altIDs, String dsLabel, String mimeType, String formatURI, InputStream dsContent, String checksumType, String checksum, String logMessage, Date lastModifiedDate) Create a journal entry, add the arguments, and invoke the method.
Date	modifyObject(Context context, String pid, String state, String label, String ownerId, String logMessage, Date lastModifiedDate) Create a journal entry, add the arguments, and invoke the method.
Date[]	purgeDatastream(Context context, String pid, String datastreamID, Date startDT, Date endDT, String logMessage) Create a journal entry, add the arguments, and invoke the method.
Date	purgeObject(Context context, String pid, String logMessage) Create a journal entry, add the arguments, and invoke the method.
boolean	purgeRelationship(Context context, String pid, String relationship, String object, boolean isLiteral, String datatype)
String	putTempStream(Context context, InputStream in) Create a journal entry, add the arguments, and invoke the method.
Date	setDatastreamState(Context context, String pid, String dsID, String dsState, String logMessage) Create a journal entry, add the arguments, and invoke the method.
Date	setDatastreamVersionable(Context context, String pid, String dsID, boolean versionable, String logMessage) Create a journal entry, add the arguments, and invoke the method.
void	setManagementDelegate(ManagementDelegate delegate) Receive a ManagementDelegate module to perform the Management operations.
void	shutdown() Server is shutting down, so tell the JournalWriter to shut down.
Validation	validate(Context context, String pid, Date asOfDateTime) Let the delegate do it.

Methods inherited from class java.lang.Object

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

Constructor Detail

JournalCreator

public JournalCreator(Map<String,String> parameters,
              String role,
              ServerInterface server)
               throws ModuleInitializationException

Get a JournalWriter to use, based on the server parameters.

Throws:

ModuleInitializationException

Method Detail

setManagementDelegate

public void setManagementDelegate(ManagementDelegate delegate)

Receive a ManagementDelegate module to perform the Management operations.

Specified by:

setManagementDelegate in interface JournalWorker

shutdown

public void shutdown()
              throws ModuleShutdownException

Server is shutting down, so tell the JournalWriter to shut down.

Specified by:

shutdown in interface JournalWorker

Throws:

ModuleShutdownException

ingest

public String ingest(Context context,
            InputStream serialization,
            String logMessage,
            String format,
            String encoding,
            String pid)
              throws ServerException

Let the delegate do it, and then write a journal entry.

Specified by:

ingest in interface Management

Throws:

ServerException

modifyObject

public Date modifyObject(Context context,
                String pid,
                String state,
                String label,
                String ownerId,
                String logMessage,
                Date lastModifiedDate)
                  throws ServerException

Create a journal entry, add the arguments, and invoke the method.

Specified by:

modifyObject in interface Management

Throws:

ServerException

purgeObject

public Date purgeObject(Context context,
               String pid,
               String logMessage)
                 throws ServerException

Create a journal entry, add the arguments, and invoke the method.

Specified by:

purgeObject in interface Management

Throws:

ServerException

addDatastream

public String addDatastream(Context context,
                   String pid,
                   String dsID,
                   String[] altIDs,
                   String dsLabel,
                   boolean versionable,
                   String MIMEType,
                   String formatURI,
                   String location,
                   String controlGroup,
                   String dsState,
                   String checksumType,
                   String checksum,
                   String logMessage)
                     throws ServerException

Create a journal entry, add the arguments, and invoke the method.

Specified by:

addDatastream in interface Management

Throws:

ServerException

modifyDatastreamByValue

public Date modifyDatastreamByValue(Context context,
                           String pid,
                           String datastreamID,
                           String[] altIDs,
                           String dsLabel,
                           String mimeType,
                           String formatURI,
                           InputStream dsContent,
                           String checksumType,
                           String checksum,
                           String logMessage,
                           Date lastModifiedDate)
                             throws ServerException

Create a journal entry, add the arguments, and invoke the method.

Specified by:

modifyDatastreamByValue in interface Management

Throws:

ServerException

modifyDatastreamByReference

public Date modifyDatastreamByReference(Context context,
                               String pid,
                               String datastreamID,
                               String[] altIDs,
                               String dsLabel,
                               String mimeType,
                               String formatURI,
                               String dsLocation,
                               String checksumType,
                               String checksum,
                               String logMessage,
                               Date lastModifiedDate)
                                 throws ServerException

Create a journal entry, add the arguments, and invoke the method.

Specified by:

modifyDatastreamByReference in interface Management

Throws:

ServerException

setDatastreamState

public Date setDatastreamState(Context context,
                      String pid,
                      String dsID,
                      String dsState,
                      String logMessage)
                        throws ServerException

Create a journal entry, add the arguments, and invoke the method.

Specified by:

setDatastreamState in interface Management

Throws:

ServerException

setDatastreamVersionable

public Date setDatastreamVersionable(Context context,
                            String pid,
                            String dsID,
                            boolean versionable,
                            String logMessage)
                              throws ServerException

Create a journal entry, add the arguments, and invoke the method.

Specified by:

setDatastreamVersionable in interface Management

Throws:

ServerException

purgeDatastream

public Date[] purgeDatastream(Context context,
                     String pid,
                     String datastreamID,
                     Date startDT,
                     Date endDT,
                     String logMessage)
                       throws ServerException

Create a journal entry, add the arguments, and invoke the method.

Specified by:

purgeDatastream in interface Management

Throws:

ServerException

putTempStream

public String putTempStream(Context context,
                   InputStream in)
                     throws ServerException

Create a journal entry, add the arguments, and invoke the method.

Specified by:

putTempStream in interface Management

Throws:

ServerException

getNextPID

public String[] getNextPID(Context context,
                  int numPIDs,
                  String namespace)
                    throws ServerException

Create a journal entry, add the arguments, and invoke the method.

Specified by:

getNextPID in interface Management

Throws:

ServerException

addRelationship

public boolean addRelationship(Context context,
                      String pid,
                      String relationship,
                      String objURI,
                      boolean isLiteral,
                      String datatype)
                        throws ServerException

Specified by:

addRelationship in interface Management

Throws:

ServerException

purgeRelationship

public boolean purgeRelationship(Context context,
                        String pid,
                        String relationship,
                        String object,
                        boolean isLiteral,
                        String datatype)
                          throws ServerException

Specified by:

purgeRelationship in interface Management

Throws:

ServerException

compareDatastreamChecksum

public String compareDatastreamChecksum(Context context,
                               String pid,
                               String dsID,
                               Date versionDate)
                                 throws ServerException

Let the delegate do it.

Specified by:

compareDatastreamChecksum in interface Management

Throws:

ServerException

getRelationships

public RelationshipTuple[] getRelationships(Context context,
                                   String pid,
                                   String relationship)
                                     throws ServerException

Let the delegate do it.

Specified by:

getRelationships in interface Management

Throws:

ServerException

getObjectXML

public InputStream getObjectXML(Context context,
                       String pid,
                       String encoding)
                         throws ServerException

Let the delegate do it.

Specified by:

getObjectXML in interface Management

Throws:

ServerException

export

public InputStream export(Context context,
                 String pid,
                 String format,
                 String exportContext,
                 String encoding)
                   throws ServerException

Let the delegate do it.

Specified by:

export in interface Management

Throws:

ServerException

getDatastream

public Datastream getDatastream(Context context,
                       String pid,
                       String datastreamID,
                       Date asOfDateTime)
                         throws ServerException

Let the delegate do it.

Specified by:

getDatastream in interface Management

Throws:

ServerException

getDatastreams

public Datastream[] getDatastreams(Context context,
                          String pid,
                          Date asOfDateTime,
                          String dsState)
                            throws ServerException

Let the delegate do it.

Specified by:

getDatastreams in interface Management

Throws:

ServerException

getDatastreamHistory

public Datastream[] getDatastreamHistory(Context context,
                                String pid,
                                String datastreamID)
                                  throws ServerException

Let the delegate do it.

Specified by:

getDatastreamHistory in interface Management

Throws:

ServerException

getTempStream

public InputStream getTempStream(String id)
                          throws ServerException

Let the delegate do it.

Specified by:

getTempStream in interface Management

Throws:

ServerException

validate

public Validation validate(Context context,
                  String pid,
                  Date asOfDateTime)
                    throws ServerException

Let the delegate do it.

Specified by:

validate in interface Management

Throws:

ServerException