Package org.apache.activemq.store.kahadb.disk.journal

Class Journal

java.lang.Object

org.apache.activemq.store.kahadb.disk.journal.Journal

Direct Known Subclasses:

ReadOnlyJournal

public class Journal
extends Object

Manages DataFiles

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Journal.DataFileRemovedListener
static enum	Journal.JournalDiskSyncStrategy
static enum	Journal.PreallocationScope
static enum	Journal.PreallocationStrategy
static class	Journal.WriteCommand
static class	Journal.WriteKey

Field Summary

Fields

Modifier and Type	Field	Description
protected DataFileAccessorPool	accessorPool
protected FileAppender	appender
protected boolean	archiveDataLogs
static final byte[]	BATCH_CONTROL_RECORD_HEADER
static final byte[]	BATCH_CONTROL_RECORD_MAGIC
static final int	BATCH_CONTROL_RECORD_SIZE
static final byte	BATCH_CONTROL_RECORD_TYPE
static final String	CALLER_BUFFER_APPENDER
static final boolean	callerBufferAppender
protected boolean	checkForCorruptionOnStartup
protected boolean	checksum
protected ScheduledFuture	cleanupTask
protected LinkedNodeList<DataFile>	dataFiles
static final String	DEFAULT_ARCHIVE_DIRECTORY
static final int	DEFAULT_CLEANUP_INTERVAL
static final String	DEFAULT_DIRECTORY
static final String	DEFAULT_FILE_PREFIX
static final String	DEFAULT_FILE_SUFFIX
static final int	DEFAULT_MAX_FILE_LENGTH
static final int	DEFAULT_MAX_WRITE_BATCH_SIZE
protected File	directory
protected File	directoryArchive
static final byte[]	EMPTY_BATCH_CONTROL_RECORD
protected boolean	enableAsyncDiskSync
static final byte	EOF_EOT
static final int	EOF_INT
static final byte[]	EOF_RECORD
protected Map<File,DataFile>	fileByFileMap
protected Map<Integer,DataFile>	fileMap
protected String	filePrefix
protected String	fileSuffix
protected final Map<Journal.WriteKey,Journal.WriteCommand>	inflightWrites
protected Journal.JournalDiskSyncStrategy	journalDiskSyncStrategy
protected final AtomicReference<Location>	lastAppendLocation
protected int	maxFileLength
protected Journal.PreallocationScope	preallocationScope
protected Journal.PreallocationStrategy	preallocationStrategy
static final int	RECORD_HEAD_SPACE
protected boolean	started
protected AtomicLong	totalLength
static final byte	USER_RECORD_TYPE
protected int	writeBatchSize

Constructor Summary

Constructors

Constructor	Description
Journal()

Method Summary

Modifier and Type	Method	Description
void	allowIOResumption()
void	cleanup()
void	close()
void	corruptRecoveryLocation(Location recoveryPosition)
boolean	delete()
DataFileAccessorPool	getAccessorPool()
long	getCleanupInterval()
DataFile	getCurrentDataFile(int capacity)
Integer	getCurrentDataFileId()
DataFile	getDataFileById(int dataFileId)
File	getDirectory()
File	getDirectoryArchive()
long	getDiskSize()
File	getFile(int nextNum)
Map<Integer,DataFile>	getFileMap()
String	getFilePrefix()
Set<File>	getFiles()	Get a set of files - only valid after start()
String	getFileSuffix()
Map<Journal.WriteKey,Journal.WriteCommand>	getInflightWrites()
Journal.JournalDiskSyncStrategy	getJournalDiskSyncStrategy()
Location	getLastAppendLocation()
int	getMaxFileLength()
Location	getNextLocation(Location location)
Location	getNextLocation(Location location, Location limit)
Journal.PreallocationScope	getPreallocationScope()
Journal.PreallocationStrategy	getPreallocationStrategy()
ReplicationTarget	getReplicationTarget()
int	getWriteBatchSize()
boolean	isArchiveDataLogs()
boolean	isCheckForCorruptionOnStartup()
boolean	isChecksum()
boolean	isEnableAsyncDiskSync()
boolean	isJournalDiskSyncPeriodic()
boolean	isUnusedPreallocated(DataFile dataFile)
long	length()
void	preallocateEntireJournalDataFile(RecoverableRandomAccessFile file)
ByteSequence	read(Location location)
protected Location	recoveryCheck(DataFile dataFile)
void	removeDataFiles(Set<Integer> files)
DataFile	reserveDataFile()
void	rotateWriteFile()
void	setArchiveDataLogs(boolean archiveDataLogs)
void	setCheckForCorruptionOnStartup(boolean checkForCorruptionOnStartup)
void	setChecksum(boolean checksumWrites)
void	setCleanupInterval(long cleanupInterval)
void	setDataFileRemovedListener(Journal.DataFileRemovedListener dataFileRemovedListener)
void	setDirectory(File directory)
void	setDirectoryArchive(File directoryArchive)
void	setEnableAsyncDiskSync(boolean val)
void	setFilePrefix(String filePrefix)
void	setFileSuffix(String fileSuffix)
void	setJournalDiskSyncStrategy(Journal.JournalDiskSyncStrategy journalDiskSyncStrategy)
void	setLastAppendLocation(Location lastSyncedLocation)
void	setMaxFileLength(int maxFileLength)
void	setPreallocationScope(Journal.PreallocationScope preallocationScope)
void	setPreallocationStrategy(Journal.PreallocationStrategy preallocationStrategy)
void	setReplicationTarget(ReplicationTarget replicationTarget)
void	setSizeAccumulator(AtomicLong storeSizeAccumulator)
void	setWriteBatchSize(int writeBatchSize)
void	start()
String	toString()
void	update(Location location, ByteSequence data, boolean sync)
Location	write(ByteSequence data, boolean sync)
Location	write(ByteSequence data, Runnable onComplete)

