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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexUtils.IndexPath Represents the paths in jira home where indexes are stored

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(IssueIndexManager issueIndexManager, LuceneDirectoryUtils luceneDirectoryUtils, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Methods

Modifier and Type	Method and Description
Map<IndexUtils.IndexPath,com.atlassian.jira.index.ha.IndexUtils.IndexPathMapping>	buildIndexPathMappings(String sourcePath, String destinationPath) Builds a mapping from the source index filepath to the destination filepath - keyed by the type of index
void	clearIndex(String path) This deletes all documents in all indexes (if they exist)
void	copyIndexes(String sourcePath, String destinationPath) Copies all indexes from a specified directory to another specified directory.
protected int	deleteOldSnapshots(File directory, int numToKeep)
String	takeIndexSnapshot(String sourcePath, String destinationPath, String snapshotId, int maxSnapshots, IndexSnapshotContribution contribution)

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(IssueIndexManager issueIndexManager,
          LuceneDirectoryUtils luceneDirectoryUtils,
          com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

takeIndexSnapshot

public String takeIndexSnapshot(@Nonnull
                       String sourcePath,
                       @Nonnull
                       String destinationPath,
                       @Nonnull
                       String snapshotId,
                       int maxSnapshots,
                       @Nullable
                       IndexSnapshotContribution contribution)

Parameters:

sourcePath - the root of the source index directory

destinationPath - the destination directory

snapshotId - an ID for the snapshot

maxSnapshots - maximum number of snapshots to keep in the destination directory

contribution - an additional contribution to include in the snapshot

Returns:

filename of the snapshot

copyIndexes

public void copyIndexes(@Nonnull
               String sourcePath,
               @Nonnull
               String destinationPath)

Copies all indexes from a specified directory to another specified directory. Any indexes on the destination directory will be deleted.

Parameters:

sourcePath - source of index files

destinationPath - destination of index files

buildIndexPathMappings

public Map<IndexUtils.IndexPath,com.atlassian.jira.index.ha.IndexUtils.IndexPathMapping> buildIndexPathMappings(@Nonnull
                                                                                                       String sourcePath,
                                                                                                       @Nonnull
                                                                                                       String destinationPath)

Builds a mapping from the source index filepath to the destination filepath - keyed by the type of index

Parameters:

sourcePath - the root of the source index

destinationPath - the root of the destination index

Returns:

clearIndex

public void clearIndex(@Nonnull
              String path)

This deletes all documents in all indexes (if they exist)

Parameters:

path - the root of the index to clear

deleteOldSnapshots

protected int deleteOldSnapshots(File directory,
                     int numToKeep)