Alphabetical Index

A B C D E F G I K L M O P R S T U W X

A

activeTxDisplay() - method in class org.objectweb.howl.log.xa.XALogger
displays entries in the activeTx table.

B

BlockLogBuffer - class org.objectweb.howl.log.BlockLogBuffer
An implementation of LogBuffer that provides features necessary for a reliable Transaction Monitor journal.
BlockLogBufferSink - class org.objectweb.howl.log.BlockLogBufferSink
An implementation of BlockLogBuffer that does *not* perform IO.
bufferInfo() - method in class org.objectweb.howl.log.BlockLogBuffer
generate a String that represents the state of this LogBuffer object

C

capacity() - method in class org.objectweb.howl.log.LogRecord
CLOSE - static field in class org.objectweb.howl.log.LogRecordType
recorded by Logger to signal a clean close on the log.
close() - method in class org.objectweb.howl.log.Logger
close the Log files and perform necessary cleanup tasks.
close() - method in class org.objectweb.howl.log.xa.XALogger
COMPLETE - static field in class org.objectweb.howl.log.LogBufferStatus
IO Status of LogBuffer when force is complete.
Configuration - class org.objectweb.howl.log.Configuration
Provides configuration information for a Logger instance.
Configuration() - constructor for class org.objectweb.howl.log.Configuration
Construct a Configuration object with default values.
Configuration(File) - constructor for class org.objectweb.howl.log.Configuration
Construct a Configuration object using a Properties file specified by the caller.
Configuration(Properties) - constructor for class org.objectweb.howl.log.Configuration
Construct a Configuration object using a Properties object supplied by the caller.
ConfigurationMBean - interface org.objectweb.howl.log.ConfigurationMBean
CTRL - static field in class org.objectweb.howl.log.LogRecordType
Log records generated by Logger.

D

data - field in class org.objectweb.howl.log.LogRecord
byte[] containing unparsed record data.
dataBuffer - field in class org.objectweb.howl.log.LogRecord
ByteBuffer wrapper for the data byte[].

E

END_OF_LOG - static field in class org.objectweb.howl.log.LogRecordType
Type indicating that end of log has been reached.
EOB - static field in class org.objectweb.howl.log.LogRecordType
Type returned by get() methods to signal end of buffer.
ERROR - static field in class org.objectweb.howl.log.LogBufferStatus
IO Status of LogBuffer if an IOException occurs during the force.

F

FILE_HEADER - static field in class org.objectweb.howl.log.LogRecordType
Header records generated at start of every log file.
FILLING - static field in class org.objectweb.howl.log.LogBufferStatus
IO Status of LogBuffer while it is being filled with new records.

G

