arlut.csd.ganymede.server

Interface DBLogController

All Known Implementing Classes:

DBLogFileController, DBLogPostGreSQLController

public interface DBLogController

This controller interface manages the recording and retrieval of DBLogEvents for the DBLog class.

Author:

Jonathan Abbey, jonabbey@arlut.utexas.edu, ARL:UT

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This method shuts down this controller, freeing up any resources used by this controller.
void	flushAndSync() This method flushes the log and syncs it to disk.
java.lang.StringBuffer	retrieveHistory(Invid invid, java.util.Date sinceTime, java.util.Date beforeTime, boolean keyOnAdmin, boolean fullTransactions, boolean getLoginEvents) This method is used to scan the persistent log storage for log events that match invid and that have occurred since sinceTime.
void	writeEvent(DBLogEvent event) This method writes the given event to the persistent storage managed by this controller.

Method Detail

writeEvent

void writeEvent(DBLogEvent event)

This method writes the given event to the persistent storage managed by this controller.

Parameters:

event - The DBLogEvent to be recorded

retrieveHistory

java.lang.StringBuffer retrieveHistory(Invid invid,
                                     java.util.Date sinceTime,
                                     java.util.Date beforeTime,
                                     boolean keyOnAdmin,
                                     boolean fullTransactions,
                                     boolean getLoginEvents)

This method is used to scan the persistent log storage for log events that match invid and that have occurred since sinceTime.

Parameters:

invid - If not null, retrieveHistory() will only return events involving this object invid.

sinceTime - if not null, retrieveHistory() will only return events occuring on or after the time specified in this Date object.

beforeTime - if not null, retrieveHistory() will only return events occuring on or before the time specified in this Date object.

keyOnAdmin - if true, rather than returning a string containing events that involved <invid>, retrieveHistory() will return a string containing events performed on behalf of the administrator with invid <invid>.

fullTransactions - if true, the buffer returned will include all events in any transactions that involve the given invid. if false, only those events in a transaction directly affecting the given invid will be returned.

getLoginEvents - if true, this method will return only login and logout events. if false, this method will return no login and logout events.

Returns:

A human-readable multiline string containing a list of history events

flushAndSync

void flushAndSync()

This method flushes the log and syncs it to disk. May be no-op for some controllers.

close

void close()

This method shuts down this controller, freeing up any resources used by this controller.