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

Constructor Summary

Constructors

Constructor and Description
IndexUtils(com.atlassian.event.api.EventPublisher eventPublisher, FeatureManager featureManager, ApplicationProperties applicationProperties, IndexBackupContributorsManager indexBackupContributorsManager, ClusterNodes clusterNodes)

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	performBackupOperations(String destinationPath, String snapshotId, int maxSnapshots, ArchiveUtils.Type archiveType, 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

INDEX_SNAPSHOT_FILTER

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

Constructor Detail

IndexUtils

public IndexUtils(com.atlassian.event.api.EventPublisher eventPublisher,
                  FeatureManager featureManager,
                  ApplicationProperties applicationProperties,
                  IndexBackupContributorsManager indexBackupContributorsManager,
                  ClusterNodes clusterNodes)

Method Detail

performBackupOperations

public String performBackupOperations(@Nonnull
                                      String destinationPath,
                                      @Nonnull
                                      String snapshotId,
                                      int maxSnapshots,
                                      @Nullable
                                      ArchiveUtils.Type archiveType,
                                      @Nullable
                                      TemporaryFilesProvider metadataProvider,
                                      @Nullable
                                      String requestingNodeId)

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 to leave only maxSnapshots

Parameters:

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

snapshotId - identifier suffix added to snapshot filename

maxSnapshots - maximum number of snapshots to be left after cleanup phase

archiveType - archiver used for creating the snapshot. If it's null default archiver will be used

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

Returns:

name of created snapshot file

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)