Methods inherited from class java.lang.Object

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

Field Details

CALLER_BUFFER_APPENDER

public static final String CALLER_BUFFER_APPENDER

See Also:

• Constant Field Values

callerBufferAppender

public static final boolean callerBufferAppender

RECORD_HEAD_SPACE

public static final int RECORD_HEAD_SPACE

See Also:

• Constant Field Values

USER_RECORD_TYPE

public static final byte USER_RECORD_TYPE

See Also:

• Constant Field Values

BATCH_CONTROL_RECORD_TYPE

public static final byte BATCH_CONTROL_RECORD_TYPE

See Also:

• Constant Field Values

BATCH_CONTROL_RECORD_MAGIC

public static final byte[] BATCH_CONTROL_RECORD_MAGIC

BATCH_CONTROL_RECORD_SIZE

public static final int BATCH_CONTROL_RECORD_SIZE

BATCH_CONTROL_RECORD_HEADER

public static final byte[] BATCH_CONTROL_RECORD_HEADER

EMPTY_BATCH_CONTROL_RECORD

public static final byte[] EMPTY_BATCH_CONTROL_RECORD

EOF_INT

public static final int EOF_INT

EOF_EOT

public static final byte EOF_EOT

See Also:

• Constant Field Values

EOF_RECORD

public static final byte[] EOF_RECORD

DEFAULT_DIRECTORY

public static final String DEFAULT_DIRECTORY

See Also:

• Constant Field Values

DEFAULT_ARCHIVE_DIRECTORY

public static final String DEFAULT_ARCHIVE_DIRECTORY

See Also:

• Constant Field Values

DEFAULT_FILE_PREFIX

public static final String DEFAULT_FILE_PREFIX

See Also:

• Constant Field Values

DEFAULT_FILE_SUFFIX

public static final String DEFAULT_FILE_SUFFIX

See Also:

• Constant Field Values

DEFAULT_MAX_FILE_LENGTH

public static final int DEFAULT_MAX_FILE_LENGTH

See Also:

• Constant Field Values

DEFAULT_CLEANUP_INTERVAL

public static final int DEFAULT_CLEANUP_INTERVAL

See Also:

• Constant Field Values

DEFAULT_MAX_WRITE_BATCH_SIZE

public static final int DEFAULT_MAX_WRITE_BATCH_SIZE

See Also:

• Constant Field Values

inflightWrites

protected final Map<Journal.WriteKey,Journal.WriteCommand> inflightWrites

directory

protected File directory

directoryArchive

protected File directoryArchive

filePrefix

protected String filePrefix

fileSuffix

protected String fileSuffix

started

protected boolean started

maxFileLength

protected int maxFileLength

writeBatchSize

protected int writeBatchSize

appender

protected FileAppender appender

accessorPool

protected DataFileAccessorPool accessorPool

fileMap

protected Map<Integer,DataFile> fileMap

fileByFileMap

protected Map<File,DataFile> fileByFileMap

dataFiles

protected LinkedNodeList<DataFile> dataFiles

lastAppendLocation

protected final AtomicReference<Location> lastAppendLocation

cleanupTask

protected ScheduledFuture cleanupTask

totalLength

protected AtomicLong totalLength

archiveDataLogs

protected boolean archiveDataLogs

checksum

protected boolean checksum

checkForCorruptionOnStartup

protected boolean checkForCorruptionOnStartup

enableAsyncDiskSync

protected boolean enableAsyncDiskSync

preallocationScope

protected Journal.PreallocationScope preallocationScope

preallocationStrategy

protected Journal.PreallocationStrategy preallocationStrategy

journalDiskSyncStrategy

protected Journal.JournalDiskSyncStrategy journalDiskSyncStrategy

Constructor Details

Journal

public Journal()

Method Details

corruptRecoveryLocation

public void corruptRecoveryLocation(Location recoveryPosition)
                             throws IOException

Throws:

IOException

getAccessorPool

public DataFileAccessorPool getAccessorPool()

allowIOResumption

public void allowIOResumption()

setCleanupInterval

public void setCleanupInterval(long cleanupInterval)

getCleanupInterval

public long getCleanupInterval()

start

public void start()
           throws IOException

Throws:

IOException

preallocateEntireJournalDataFile

