com.atlassian.jira.index.ha

Interface IndexCopyService

All Known Implementing Classes:

DefaultIndexCopyService

public interface IndexCopyService

Since:

v6.1

Method Summary

Modifier and Type	Method and Description
String	backupIndex(String requestingNode) Back up an index for replicating to another node
String	backupIndex(String requestingNode, TemporaryFilesProvider temporaryFilesProvider) Backup an index for replicating to another node
void	restoreIndex(String filePath) Restore an index.

Method Detail

backupIndex

String backupIndex(String requestingNode)

Back up an index for replicating to another node

Parameters:

requestingNode - Node requesting the index

Returns:

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

backupIndex

String backupIndex(String requestingNode,
                   @Nullable
                   TemporaryFilesProvider temporaryFilesProvider)

Backup an index for replicating to another node

Parameters:

requestingNode - Node requesting the index

temporaryFilesProvider - optionally creates a list of temporary files to be added to the backup

Returns:

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

restoreIndex

void restoreIndex(String filePath)

Restore an index.

Parameters:

filePath - path of the zip file containing the index backup.