public class

Indexes

extends Object
java.lang.Object
   ↳ com.atlassian.jira.index.Indexes

Class Overview

Static factory class for creating Index and Index.Manager instances.

Summary

Public Methods
@Nonnull static Index.Manager createQueuedIndexManager(String name, Configuration config, int maxQueueSize)
Creates an index where the index operations are placed on a queue and the actual work is done on a background thread.
@Nonnull static Index.Manager createSimpleIndexManager(Configuration config)
Creates an index where the index operation work is done in the calling thread.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

@Nonnull public static Index.Manager createQueuedIndexManager (String name, Configuration config, int maxQueueSize)

Creates an index where the index operations are placed on a queue and the actual work is done on a background thread. Any Index.Result may be waited on to make sure that subsequent searchers will see the result of that update, but you can timeout on that without losing the update.

Parameters
name used to name the background thread.
config that holds the Directory and Analyzer used for indexing and searching.
Returns
  • a Index.Manager that has an index configured for queued operations.

@Nonnull public static Index.Manager createSimpleIndexManager (Configuration config)

Creates an index where the index operation work is done in the calling thread. Any Index.Result may be waited on but it will always be a non-blocking operation as it will be complete already. There is no way to timeout these operations.

The Index write policy is that flushes will only occur when the IndexWriter decides to according to its internal buffering policy, or when the index is closed.

Parameters
config that holds the Directory and Analyzer used for indexing and searching.
Returns
  • a Index.Manager that has an index configured for direct operations.