org.apache.activemq.artemis.core.journal.impl

Class JournalFilesRepository

java.lang.Object

org.apache.activemq.artemis.core.journal.impl.JournalFilesRepository

public class JournalFilesRepository
extends Object

This is a helper class for the Journal, which will control access to dataFiles, openedFiles and freeFiles Guaranteeing that they will be delivered in order to the Journal

Constructor Summary

Constructors

Constructor and Description
JournalFilesRepository(SequentialFileFactory fileFactory, JournalImpl journal, String filePrefix, String fileExtension, int userVersion, int maxAIO, int fileSize, int minFiles, int poolSize)

Method Summary

Modifier and Type	Method and Description
void	addDataFileOnBottom(JournalFile file)
void	addDataFileOnTop(JournalFile file)
void	addFreeFile(JournalFile file, boolean renameTmp)
void	addFreeFile(JournalFile file, boolean renameTmp, boolean checkDelete)
void	calculateNextfileID(List<JournalFile> files)
void	checkDataFiles()
void	clear()
void	clearDataFiles()
void	closeFile(JournalFile file)
JournalFile	createRemoteBackupSyncFile(long fileID) Creates files for journal synchronization of a replicated backup.
String	debugFiles()
void	ensureMinFiles()
Collection<JournalFile>	getDataFiles()
JournalFile[]	getDataFilesArray()
int	getDataFilesCount()
String	getFileExtension()
String	getFilePrefix()
JournalFile	getFreeFile()
Collection<JournalFile>	getFreeFiles()
int	getFreeFilesCount()
int	getMaxAIO()
int	getOpenedFilesCount()
JournalFile	openFile() This method will instantly return the opened file, and schedule opening and reclaiming.
void	openFile(JournalFile file, boolean multiAIO)
JournalFile	pollLastDataFile()
void	pushOpenedFile() Open a file and place it into the openedFiles queue
void	removeDataFile(JournalFile file)
void	setExecutor(Executor fileExecutor)
void	setNextFileID(long targetUpdate) Set the {link #nextFileID} value to targetUpdate if the current value is less than targetUpdate.
JournalFile	takeFile(boolean keepOpened, boolean multiAIO, boolean initFile, boolean tmpCompactExtension) This will get a File from freeFile without initializing it
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JournalFilesRepository

public JournalFilesRepository(SequentialFileFactory fileFactory,
                              JournalImpl journal,
                              String filePrefix,
                              String fileExtension,
                              int userVersion,
                              int maxAIO,
                              int fileSize,
                              int minFiles,
                              int poolSize)

Method Detail

setExecutor

public void setExecutor(Executor fileExecutor)

clear

public void clear()
           throws Exception

Throws:

Exception

getMaxAIO

public int getMaxAIO()

getFileExtension

public String getFileExtension()

getFilePrefix

public String getFilePrefix()

calculateNextfileID

public void calculateNextfileID(List<JournalFile> files)

setNextFileID

public void setNextFileID(long targetUpdate)

Set the {link #nextFileID} value to targetUpdate if the current value is less than targetUpdate. Notice that nextFileID is incremented before being used, see generateFileID().

Parameters:

targetUpdate -

ensureMinFiles

public void ensureMinFiles()
                    throws Exception

Throws:

Exception

openFile

public void openFile(JournalFile file,
                     boolean multiAIO)
              throws Exception

Throws:

Exception

getDataFilesArray

public JournalFile[] getDataFilesArray()

pollLastDataFile

public JournalFile pollLastDataFile()

removeDataFile

public void removeDataFile(JournalFile file)

getDataFilesCount

public int getDataFilesCount()

getDataFiles

public Collection<JournalFile> getDataFiles()

clearDataFiles

public void clearDataFiles()

addDataFileOnTop

public void addDataFileOnTop(JournalFile file)

debugFiles

public String debugFiles()

checkDataFiles

public void checkDataFiles()

addDataFileOnBottom

public void addDataFileOnBottom(JournalFile file)

getFreeFilesCount

public int getFreeFilesCount()

addFreeFile

public void addFreeFile(JournalFile file,
                        boolean renameTmp)
                 throws Exception

Parameters:

file -

Throws:

Exception

addFreeFile

public void addFreeFile(JournalFile file,
                        boolean renameTmp,
                        boolean checkDelete)
                 throws Exception

Parameters:

file -

renameTmp - - should rename the file as it's being added to free files

checkDelete - - should delete the file if max condition has been met

Throws:

Exception

getFreeFiles

public Collection<JournalFile> getFreeFiles()

getFreeFile

public JournalFile getFreeFile()

getOpenedFilesCount

public int getOpenedFilesCount()

openFile

public JournalFile openFile()
                     throws InterruptedException,
                            ActiveMQIOErrorException

This method will instantly return the opened file, and schedule opening and reclaiming.

In case there are no cached opened files, this method will block until the file was opened, what would happen only if the system is under heavy load by another system (like a backup system, or a DB sharing the same box as ActiveMQ).

Throws:

ActiveMQIOErrorException - In case the file could not be opened

InterruptedException

pushOpenedFile

public void pushOpenedFile()
                    throws Exception

Open a file and place it into the openedFiles queue

Throws:

Exception

closeFile

public void closeFile(JournalFile file)
               throws Exception

Throws:

Exception

takeFile

public JournalFile takeFile(boolean keepOpened,
                            boolean multiAIO,
                            boolean initFile,
                            boolean tmpCompactExtension)
                     throws Exception

This will get a File from freeFile without initializing it

Returns:

uninitialized JournalFile

Throws:

Exception

See Also:

JournalImpl.initFileHeader(SequentialFileFactory, SequentialFile, int, long)

createRemoteBackupSyncFile

public JournalFile createRemoteBackupSyncFile(long fileID)
                                       throws Exception

Creates files for journal synchronization of a replicated backup. In order to simplify synchronization, the file IDs in the backup match those in the live server.

Parameters:

fileID - the fileID to use when creating the file.

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object