Package com.atlassian.jira.index.ha

Class DefaultIndexSnapshotOperator

java.lang.Object

com.atlassian.jira.index.ha.DefaultIndexSnapshotOperator

All Implemented Interfaces:

IndexSnapshotOperator

public class DefaultIndexSnapshotOperator
extends Object
implements IndexSnapshotOperator

Default implementation of IndexSnapshotOperator.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
DefaultIndexSnapshotOperator(FileStores fileStores, IndexUtils indexUtils, org.ofbiz.core.entity.DelegatorInterface delegatorInterface, com.atlassian.beehive.ClusterLockService clusterLockService, com.atlassian.event.api.EventListenerRegistrar eventListenerRegistrar, JiraProperties jiraProperties)

Method Summary

Modifier and Type	Method	Description
IndexSnapshotCreationResult	forceCreateSnapshot()
IndexSnapshotCreationResult	forceCreateSnapshot(TemporaryFilesProvider temporaryFilesProvider, String notifyNode)
boolean	isIndexSnapshotRunning()
List<File>	listIndexSnapshotFiles()	Lists all files representing currently available index snapshots.
void	onPluginFrameworkShutdown(com.atlassian.plugin.event.events.PluginFrameworkShutdownEvent event)
IndexSnapshotAsyncStartResult	performIndexSnapshotBackupAndCleanupAsync()	Triggers creation of a jira snapshot index.
IndexSnapshotCreationResult	tryCreateSnapshot()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_DATE_FORMAT

public static final String DEFAULT_DATE_FORMAT

See Also:

• Constant Field Values

Constructor Details

DefaultIndexSnapshotOperator

public DefaultIndexSnapshotOperator(FileStores fileStores,
 IndexUtils indexUtils,
 org.ofbiz.core.entity.DelegatorInterface delegatorInterface,
 com.atlassian.beehive.ClusterLockService clusterLockService,
 @Nonnull
 com.atlassian.event.api.EventListenerRegistrar eventListenerRegistrar,
 JiraProperties jiraProperties)

Method Details

forceCreateSnapshot

public IndexSnapshotCreationResult forceCreateSnapshot()

Specified by:

forceCreateSnapshot in interface IndexSnapshotOperator

forceCreateSnapshot

public IndexSnapshotCreationResult forceCreateSnapshot(TemporaryFilesProvider temporaryFilesProvider,
 String notifyNode)

Specified by:

forceCreateSnapshot in interface IndexSnapshotOperator

tryCreateSnapshot

public IndexSnapshotCreationResult tryCreateSnapshot()

Specified by:

tryCreateSnapshot in interface IndexSnapshotOperator

performIndexSnapshotBackupAndCleanupAsync

public IndexSnapshotAsyncStartResult performIndexSnapshotBackupAndCleanupAsync()

Description copied from interface: IndexSnapshotOperator

Triggers creation of a jira snapshot index. Does not wait for completion and returns a name of the snapshot to be created.

Specified by:

performIndexSnapshotBackupAndCleanupAsync in interface IndexSnapshotOperator

Returns:

Status of the attempt to start the index snapshot creation.

listIndexSnapshotFiles

public List<File> listIndexSnapshotFiles()

Description copied from interface: IndexSnapshotOperator

Lists all files representing currently available index snapshots.

Specified by:

listIndexSnapshotFiles in interface IndexSnapshotOperator

Returns:

List of currently available index snapshot files.

isIndexSnapshotRunning

public boolean isIndexSnapshotRunning()

Specified by:

isIndexSnapshotRunning in interface IndexSnapshotOperator

Returns:

true if index snapshot is currently being created on any node.

onPluginFrameworkShutdown

@EventListener
public void onPluginFrameworkShutdown(com.atlassian.plugin.event.events.PluginFrameworkShutdownEvent event)