public void preallocateEntireJournalDataFile(RecoverableRandomAccessFile file)

isUnusedPreallocated

public boolean isUnusedPreallocated(DataFile dataFile)
                             throws IOException

Throws:

IOException

recoveryCheck

protected Location recoveryCheck(DataFile dataFile)
                          throws IOException

Throws:

IOException

length

public long length()

rotateWriteFile

public void rotateWriteFile()
                     throws IOException

Throws:

IOException

reserveDataFile

public DataFile reserveDataFile()

getFile

public File getFile(int nextNum)

close

public void close()
           throws IOException

Throws:

IOException

cleanup

public void cleanup()

delete

public boolean delete()
               throws IOException

Throws:

IOException

removeDataFiles

public void removeDataFiles(Set<Integer> files)
                     throws IOException

Throws:

IOException

getMaxFileLength

public int getMaxFileLength()

Returns:

the maxFileLength

setMaxFileLength

public void setMaxFileLength(int maxFileLength)

Parameters:

maxFileLength - the maxFileLength to set

toString

public String toString()

Overrides:

toString in class Object

getNextLocation

public Location getNextLocation(Location location)
                         throws IOException,
IllegalStateException

Throws:

IOException

IllegalStateException

getNextLocation

public Location getNextLocation(Location location,
 Location limit)
                         throws IOException,
IllegalStateException

Throws:

IOException

IllegalStateException

read

public ByteSequence read(Location location)
                  throws IOException,
IllegalStateException

Throws:

IOException

IllegalStateException

write

public Location write(ByteSequence data,
 boolean sync)
               throws IOException,
IllegalStateException

Throws:

IOException

IllegalStateException

write

public Location write(ByteSequence data,
 Runnable onComplete)
               throws IOException,
IllegalStateException

Throws:

IOException

IllegalStateException

update

public void update(Location location,
 ByteSequence data,
 boolean sync)
            throws IOException

Throws:

IOException

getPreallocationStrategy

public Journal.PreallocationStrategy getPreallocationStrategy()

setPreallocationStrategy

public void setPreallocationStrategy(Journal.PreallocationStrategy preallocationStrategy)

getPreallocationScope

public Journal.PreallocationScope getPreallocationScope()

setPreallocationScope

public void setPreallocationScope(Journal.PreallocationScope preallocationScope)

getDirectory

public File getDirectory()

setDirectory

public void setDirectory(File directory)

getFilePrefix

public String getFilePrefix()

setFilePrefix

public void setFilePrefix(String filePrefix)

getInflightWrites

public Map<Journal.WriteKey,Journal.WriteCommand> getInflightWrites()

getLastAppendLocation

public Location getLastAppendLocation()

setLastAppendLocation

public void setLastAppendLocation(Location lastSyncedLocation)

getDirectoryArchive

public File getDirectoryArchive()

setDirectoryArchive

public void setDirectoryArchive(File directoryArchive)

isArchiveDataLogs

public boolean isArchiveDataLogs()

setArchiveDataLogs

public void setArchiveDataLogs(boolean archiveDataLogs)

getDataFileById

public DataFile getDataFileById(int dataFileId)

getCurrentDataFile

public DataFile getCurrentDataFile(int capacity)
                            throws IOException

Throws:

IOException

getCurrentDataFileId

public Integer getCurrentDataFileId()

getFiles

public Set<File> getFiles()

Get a set of files - only valid after start()

Returns:

files currently being used

getFileMap

public Map<Integer,DataFile> getFileMap()

getDiskSize

public long getDiskSize()

setReplicationTarget

public void setReplicationTarget(ReplicationTarget replicationTarget)

getReplicationTarget

public ReplicationTarget getReplicationTarget()

getFileSuffix

public String getFileSuffix()

setFileSuffix

public void setFileSuffix(String fileSuffix)

isChecksum

public boolean isChecksum()

setChecksum

public void setChecksum(boolean checksumWrites)

isCheckForCorruptionOnStartup

public boolean isCheckForCorruptionOnStartup()

setCheckForCorruptionOnStartup

public void setCheckForCorruptionOnStartup(boolean checkForCorruptionOnStartup)

setWriteBatchSize

public void setWriteBatchSize(int writeBatchSize)

getWriteBatchSize

public int getWriteBatchSize()

setSizeAccumulator

public void setSizeAccumulator(AtomicLong storeSizeAccumulator)

setEnableAsyncDiskSync

public void setEnableAsyncDiskSync(boolean val)

isEnableAsyncDiskSync

public boolean isEnableAsyncDiskSync()

getJournalDiskSyncStrategy

public Journal.JournalDiskSyncStrategy getJournalDiskSyncStrategy()

setJournalDiskSyncStrategy

public void setJournalDiskSyncStrategy(Journal.JournalDiskSyncStrategy journalDiskSyncStrategy)

isJournalDiskSyncPeriodic

public boolean isJournalDiskSyncPeriodic()

setDataFileRemovedListener

public void setDataFileRemovedListener(Journal.DataFileRemovedListener dataFileRemovedListener)