fedora.server.journal
Class Journaller

java.lang.Object
  fedora.server.Parameterized
      fedora.server.Pluggable
          fedora.server.Module
              fedora.server.journal.Journaller

All Implemented Interfaces:

Constants, JournalConstants, Management

public class Journaller
extends Module
implements Management, JournalConstants

Title: Journaller.java

Description: A Management module that decorates a ManagementDelegate module with code that either creates a Journal or consumes a Journal, depending on the startup parameters.

Version:

$Id: Journaller.java 5367 2006-12-08 08:51:00 +0000 (Fri, 08 Dec 2006) cwilper $

Author:

jblake@cs.cornell.edu

Nested Class Summary

Nested classes/interfaces inherited from interface fedora.common.Constants

Constants.FedoraHome

Field Summary

Fields inherited from interface fedora.server.journal.JournalConstants

ARGUMENT_NAME_ALT_IDS, ARGUMENT_NAME_BDEF_PID, ARGUMENT_NAME_BINDING_MAP, ARGUMENT_NAME_BMECH_PID, ARGUMENT_NAME_CHECKSUM, ARGUMENT_NAME_CHECKSUM_TYPE, ARGUMENT_NAME_CONTEXT, ARGUMENT_NAME_CONTROL_GROUP, 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_LABEL, ARGUMENT_NAME_LOCATION, ARGUMENT_NAME_LOG_MESSAGE, ARGUMENT_NAME_MIME_TYPE, ARGUMENT_NAME_NAMESPACE, ARGUMENT_NAME_NEW_PID, ARGUMENT_NAME_NUM_PIDS, ARGUMENT_NAME_OWNERID, ARGUMENT_NAME_PID, 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_GET_NEXT_PID, METHOD_INGEST_OBJECT, 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_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

Fields inherited from interface fedora.common.Constants

ACTION, BDEF, BMECH, DATASTREAM, DC, DISSEMINATOR, ENVIRONMENT, FEDORA, FEDORA_HOME, FEDORA_SYSTEM_DEF_PID, FEDORA_SYSTEM_DEF_URI, HTTP_REQUEST, MODEL, OBJECT, RDF, RECOVERY, RELS_EXT, RESOURCE, SUBJECT, TUCANA, VIEW, XSD

Constructor Summary

Journaller(java.util.Map<java.lang.String,java.lang.String> moduleParameters, Server server, java.lang.String role)

Method Summary