get(LogRecord,long) - method in class org.objectweb.howl.log.Logger
Read a specific record from the log.
getActiveMark() - method in class org.objectweb.howl.log.Logger
getActiveTxUsed() - method in class org.objectweb.howl.log.xa.XALogger
Used by TM and test cases to obtain the number of entries in the activeTx table.
getBufferClassName() - method in class org.objectweb.howl.log.Configuration
getBufferClassName() - method in class org.objectweb.howl.log.ConfigurationMBean
getBufferSize() - method in class org.objectweb.howl.log.Configuration
Returns the size of buffers specified as a number of 1K blocks.
getBufferSize() - method in class org.objectweb.howl.log.ConfigurationMBean
getFields() - method in class org.objectweb.howl.log.LogRecord
Parse record data into a byte[][] that is equivalent to the one passed to Logger.put(byte[][]).
getFlushSleepTime() - method in class org.objectweb.howl.log.Configuration
getFlushSleepTime() - method in class org.objectweb.howl.log.ConfigurationMBean
getLogFileDir() - method in class org.objectweb.howl.log.Configuration
getLogFileDir() - method in class org.objectweb.howl.log.ConfigurationMBean
getLogFileExt() - method in class org.objectweb.howl.log.Configuration
getLogFileExt() - method in class org.objectweb.howl.log.ConfigurationMBean
getLogFileMode() - method in class org.objectweb.howl.log.Configuration
getLogFileMode() - method in class org.objectweb.howl.log.ConfigurationMBean
getLogFileName() - method in class org.objectweb.howl.log.Configuration
getLogFileName() - method in class org.objectweb.howl.log.ConfigurationMBean
getLogKey() - method in class org.objectweb.howl.log.xa.XACommittingTx
getLogRecord() - method in class org.objectweb.howl.log.ReplayListener
Called by Logger when ReplayListener is registered for replay.
getMaxBlocksPerFile() - method in class org.objectweb.howl.log.Configuration
getMaxBlocksPerFile() - method in class org.objectweb.howl.log.ConfigurationMBean
getMaxBuffers() - method in class org.objectweb.howl.log.Configuration
getMaxBuffers() - method in class org.objectweb.howl.log.ConfigurationMBean
getMaxLogFiles() - method in class org.objectweb.howl.log.Configuration
getMaxLogFiles() - method in class org.objectweb.howl.log.ConfigurationMBean
getMinBuffers() - method in class org.objectweb.howl.log.Configuration
getMinBuffers() - method in class org.objectweb.howl.log.ConfigurationMBean
getNext(LogRecord) - method in class org.objectweb.howl.log.Logger
Read the journal record that follows the record identified by lr.
getRecord() - method in class org.objectweb.howl.log.xa.XACommittingTx
returns the byte[][] containing the COMMIT record data.
getStats() - method in class org.objectweb.howl.log.Logger
return an XML node containing statistics for the Logger, the LogFile pool and the LogBuffer pool.
getStats() - method in class org.objectweb.howl.log.xa.XALogger
return an XML node containing statistics for this object along with the base Logger, the LogFile pool and the LogBuffer pool.
getThreadsWaitingForceThreshold() - method in class org.objectweb.howl.log.Configuration
getThreadsWaitingForceThreshold() - method in class org.objectweb.howl.log.ConfigurationMBean
getTx() - method in class org.objectweb.howl.log.xa.XALogRecord
getWaitForBuffer() - method in class org.objectweb.howl.log.LogBufferManager
provides synchronized access to waitForBuffer

I

InitLog - class org.objectweb.howl.log.util.InitLog
InvalidFileSetException - class org.objectweb.howl.log.InvalidFileSetException
Exception thrown when LogFileManager.open() detects an invalid file set.
InvalidFileSetException() - constructor for class org.objectweb.howl.log.InvalidFileSetException
InvalidFileSetException(String) - constructor for class org.objectweb.howl.log.InvalidFileSetException
InvalidFileSetException(String,Throwable) - constructor for class org.objectweb.howl.log.InvalidFileSetException
InvalidFileSetException(Throwable) - constructor for class org.objectweb.howl.log.InvalidFileSetException
Exception thrown when Logger detects a journal block with invalid content.
InvalidLogBufferException() - constructor for class org.objectweb.howl.log.InvalidLogBufferException
InvalidLogBufferException(String) - constructor for class org.objectweb.howl.log.InvalidLogBufferException
InvalidLogBufferException(String,Throwable) - constructor for class org.objectweb.howl.log.InvalidLogBufferException
InvalidLogBufferException(Throwable) - constructor for class org.objectweb.howl.log.InvalidLogBufferException
Exception thrown when XAJournalReader detects a journal block with an invalid header.
InvalidLogHeaderException() - constructor for class org.objectweb.howl.log.InvalidLogHeaderException
InvalidLogHeaderException(String) - constructor for class org.objectweb.howl.log.InvalidLogHeaderException
InvalidLogHeaderException(String,Throwable) - constructor for class org.objectweb.howl.log.InvalidLogHeaderException
InvalidLogHeaderException(Throwable) - constructor for class org.objectweb.howl.log.InvalidLogHeaderException
InvalidLogKeyException - class org.objectweb.howl.log.InvalidLogKeyException
Exception thrown when XAJournalReader detects a journal block with an invalid header.
InvalidLogKeyException() - constructor for class org.objectweb.howl.log.InvalidLogKeyException
InvalidLogKeyException(String) - constructor for class org.objectweb.howl.log.InvalidLogKeyException
InvalidLogKeyException(String,Throwable) - constructor for class org.objectweb.howl.log.InvalidLogKeyException
InvalidLogKeyException(Throwable) - constructor for class org.objectweb.howl.log.InvalidLogKeyException
isChecksumEnabled() - method in class org.objectweb.howl.log.Configuration
isChecksumEnabled() - method in class org.objectweb.howl.log.ConfigurationMBean
isCommit() - method in class org.objectweb.howl.log.xa.XALogRecord
isCTRL() - method in class org.objectweb.howl.log.LogRecord
Return true if the current record is a control record.
isDone() - method in class org.objectweb.howl.log.xa.XACommittingTx
returns done as maintained by XALogger.putCommit() and XALogger.putDone().
isEOB() - method in class org.objectweb.howl.log.LogRecord
Return true if current record is an EOB type control record.
isMoving() - method in class org.objectweb.howl.log.xa.XACommittingTx

