com.atlassian.jira.index

Class DefaultIndexEngine

java.lang.Object

com.atlassian.jira.index.DefaultIndexEngine

@ThreadSafe
public class DefaultIndexEngine
extends Object

Thread-safe container that manages our current IndexSearcher and Writer.

Gets passed searcher and writer factories that create new instances of these when required.

getSearcher() - returns an IndexSearcher with a frozen view of the current index; the client is responsible for closing the IndexSearcher when finished. IndexSearcher are shared between clients. getSearcher() creates a new IndexSearcher only if there was some changes on the index.

Clients which received a UnmanagedIndexSearcher via getSearcher() are responsible for closing it via UnmanagedIndexSearcher.close().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultIndexEngine.FlushPolicy How to perform an actual write to the writer.
protected static class	DefaultIndexEngine.WriterReference Thread-safe holder of the current Writer

Field Summary

Fields inherited from interface com.atlassian.jira.util.Closeable

CLOSE

Method Summary

Modifier and Type	Method and Description
void	clean() Clean (wipe) the index.
void	close() Wait till any open Searchers are closed and then close the connection.
UnmanagedIndexSearcher	getSearcher() Get the current searcher.
void	write(Index.Operation operation)

Methods inherited from class java.lang.Object

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

Method Detail

getSearcher

@Nonnull
public UnmanagedIndexSearcher getSearcher()

Get the current searcher. Must be closed after use.

Returns:

An UnmanagedIndexSearcher that reflects the latest writes to the index.

clean

public void clean()

Clean (wipe) the index.

write

public void write(@Nonnull
                  Index.Operation operation)
           throws IOException

Throws:

IOException

close

public void close()

Wait till any open Searchers are closed and then close the connection.