java.lang.String	addDatastream(Context context, java.lang.String pid, java.lang.String dsID, java.lang.String[] altIDs, java.lang.String dsLabel, boolean versionable, java.lang.String MIMEType, java.lang.String formatURI, java.lang.String location, java.lang.String controlGroup, java.lang.String dsState, java.lang.String checksumType, java.lang.String checksum, java.lang.String logMessage) Delegate to the JournalWorker.
java.lang.String	addDisseminator(Context context, java.lang.String pid, java.lang.String bDefPID, java.lang.String bMechPid, java.lang.String dissLabel, DSBindingMap bindingMap, java.lang.String dissState, java.lang.String logMessage) Delegate to the JournalWorker.
boolean	adminPing(Context context) Delegate to the JournalWorker.
java.lang.String	compareDatastreamChecksum(Context context, java.lang.String pid, java.lang.String dsID, java.util.Date versionDate) Delegate to the JournalWorker.
java.io.InputStream	exportObject(Context context, java.lang.String pid, java.lang.String format, java.lang.String exportContext, java.lang.String encoding) Delegate to the JournalWorker.
Datastream	getDatastream(Context context, java.lang.String pid, java.lang.String datastreamID, java.util.Date asOfDateTime) Delegate to the JournalWorker.
Datastream[]	getDatastreamHistory(Context context, java.lang.String pid, java.lang.String datastreamID) Delegate to the JournalWorker.
Datastream[]	getDatastreams(Context context, java.lang.String pid, java.util.Date asOfDateTime, java.lang.String dsState) Delegate to the JournalWorker.
Disseminator	getDisseminator(Context context, java.lang.String pid, java.lang.String disseminatorID, java.util.Date asOfDateTime) Delegate to the JournalWorker.
Disseminator[]	getDisseminatorHistory(Context context, java.lang.String pid, java.lang.String disseminatorID) Delegate to the JournalWorker.
Disseminator[]	getDisseminators(Context context, java.lang.String pid, java.util.Date asOfDateTime, java.lang.String dissState) Delegate to the JournalWorker.
java.lang.String[]	getNextPID(Context context, int numPIDs, java.lang.String namespace) Delegate to the JournalWorker.
Property[]	getObjectProperties(Context context, java.lang.String pid) Delegate to the JournalWorker.
java.io.InputStream	getObjectXML(Context context, java.lang.String pid, java.lang.String encoding) Delegate to the JournalWorker.
java.io.InputStream	getTempStream(java.lang.String id) Delegate to the JournalWorker.
java.lang.String	ingestObject(Context context, java.io.InputStream serialization, java.lang.String logMessage, java.lang.String format, java.lang.String encoding, boolean newPid) Delegate to the JournalWorker.
void	initModule() Augment the parameters with values obtained from System Properties, and create the proper worker (JournalCreator or JournalConsumer) for the current mode.
java.util.Date	modifyDatastreamByReference(Context context, java.lang.String pid, java.lang.String datastreamID, java.lang.String[] altIDs, java.lang.String dsLabel, java.lang.String mimeType, java.lang.String formatURI, java.lang.String dsLocation, java.lang.String checksumType, java.lang.String checksum, java.lang.String logMessage, boolean force) Delegate to the JournalWorker.
java.util.Date	modifyDatastreamByValue(Context context, java.lang.String pid, java.lang.String datastreamID, java.lang.String[] altIDs, java.lang.String dsLabel, java.lang.String mimeType, java.lang.String formatURI, java.io.InputStream dsContent, java.lang.String checksumType, java.lang.String checksum, java.lang.String logMessage, boolean force) Delegate to the JournalWorker.
java.util.Date	modifyDisseminator(Context context, java.lang.String pid, java.lang.String disseminatorID, java.lang.String bMechPid, java.lang.String dissLabel, DSBindingMap bindingMap, java.lang.String dissState, java.lang.String logMessage, boolean force) Delegate to the JournalWorker.
java.util.Date	modifyObject(Context context, java.lang.String pid, java.lang.String state, java.lang.String label, java.lang.String ownerId, java.lang.String logMessage) Delegate to the JournalWorker.
void	postInitModule() Get the ManagementDelegate module and pass it to the worker.
java.util.Date[]	purgeDatastream(Context context, java.lang.String pid, java.lang.String datastreamID, java.util.Date startDT, java.util.Date endDT, java.lang.String logMessage, boolean force) Delegate to the JournalWorker.
java.util.Date[]	purgeDisseminator(Context context, java.lang.String pid, java.lang.String disseminatorID, java.util.Date endDT, java.lang.String logMessage) Delegate to the JournalWorker.
java.util.Date	purgeObject(Context context, java.lang.String pid, java.lang.String logMessage, boolean force) Delegate to the JournalWorker.
java.lang.String	putTempStream(Context context, java.io.InputStream in) Delegate to the JournalWorker.
java.util.Date	setDatastreamState(Context context, java.lang.String pid, java.lang.String dsID, java.lang.String dsState, java.lang.String logMessage) Delegate to the JournalWorker.
java.util.Date	setDatastreamVersionable(Context context, java.lang.String pid, java.lang.String dsID, boolean versionable, java.lang.String logMessage) Delegate to the JournalWorker.
java.util.Date	setDisseminatorState(Context context, java.lang.String pid, java.lang.String dsID, java.lang.String dsState, java.lang.String logMessage) Delegate to the JournalWorker.
void	shutdownModule() Tell the worker to shut down.

Methods inherited from class fedora.server.Module

getRole, getServer

Methods inherited from class fedora.server.Pluggable

getHelp, getOptionalParameters, getParameterHelp, getRequiredModuleRoles, getRequiredParameters

Methods inherited from class fedora.server.Parameterized

getParameter, getParameter, getParameters, parameterNames, setParameter, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

Journaller

public Journaller(java.util.Map<java.lang.String,java.lang.String> moduleParameters,
                  Server server,
                  java.lang.String role)
           throws ModuleInitializationException

Throws:

ModuleInitializationException

Method Detail

initModule

public void initModule()
                throws ModuleInitializationException

Augment the parameters with values obtained from System Properties, and create the proper worker (JournalCreator or JournalConsumer) for the current mode.

Overrides:

initModule in class Module

Throws:

ModuleInitializationException - If initialization values are invalid or initialization fails for some other reason.

postInitModule

public void postInitModule()
                    throws ModuleInitializationException

Get the ManagementDelegate module and pass it to the worker.