K

key - field in class org.objectweb.howl.log.LogRecord
log key associated with this LogRecord.

L

length - field in class org.objectweb.howl.log.LogRecord
length of the data record.
LogBuffer - class org.objectweb.howl.log.LogBuffer
Classes used as buffers in LogBufferManager must implement this interface.
LogBufferManager - class org.objectweb.howl.log.LogBufferManager
Provides a generalized buffer manager for journals and loggers.
LogBufferStatus - interface org.objectweb.howl.log.LogBufferStatus
Defines valid values for LogBuffer status.
LogClosedException - class org.objectweb.howl.log.LogClosedException
Checked exception thrown when put is called after the log has been closed.
LogClosedException() - constructor for class org.objectweb.howl.log.LogClosedException
Constructs an instance of this class.
LogClosedException(String) - constructor for class org.objectweb.howl.log.LogClosedException
LogClosedException(String,Throwable) - constructor for class org.objectweb.howl.log.LogClosedException
LogClosedException(Throwable) - constructor for class org.objectweb.howl.log.LogClosedException
LogConfigurationException() - constructor for class org.objectweb.howl.log.LogConfigurationException
LogConfigurationException(String) - constructor for class org.objectweb.howl.log.LogConfigurationException
LogConfigurationException(String,Throwable) - constructor for class org.objectweb.howl.log.LogConfigurationException
LogConfigurationException(Throwable) - constructor for class org.objectweb.howl.log.LogConfigurationException
LogEventListener - interface org.objectweb.howl.log.LogEventListener
This interface is implemented by users of the Logger.
LogException - class org.objectweb.howl.log.LogException
Base exception class for HOWL exceptions.
LogException() - constructor for class org.objectweb.howl.log.LogException
LogException(String) - constructor for class org.objectweb.howl.log.LogException
LogException(String,Throwable) - constructor for class org.objectweb.howl.log.LogException
LogException(Throwable) - constructor for class org.objectweb.howl.log.LogException
LogFile - class org.objectweb.howl.log.LogFile
An individual file within a set of log files managed by a Logger.
LogFileHeader - class org.objectweb.howl.log.LogFileHeader
Defines the header record for a LogFile.
LogFileManager - class org.objectweb.howl.log.LogFileManager
Manage a set of log files.
LogFileOverflowException - class org.objectweb.howl.log.LogFileOverflowException
Checked exception thrown when the Logger attempts to switch to an alternate log file that contains the active mark.
LogFileOverflowException() - constructor for class org.objectweb.howl.log.LogFileOverflowException
Constructs an instance of this class.
LogFileOverflowException(long,long,File) - constructor for class org.objectweb.howl.log.LogFileOverflowException
Construct an exception with message describing the problem
Logger - class org.objectweb.howl.log.Logger
Manage a configured set of two or more physical log files.
Logger() - constructor for class org.objectweb.howl.log.Logger
Construct a Logger using default Configuration object.
Logger(Configuration) - constructor for class org.objectweb.howl.log.Logger
Construct a Logger using a Configuration supplied by the caller.
LoggerFactory - class org.objectweb.howl.log.LoggerFactory
Not Implemented.
LogObject - class org.objectweb.howl.log.LogObject
base class for all log objects that require configuration information.
logOverflowNotification(long) - method in class org.objectweb.howl.log.LogEventListener
Called by Logger to notify the LogEventListener that a log file overflow is approaching.
logOverflowNotification(long) - method in class org.objectweb.howl.log.xa.XALogger
called by Logger when log file is about to overflow.
LogRecord - class org.objectweb.howl.log.LogRecord
LogRecord class used by Logger.replay().
LogRecord(int) - constructor for class org.objectweb.howl.log.LogRecord
constructs an instance of LogRecord with a byte[] of size data.
LogRecordSizeException - class org.objectweb.howl.log.LogRecordSizeException
Checked exception thrown when the byte[] passed to put is larger than the configured buffer size.
LogRecordSizeException() - constructor for class org.objectweb.howl.log.LogRecordSizeException
Constructs an instance of this class.
LogRecordSizeException(int) - constructor for class org.objectweb.howl.log.LogRecordSizeException
Constructs an instance of this class with specified description.
LogRecordType - interface org.objectweb.howl.log.LogRecordType
Define record types used by Logger implementations.
LogState - class org.objectweb.howl.log.LogState
Manage state variables for the Logger instance.

