fedora.server.journal.entry
Class JournalEntry

java.lang.Object
  fedora.server.journal.entry.JournalEntry

Direct Known Subclasses:

ConsumerJournalEntry, CreatorJournalEntry

public abstract class JournalEntry
extends java.lang.Object

Title: JournalEntry.java

Description: An abstract base class for the JournalEntry classes. At this level, a JournalEntry is a method name, a method adapter, and a map of arguments.

NOTE: when finished with the JournalEntry, call close(). This will release any temporary files associated with the entry.

Version:

$Id: JournalEntry.java 5507 2007-01-17 04:57:30 +0000 (Wed, 17 Jan 2007) cwilper $

Author:

jblake@cs.cornell.edu

Constructor Summary

protected

JournalEntry(java.lang.String methodName, JournalEntryContext context)

Method Summary

void	addArgument(java.lang.String key, boolean value)
void	addArgument(java.lang.String key, java.io.InputStream stream) If handed an InputStream as an argument, copy it to a temp file and store that File in the arguments map instead.
void	addArgument(java.lang.String key, int value)
void	addArgument(java.lang.String key, java.lang.Object value)
void	close() This should be called when usage of the object is complete, to clean up any temporary files that were created for the journal entry to use.
java.util.Map<java.lang.String,java.lang.Object>	getArgumentsMap()
boolean	getBooleanArgument(java.lang.String name)
JournalEntryContext	getContext()
java.util.Date	getDateArgument(java.lang.String name)
DSBindingMap	getDSBindingMapArgument(java.lang.String name)
int	getIntegerArgument(java.lang.String name)
ManagementMethod	getMethod()
java.lang.String	getMethodName()
java.io.InputStream	getStreamArgument(java.lang.String name) If they ask for an InputStream argument, get the File from the arguments map and create an InputStream on that file.
java.lang.String	getStringArgument(java.lang.String name)
java.lang.String[]	getStringArrayArgument(java.lang.String name)
void	setRecoveryValue(java.lang.String attribute, java.lang.String value)
void	setRecoveryValues(java.lang.String attribute, java.lang.String[] values)

Methods inherited from class java.lang.Object

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

Constructor Detail

JournalEntry

protected JournalEntry(java.lang.String methodName,
                       JournalEntryContext context)

Method Detail

getContext

public JournalEntryContext getContext()

getMethod

public ManagementMethod getMethod()

getMethodName

public java.lang.String getMethodName()

getArgumentsMap

public java.util.Map<java.lang.String,java.lang.Object> getArgumentsMap()

addArgument

public void addArgument(java.lang.String key,
                        boolean value)

addArgument

public void addArgument(java.lang.String key,
                        int value)

addArgument

public void addArgument(java.lang.String key,
                        java.lang.Object value)

addArgument

public void addArgument(java.lang.String key,
                        java.io.InputStream stream)
                 throws JournalException

If handed an InputStream as an argument, copy it to a temp file and store that File in the arguments map instead. If the InputStream is null, store null in the arguments map.

Throws:

JournalException

setRecoveryValue

public void setRecoveryValue(java.lang.String attribute,
                             java.lang.String value)

setRecoveryValues

public void setRecoveryValues(java.lang.String attribute,
                              java.lang.String[] values)

getIntegerArgument

public int getIntegerArgument(java.lang.String name)

getBooleanArgument

public boolean getBooleanArgument(java.lang.String name)

getStringArgument

public java.lang.String getStringArgument(java.lang.String name)

getDateArgument

public java.util.Date getDateArgument(java.lang.String name)

getStringArrayArgument

public java.lang.String[] getStringArrayArgument(java.lang.String name)

getStreamArgument

public java.io.InputStream getStreamArgument(java.lang.String name)
                                      throws JournalException

If they ask for an InputStream argument, get the File from the arguments map and create an InputStream on that file. If the value from the map is null, return null.

Throws:

JournalException

getDSBindingMapArgument

public DSBindingMap getDSBindingMapArgument(java.lang.String name)

close

public void close()

This should be called when usage of the object is complete, to clean up any temporary files that were created for the journal entry to use.