Package ch.rswk.meta.engine

Class LuceneService

java.lang.Object

com.google.common.util.concurrent.AbstractExecutionThreadService

ch.rswk.meta.engine.AbstractEngineExecutionThreadService<LuceneService.LuceneServiceConfig>

ch.rswk.meta.engine.AbstractEngineWorkQueueService<LuceneService.LuceneServiceConfig,LuceneService.WorkUnit,Object>

ch.rswk.meta.engine.LuceneService

All Implemented Interfaces:

EngineServices.ConfigurableService<LuceneService.LuceneServiceConfig>, EngineServices.InfoProvidingService, com.google.common.util.concurrent.Service

public class LuceneService
extends AbstractEngineWorkQueueService<LuceneService.LuceneServiceConfig,LuceneService.WorkUnit,Object>

LuceneService handles writing and searching a single Lucene index via a work queue.

Multiple instances of this service exist in any given runtime. Services that want to have their own Lucene index must create their own instance of LuceneService.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	LuceneService.CommitData
class	LuceneService.LuceneContext
static final record	LuceneService.LuceneServiceConfig
static final record	LuceneService.SearchResult
static final record	LuceneService.SearchResultCursor
(package private) static final record	LuceneService.WorkUnit<T>
private class	LuceneService.WriterHealthCheck

Nested classes/interfaces inherited from class ch.rswk.meta.engine.AbstractEngineWorkQueueService

AbstractEngineWorkQueueService.ShutdownType

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.lucene.analysis.Analyzer	analyzer
private static final int	COMMIT_SCHEDULE
private static final String	COMMIT_SEQUENCE_NUMBER_KEY
private static final String	COMMIT_TIMESTAMP_KEY
private ScheduledFuture<?>	commitHandle
private com.codahale.metrics.Timer	commitTimer
private org.apache.lucene.store.FSDirectory	directory
private final Map<String,String>	extendedCommitData
private final com.google.common.util.concurrent.Monitor	indexMonitor
private final org.slf4j.Logger	log
private final LuceneService.LuceneContext	luceneContext
private static final int	QUEUE_CAPACITY
private static final int	QUEUE_OFFER_TIMEOUT
private com.codahale.metrics.Timer	refreshTimer
private org.apache.lucene.search.IndexSearcher	searcher
private static final String	WORK_DIR
private static final String	WRITE_LOCK_FILE
private final AtomicBoolean	writeFlag
private org.apache.lucene.index.IndexWriter	writer

Fields inherited from class ch.rswk.meta.engine.AbstractEngineWorkQueueService

capacity, offerTimeout, serviceId, shutdownType, workQueue

Fields inherited from class ch.rswk.meta.engine.AbstractEngineExecutionThreadService

runtime

Constructor Summary

Constructors

Constructor	Description
LuceneService(LuceneService.LuceneServiceConfig config, EngineRuntime runtime, String serviceId)

Method Summary

Modifier and Type	Method	Description
protected void	afterProcessWorkUnit(LuceneService.WorkUnit unit)
Optional<Path>	backupToArchive()
protected void	beforeProcessWorkUnit(LuceneService.WorkUnit unit)
private void	closeIndex()
void	commit()
LuceneService.CommitData	getLiveCommitData()
protected static Path	getWorkPath(String indexDir)
boolean	isWriterOpen()
private void	openIndex()
<T> com.google.common.util.concurrent.ListenableFuture<T>	process(Function<LuceneService.LuceneContext,T> func)
protected Object	processWorkUnit(LuceneService.WorkUnit unit)
private void	refreshReader()
boolean	restoreFromArchive(Path archive)
void	setExtendedCommitData(String key, String value)
protected void	shutDown()
protected void	startUp()

Methods inherited from class ch.rswk.meta.engine.AbstractEngineWorkQueueService

getCapacityThreshold, getRemainingCapacity, offerWorkUnit, run, serviceName, triggerShutdown

Methods inherited from class ch.rswk.meta.engine.AbstractEngineExecutionThreadService

configClass, configReference