M

main(String[]) - static method in class org.objectweb.howl.log.util.InitLog
mark(long) - method in class org.objectweb.howl.log.Logger
calls Logger.mark(key, force) with force set to true .
mark(long,boolean) - method in class org.objectweb.howl.log.Logger
sets the LogFile's mark.
MARKKEY - static field in class org.objectweb.howl.log.LogRecordType
Log records containing mark data.

O

onError(LogException) - method in class org.objectweb.howl.log.ReplayListener
Called by Logger when an exception is encountered during replay.
onRecord(LogRecord) - method in class org.objectweb.howl.log.ReplayListener
Called by Logger for each record retrieved from the log.
open() - method in class org.objectweb.howl.log.Logger
open Log files and perform necessart initialization.
open() - method in class org.objectweb.howl.log.xa.XALogger
Not supported for XALogger.
open(ReplayListener) - method in class org.objectweb.howl.log.xa.XALogger
calls super.open() to perform standard open functionality then replays the log to rebuild the activeTx table.

P

put(byte[],boolean) - method in class org.objectweb.howl.log.Logger
add a USER record consisting of byte[] to the log.
put(byte[],boolean) - method in class org.objectweb.howl.log.xa.XALogger
add a USER record consisting of byte[] to the log.
put(byte[][],boolean) - method in class org.objectweb.howl.log.Logger
add a USER record consisting of byte[][] to log.
put(byte[][],boolean) - method in class org.objectweb.howl.log.xa.XALogger
add a USER record consisting of byte[][] to the log.
putCommit(byte[][]) - method in class org.objectweb.howl.log.xa.XALogger
Write a begin COMMIT record to the log.
putDone(byte[][],XACommittingTx) - method in class org.objectweb.howl.log.xa.XALogger
Write a DONE record to the log.

R

replay(ReplayListener) - method in class org.objectweb.howl.log.Logger
Replays log from the active mark forward to the current position.
replay(ReplayListener) - method in class org.objectweb.howl.log.xa.XALogger
Wrapp Logger#replay(ReplayListener) so we can intercept onRecord() notifications to process XACOMMIT and XACOMMITMOVED records.
replay(ReplayListener,long) - method in class org.objectweb.howl.log.Logger
Replays log from a specified mark forward to the current mark.
replay(ReplayListener,long) - method in class org.objectweb.howl.log.xa.XALogger
Wrapp Logger#replay(ReplayListener, long) so we can intercept onRecord() notifications to process XACOMMIT and XACOMMITMOVED records.
replayActiveTx(ReplayListener) - method in class org.objectweb.howl.log.xa.XALogger
Called by the TM to receive copies of the active transaction entries.
ReplayListener - interface org.objectweb.howl.log.ReplayListener
Objects that wish to read a log must implement the ReplayListener interface.
RESTART - static field in class org.objectweb.howl.log.LogRecordType
recorded by Logger to mark first block following a restart of the Logger.

