com.atlassian.jira.index.ha

Class IndexUtils

java.lang.Object

com.atlassian.jira.index.ha.IndexUtils

public class IndexUtils
extends Object

Helper methods to work with LuceneIndexes.

Since:

v6.1

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.io.PatternFilenameFilter	INDEX_SNAPSHOT_FILTER
static String	INDEX_SNAPSHOT_IN_PROGRESS_CLUSTER_LOCK
static String	INDEX_SNAPSHOT_PREFIX
static int	MAX_SNAPSHOTS
static String	SNAPSHOT_CREATION_BARRIER
static String	SNAPSHOT_PARALLEL_CREATION_ALLOWED

Constructor Summary

Constructors

Constructor and Description

IndexUtils(com.atlassian.event.api.EventPublisher eventPublisher, ApplicationProperties applicationProperties, IndexBackupContributorsManager indexBackupContributorsManager, ClusterNodes clusterNodes, IndexLifecycleManager indexLifecycleManager, PeriodicIndexWriterCommitScheduler periodicIndexWriterCommitScheduler, com.atlassian.beehive.ClusterLockService clusterLockService, JiraProperties jiraProperties, BarrierFactory barrierFactory)

Method Summary

Modifier and Type	Method and Description
protected long	calculateFileSize(File snapshot)
protected Long	createIndexSnapshot(File snapshot, ArchiveUtils.Type archiveType, TemporaryFilesProvider metadataProvider)
protected int	deleteOldSnapshots(File directory, int numToKeep)
String	deriveFilename(String snapshotId)
IndexSnapshotCreationResult	performBackupOperations(String destinationPath, String snapshotFilename, TemporaryFilesProvider metadataProvider, String requestingNodeId) Creates a backup file at destinationPath.

Methods inherited from class java.lang.Object

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

Field Detail

SNAPSHOT_PARALLEL_CREATION_ALLOWED

public static final String SNAPSHOT_PARALLEL_CREATION_ALLOWED

See Also:

Constant Field Values

INDEX_SNAPSHOT_IN_PROGRESS_CLUSTER_LOCK

public static final String INDEX_SNAPSHOT_IN_PROGRESS_CLUSTER_LOCK

See Also:

Constant Field Values

INDEX_SNAPSHOT_PREFIX

public static final String INDEX_SNAPSHOT_PREFIX

See Also:

Constant Field Values

SNAPSHOT_CREATION_BARRIER

public static final String SNAPSHOT_CREATION_BARRIER

See Also:

Constant Field Values

INDEX_SNAPSHOT_FILTER

public static final com.google.common.io.PatternFilenameFilter INDEX_SNAPSHOT_FILTER

MAX_SNAPSHOTS

public static final int MAX_SNAPSHOTS

See Also:

Constant Field Values

Constructor Detail

IndexUtils

public IndexUtils(com.atlassian.event.api.EventPublisher eventPublisher,
                  ApplicationProperties applicationProperties,
                  IndexBackupContributorsManager indexBackupContributorsManager,
                  ClusterNodes clusterNodes,
                  IndexLifecycleManager indexLifecycleManager,
                  PeriodicIndexWriterCommitScheduler periodicIndexWriterCommitScheduler,
                  com.atlassian.beehive.ClusterLockService clusterLockService,
                  JiraProperties jiraProperties,
                  BarrierFactory barrierFactory)

Method Detail

performBackupOperations

public IndexSnapshotCreationResult performBackupOperations(@Nonnull
                                                           String destinationPath,
                                                           @Nonnull
                                                           String snapshotFilename,
                                                           @Nullable
                                                           TemporaryFilesProvider metadataProvider,
                                                           @Nullable
                                                           String requestingNodeId)
                                                    throws IndexException,
                                                           InterruptedException,
                                                           ExecutionException,
                                                           TimeoutException

Creates a backup file at destinationPath. Allows backup contributors registered in IndexBackupContributorsManager to contribute to that file. Creates temporary folder for the time of operation and allows and the metadataProvider to crate additional files in that folder and also adds them to the backup. Performs cleanup of existing previous snapshot in destination. The number of left snapshots is determined by value under com.atlassian.jira.config.properties.APKeys#INDEX_SNAPSHOT_COUNT and defaults to com.atlassian.jira.index.ha.IndexUtils#MAX_SNAPSHOTS

Parameters:

destinationPath - directory path for newly created snapshot. Will be created if necessary

snapshotFilename - snapshot filename

metadataProvider - provider of additional files that should be included in the archive, can be null. Files it will create in given temp directory will be removed after the backup ends

requestingNodeId - id of node that awaits the snapshot. the node be notified on completion

Returns:

name of created snapshot file

Throws:

IndexException - when the index is not consistent

InterruptedException

ExecutionException

TimeoutException

deriveFilename

public String deriveFilename(String snapshotId)

createIndexSnapshot

protected Long createIndexSnapshot(@Nonnull
                                   File snapshot,
                                   @Nonnull
                                   ArchiveUtils.Type archiveType,
                                   @Nullable
                                   TemporaryFilesProvider metadataProvider)

calculateFileSize

protected long calculateFileSize(File snapshot)

deleteOldSnapshots

protected int deleteOldSnapshots(File directory,
                                 int numToKeep)