Methods inherited from class com.google.common.util.concurrent.AbstractExecutionThreadService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.rswk.meta.engine.EngineServices.ConfigurableService

config, onConfigChanged

Methods inherited from interface ch.rswk.meta.engine.EngineServices.InfoProvidingService

getServiceInfo

Field Details

COMMIT_SCHEDULE

private static final int COMMIT_SCHEDULE

See Also:

• Constant Field Values

COMMIT_SEQUENCE_NUMBER_KEY

private static final String COMMIT_SEQUENCE_NUMBER_KEY

See Also:

• Constant Field Values

COMMIT_TIMESTAMP_KEY

private static final String COMMIT_TIMESTAMP_KEY

See Also:

• Constant Field Values

QUEUE_CAPACITY

private static final int QUEUE_CAPACITY

See Also:

• Constant Field Values

QUEUE_OFFER_TIMEOUT

private static final int QUEUE_OFFER_TIMEOUT

See Also:

• Constant Field Values

WORK_DIR

private static final String WORK_DIR

See Also:

• Constant Field Values

WRITE_LOCK_FILE

private static final String WRITE_LOCK_FILE

See Also:

• Constant Field Values

extendedCommitData

private final Map<String,String> extendedCommitData

indexMonitor

private final com.google.common.util.concurrent.Monitor indexMonitor

log

private final org.slf4j.Logger log

luceneContext

private final LuceneService.LuceneContext luceneContext

writeFlag

private final AtomicBoolean writeFlag

analyzer

private org.apache.lucene.analysis.Analyzer analyzer

commitHandle

private ScheduledFuture<?> commitHandle

commitTimer

private com.codahale.metrics.Timer commitTimer

directory

private org.apache.lucene.store.FSDirectory directory

refreshTimer

private com.codahale.metrics.Timer refreshTimer

searcher

private org.apache.lucene.search.IndexSearcher searcher

writer

private org.apache.lucene.index.IndexWriter writer

Constructor Details

LuceneService

public LuceneService(LuceneService.LuceneServiceConfig config,
 EngineRuntime runtime,
 String serviceId)

Method Details

startUp

protected void startUp()
                throws Exception

Overrides:

startUp in class AbstractEngineWorkQueueService<LuceneService.LuceneServiceConfig,LuceneService.WorkUnit,Object>

Throws:

Exception

openIndex

private void openIndex()
                throws IOException

Throws:

IOException

getWorkPath

protected static Path getWorkPath(String indexDir)

shutDown

protected void shutDown()
                 throws Exception

Overrides:

shutDown in class AbstractEngineExecutionThreadService<LuceneService.LuceneServiceConfig>

Throws:

Exception

closeIndex

private void closeIndex()
                 throws IOException

Throws:

IOException

isWriterOpen

public boolean isWriterOpen()

getLiveCommitData

public LuceneService.CommitData getLiveCommitData()

backupToArchive

public Optional<Path> backupToArchive()

setExtendedCommitData

public void setExtendedCommitData(String key,
 String value)

commit

public void commit()

restoreFromArchive

public boolean restoreFromArchive(Path archive)

process

public <T>
com.google.common.util.concurrent.ListenableFuture<T> process(Function<LuceneService.LuceneContext,T> func)

beforeProcessWorkUnit

protected void beforeProcessWorkUnit(LuceneService.WorkUnit unit)

Overrides:

beforeProcessWorkUnit in class AbstractEngineWorkQueueService<LuceneService.LuceneServiceConfig,LuceneService.WorkUnit,Object>

processWorkUnit

protected Object processWorkUnit(LuceneService.WorkUnit unit)

Specified by:

processWorkUnit in class AbstractEngineWorkQueueService<LuceneService.LuceneServiceConfig,LuceneService.WorkUnit,Object>

refreshReader

private void refreshReader()

afterProcessWorkUnit

protected void afterProcessWorkUnit(LuceneService.WorkUnit unit)

Overrides:

afterProcessWorkUnit in class AbstractEngineWorkQueueService<LuceneService.LuceneServiceConfig,LuceneService.WorkUnit,Object>