S

setAutoMark(boolean) - method in class org.objectweb.howl.log.Logger
Sets the LogFile marking mode.
setBufferClassName(String) - method in class org.objectweb.howl.log.Configuration
setBufferSize(int) - method in class org.objectweb.howl.log.Configuration
setChecksumEnabled(boolean) - method in class org.objectweb.howl.log.Configuration
setFilterCtrlRecords(boolean) - method in class org.objectweb.howl.log.LogRecord
Set the filterCtrlRecords member
setFlushSleepTime(int) - method in class org.objectweb.howl.log.Configuration
setLogEventListener(LogEventListener) - method in class org.objectweb.howl.log.Logger
Registers a LogEventListener for log event notifications.
setLogEventListener(LogEventListener) - method in class org.objectweb.howl.log.xa.XALogger
Saves a reference to callers LogEventListener.
setLogFileDir(String) - method in class org.objectweb.howl.log.Configuration
setLogFileExt(String) - method in class org.objectweb.howl.log.Configuration
setLogFileMode(String) - method in class org.objectweb.howl.log.Configuration
setLogFileName(String) - method in class org.objectweb.howl.log.Configuration
setMaxBlocksPerFile(int) - method in class org.objectweb.howl.log.Configuration
setMaxBuffers(int) - method in class org.objectweb.howl.log.Configuration
setMaxLogFiles(int) - method in class org.objectweb.howl.log.Configuration
setMinBuffers(int) - method in class org.objectweb.howl.log.Configuration
setThreadsWaitingForceThreshold(int) - method in class org.objectweb.howl.log.Configuration
store(OutputStream) - method in class org.objectweb.howl.log.Configuration
Stores configuration properties to OutputStream.

T

tod - field in class org.objectweb.howl.log.LogRecord
currentTimeMillis the log buffer containing this record was initialized.
type - field in class org.objectweb.howl.log.LogRecord
type of data record.

U

USER - static field in class org.objectweb.howl.log.LogRecordType
Log records generated by user.

W

WRITING - static field in class org.objectweb.howl.log.LogBufferStatus
IO Status of LogBuffer while it is being forced.

X

XACOMMIT - static field in class org.objectweb.howl.log.LogRecordType
recorded by XALogger to mark records generated by XALogger#putCommit()
XACOMMITMOVED - static field in class org.objectweb.howl.log.LogRecordType
recorded by XALogger *after* a XACOMMIT record is moved to allow replay to remove the original XACOMMIT record from the activeTx table.
XACommittingTx - class org.objectweb.howl.log.xa.XACommittingTx
XA Transaction Managers write log records using the XALogger subclass of the basic HOWL Logger.
XADONE - static field in class org.objectweb.howl.log.LogRecordType
recorded by XALogger to mark records generated by XALogger#putDone()
XALogger - class org.objectweb.howl.log.xa.XALogger
A specialized subclass of Logger intended to provide functionality required by any XA Transaction Manager.
XALogger() - constructor for class org.objectweb.howl.log.xa.XALogger
Construct a Logger using default Configuration object.
XALogger(Configuration) - constructor for class org.objectweb.howl.log.xa.XALogger
Construct a Logger using a Configuration supplied by the caller.
XALogRecord - class org.objectweb.howl.log.xa.XALogRecord
Extends LogRecord with members that are specific to XALogger.
XALogRecord(int) - constructor for class org.objectweb.howl.log.xa.XALogRecord
constructs an instance of XALogRecord with a byte[] of size data.