Overrides:

postInitModule in class Module

Throws:

ModuleInitializationException - If initialization values are invalid or initialization fails for some other reason.

shutdownModule

public void shutdownModule()
                    throws ModuleShutdownException

Tell the worker to shut down.

Overrides:

shutdownModule in class Module

Throws:

ModuleShutdownException - If there is a problem freeing system resources. Note that if there is a problem, it won't end up aborting the shutdown process. Therefore, this method should do everything possible to recover from exceptional situations before throwing an exception.

ingestObject

public java.lang.String ingestObject(Context context,
                                     java.io.InputStream serialization,
                                     java.lang.String logMessage,
                                     java.lang.String format,
                                     java.lang.String encoding,
                                     boolean newPid)
                              throws ServerException

Delegate to the JournalWorker.

Specified by:

ingestObject in interface Management

Throws:

ServerException

modifyObject

public java.util.Date modifyObject(Context context,
                                   java.lang.String pid,
                                   java.lang.String state,
                                   java.lang.String label,
                                   java.lang.String ownerId,
                                   java.lang.String logMessage)
                            throws ServerException

Delegate to the JournalWorker.

Specified by:

modifyObject in interface Management

Throws:

ServerException

getObjectProperties

public Property[] getObjectProperties(Context context,
                                      java.lang.String pid)
                               throws ServerException

Delegate to the JournalWorker.

Specified by:

getObjectProperties in interface Management

Throws:

ServerException

getObjectXML

public java.io.InputStream getObjectXML(Context context,
                                        java.lang.String pid,
                                        java.lang.String encoding)
                                 throws ServerException

Delegate to the JournalWorker.

Specified by:

getObjectXML in interface Management

Throws:

ServerException

exportObject

public java.io.InputStream exportObject(Context context,
                                        java.lang.String pid,
                                        java.lang.String format,
                                        java.lang.String exportContext,
                                        java.lang.String encoding)
                                 throws ServerException

Delegate to the JournalWorker.

Specified by:

exportObject in interface Management

Throws:

ServerException

purgeObject

public java.util.Date purgeObject(Context context,
                                  java.lang.String pid,
                                  java.lang.String logMessage,
                                  boolean force)
                           throws ServerException

Delegate to the JournalWorker.

Specified by:

purgeObject in interface Management

Throws:

ServerException

addDatastream

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

Delegate to the JournalWorker.

Specified by:

addDatastream in interface Management

Throws:

ServerException

modifyDatastreamByReference

public java.util.Date modifyDatastreamByReference(Context context,
                                                  java.lang.String pid,
                                                  java.lang.String datastreamID,
                                                  java.lang.String[] altIDs,
                                                  java.lang.String dsLabel,
                                                  java.lang.String mimeType,
                                                  java.lang.String formatURI,
                                                  java.lang.String dsLocation,
                                                  java.lang.String checksumType,
                                                  java.lang.String checksum,
                                                  java.lang.String logMessage,
                                                  boolean force)
                                           throws ServerException

Delegate to the JournalWorker.

Specified by:

modifyDatastreamByReference in interface Management

Throws:

ServerException

modifyDatastreamByValue

public java.util.Date modifyDatastreamByValue(Context context,
                                              java.lang.String pid,
                                              java.lang.String datastreamID,
                                              java.lang.String[] altIDs,
                                              java.lang.String dsLabel,
                                              java.lang.String mimeType,
                                              java.lang.String formatURI,
                                              java.io.InputStream dsContent,
                                              java.lang.String checksumType,
                                              java.lang.String checksum,
                                              java.lang.String logMessage,
                                              boolean force)
                                       throws ServerException

Delegate to the JournalWorker.

Specified by:

modifyDatastreamByValue in interface Management

Throws:

ServerException

purgeDatastream

public java.util.Date[] purgeDatastream(Context context,
                                        java.lang.String pid,
                                        java.lang.String datastreamID,
                                        java.util.Date startDT,
                                        java.util.Date endDT,
                                        java.lang.String logMessage,
                                        boolean force)
                                 throws ServerException

Delegate to the JournalWorker.

Specified by:

purgeDatastream in interface Management

Throws:

ServerException

getDatastream

public Datastream getDatastream(Context context,
                                java.lang.String pid,
                                java.lang.String datastreamID,
                                java.util.Date asOfDateTime)
                         throws ServerException

Delegate to the JournalWorker.

Specified by:

getDatastream in interface Management

Throws:

ServerException

