com.atlassian.jira.index.ha

Interface IndexSnapshotOperator

All Known Implementing Classes:

DefaultIndexSnapshotOperator

public interface IndexSnapshotOperator

Method Summary

Modifier and Type	Method and Description
List<Path>	listIndexSnapshots() Lists absolute paths to currently available index snapshots.
String	performIndexSnapshotBackupAndCleanup() Creates a snapshot of jira index.
String	performIndexSnapshotBackupAndCleanup(TemporaryFilesProvider temporaryFilesProvider, String notifyNode) Creates a snapshot of jira index.

Method Detail

performIndexSnapshotBackupAndCleanup

String performIndexSnapshotBackupAndCleanup()

Creates a snapshot of jira index. Performs a cleanup of index snapshots directory so only IndexUtils.MAX_SNAPSHOTS (or value override by com.atlassian.jira.config.properties.APKeys#INDEX_SNAPSHOT_COUNT) of most recent snapshots is persisted.

Returns:

Filename of snapshot file, or null if the backup did not occur

performIndexSnapshotBackupAndCleanup

String performIndexSnapshotBackupAndCleanup(@Nullable
                                            TemporaryFilesProvider temporaryFilesProvider,
                                            @Nullable
                                            String notifyNode)

Creates a snapshot of jira index.

Parameters:

temporaryFilesProvider - - TemporaryFilesProvider that will be called upon snapshot archive creation

notifyNode - Node requesting the index

Returns:

the name of the backup file, or null if the backup did not occur

See Also:

performIndexSnapshotBackupAndCleanup()

listIndexSnapshots

List<Path> listIndexSnapshots()

Lists absolute paths to currently available index snapshots.

Returns:

List of currently available index snapshots absolute paths.