org.neo4j.kernel.api.index.util

Class FailureStorage

java.lang.Object

org.neo4j.kernel.api.index.util.FailureStorage

public class FailureStorage
extends Object

Helper class for storing a failure message that happens during an OutOfDisk situation in a pre-allocated file

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FAILURE_FILE_NAME
static int	MAX_FAILURE_SIZE

Constructor Summary

Constructors

Constructor and Description
FailureStorage(FolderLayout folderLayout)
FailureStorage(FolderLayout folderLayout, String failureFileName)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearForIndex(long indexId) Delete failure file for the given index id
String	loadIndexFailure(long indexId)
void	reserveForIndex(long indexId) Create/reserve an empty failure file for the given indexId.
void	storeIndexFailure(long indexId, String failure) Store failure in failure file for index with the given id

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FAILURE_SIZE

public static final int MAX_FAILURE_SIZE

See Also:

Constant Field Values

DEFAULT_FAILURE_FILE_NAME

public static final String DEFAULT_FAILURE_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

FailureStorage

public FailureStorage(FolderLayout folderLayout,
              String failureFileName)

Parameters:

failureFileName - name of failure files to be created

folderLayout - describing where failure files should be stored

FailureStorage

public FailureStorage(FolderLayout folderLayout)

Method Detail

reserveForIndex

public void reserveForIndex(long indexId)
                     throws IOException

Create/reserve an empty failure file for the given indexId. This will overwrite any pre-existing failure file.

Parameters:

indexId - id of the index

Throws:

IOException - if the failure file could not be created

clearForIndex

public void clearForIndex(long indexId)

Delete failure file for the given index id

Parameters:

indexId - of the index that failed

loadIndexFailure

public String loadIndexFailure(long indexId)

Returns:

the failure, if any. Otherwise null marking no failure.

storeIndexFailure

public void storeIndexFailure(long indexId,
                     String failure)
                       throws IOException

Store failure in failure file for index with the given id

Parameters:

indexId - of the index that failed

failure - message describing the failure that needs to be stored

Throws:

IOException - if the failure could not be stored