Package com.atlassian.jira.index.ha

Interface IndexCopyService

All Known Implementing Classes:

DefaultIndexCopyService

public interface IndexCopyService

Since:

v6.1

Method Summary

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

Method Details

backupIndex

String backupIndex(String requestingNode)

Back up an index for replicating to another node

Parameters:

requestingNode - - node that should be notified when backup preparation is available

Returns:

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

backupIndex

String backupIndex(@Nullable
 TemporaryFilesProvider temporaryFilesProvider,
 @Nullable
 String requestingNode)

Backup an index for replicating to another node

Parameters:

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

requestingNode - - node that should be notified when backup preparation is available

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.