getDatastreams

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

Delegate to the JournalWorker.

Specified by:

getDatastreams in interface Management

Throws:

ServerException

getDatastreamHistory

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

Delegate to the JournalWorker.

Specified by:

getDatastreamHistory in interface Management

Throws:

ServerException

addDisseminator

public java.lang.String addDisseminator(Context context,
                                        java.lang.String pid,
                                        java.lang.String bDefPID,
                                        java.lang.String bMechPid,
                                        java.lang.String dissLabel,
                                        DSBindingMap bindingMap,
                                        java.lang.String dissState,
                                        java.lang.String logMessage)
                                 throws ServerException

Delegate to the JournalWorker.

Specified by:

addDisseminator in interface Management

Throws:

ServerException

modifyDisseminator

public java.util.Date modifyDisseminator(Context context,
                                         java.lang.String pid,
                                         java.lang.String disseminatorID,
                                         java.lang.String bMechPid,
                                         java.lang.String dissLabel,
                                         DSBindingMap bindingMap,
                                         java.lang.String dissState,
                                         java.lang.String logMessage,
                                         boolean force)
                                  throws ServerException

Delegate to the JournalWorker.

Specified by:

modifyDisseminator in interface Management

Throws:

ServerException

purgeDisseminator

public java.util.Date[] purgeDisseminator(Context context,
                                          java.lang.String pid,
                                          java.lang.String disseminatorID,
                                          java.util.Date endDT,
                                          java.lang.String logMessage)
                                   throws ServerException

Delegate to the JournalWorker.

Specified by:

purgeDisseminator in interface Management

Throws:

ServerException

getDisseminator

public Disseminator getDisseminator(Context context,
                                    java.lang.String pid,
                                    java.lang.String disseminatorID,
                                    java.util.Date asOfDateTime)
                             throws ServerException

Delegate to the JournalWorker.

Specified by:

getDisseminator in interface Management

Throws:

ServerException

getDisseminators

public Disseminator[] getDisseminators(Context context,
                                       java.lang.String pid,
                                       java.util.Date asOfDateTime,
                                       java.lang.String dissState)
                                throws ServerException

Delegate to the JournalWorker.

Specified by:

getDisseminators in interface Management

Throws:

ServerException

getDisseminatorHistory

public Disseminator[] getDisseminatorHistory(Context context,
                                             java.lang.String pid,
                                             java.lang.String disseminatorID)
                                      throws ServerException

Delegate to the JournalWorker.

Specified by:

getDisseminatorHistory in interface Management

Throws:

ServerException

putTempStream

public java.lang.String putTempStream(Context context,
                                      java.io.InputStream in)
                               throws ServerException

Delegate to the JournalWorker.

Specified by:

putTempStream in interface Management

Throws:

ServerException

getTempStream

public java.io.InputStream getTempStream(java.lang.String id)
                                  throws ServerException

Delegate to the JournalWorker.

Specified by:

getTempStream in interface Management

Throws:

ServerException

setDatastreamState

public java.util.Date setDatastreamState(Context context,
                                         java.lang.String pid,
                                         java.lang.String dsID,
                                         java.lang.String dsState,
                                         java.lang.String logMessage)
                                  throws ServerException

Delegate to the JournalWorker.

Specified by:

setDatastreamState in interface Management

Throws:

ServerException

setDatastreamVersionable

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

Delegate to the JournalWorker.

Specified by:

setDatastreamVersionable in interface Management

Throws:

ServerException

compareDatastreamChecksum

public java.lang.String compareDatastreamChecksum(Context context,
                                                  java.lang.String pid,
                                                  java.lang.String dsID,
                                                  java.util.Date versionDate)
                                           throws ServerException

Delegate to the JournalWorker.

Specified by:

compareDatastreamChecksum in interface Management

Throws:

ServerException

setDisseminatorState

public java.util.Date setDisseminatorState(Context context,
                                           java.lang.String pid,
                                           java.lang.String dsID,
                                           java.lang.String dsState,
                                           java.lang.String logMessage)
                                    throws ServerException

Delegate to the JournalWorker.

Specified by:

setDisseminatorState in interface Management

Throws:

ServerException

getNextPID

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

Delegate to the JournalWorker.

Specified by:

getNextPID in interface Management

Throws:

ServerException

adminPing

public boolean adminPing(Context context)
                  throws ServerException

Delegate to the JournalWorker.

Specified by:

adminPing in interface Management

Throws:

ServerException