org.apache.ratis.server.storage

Class RaftStorageDirectory

java.lang.Object

org.apache.ratis.server.storage.RaftStorageDirectory

public class RaftStorageDirectory
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RaftStorageDirectory.LogPathAndIndex

Method Summary

Modifier and Type	Method and Description
File	getClosedLogFile(long startIndex, long endIndex)
List<RaftStorageDirectory.LogPathAndIndex>	getLogSegmentFiles()
File	getNewTempDir() Returns a uniquely named temporary directory under $rootdir/tmp/
File	getOpenLogFile(long startIndex)
File	getRoot() Get root directory of this storage
File	getStateMachineDir()
boolean	hasMetaFile()
void	lock() Lock storage to provide exclusive access.
static RaftStorageDirectory.LogPathAndIndex	processOnePath(Path path)
Path	relativizeToRoot(Path p)
String	toString()
void	unlock() Unlock storage.

Methods inherited from class java.lang.Object

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

Method Detail

getRoot

public File getRoot()

Get root directory of this storage

getOpenLogFile

public File getOpenLogFile(long startIndex)

getClosedLogFile

public File getClosedLogFile(long startIndex,
                             long endIndex)

getStateMachineDir

public File getStateMachineDir()

getNewTempDir

public File getNewTempDir()

Returns a uniquely named temporary directory under $rootdir/tmp/

relativizeToRoot

public Path relativizeToRoot(Path p)

getLogSegmentFiles

public List<RaftStorageDirectory.LogPathAndIndex> getLogSegmentFiles()
                                                              throws IOException

Returns:

log segment files sorted based on their index.

Throws:

IOException

processOnePath

public static RaftStorageDirectory.LogPathAndIndex processOnePath(Path path)
                                                           throws IOException

Throws:

IOException

hasMetaFile

public boolean hasMetaFile()

lock

public void lock()
          throws IOException

Lock storage to provide exclusive access.

Locking is not supported by all file systems. E.g., NFS does not consistently support exclusive locks.

If locking is supported we guarantee exclusive access to the storage directory. Otherwise, no guarantee is given.

Throws:

IOException - if locking fails

unlock

public void unlock()
            throws IOException

Unlock storage.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object