com.atlassian.confluence.search.elasticsearch.tasks

Class AbstractESTask

java.lang.Object

com.atlassian.confluence.search.elasticsearch.tasks.AbstractESTask

All Implemented Interfaces:

ConvertibleToJournalEntry, ESTask, IndexTask

Direct Known Subclasses:

ESIndexAllChangesTask, ESIndexChangeTask, ESIndexIncludingChangesTask, ESIndexIncludingDependantsTask, ESIndexTask

@Internal
public abstract class AbstractESTask
extends Object
implements ESTask

Abstract base class for ES tasks.

Since:

5.9.

Field Summary

Fields

Modifier and Type	Field and Description
protected ESDocumentBuilder	documentBuilder
protected long	order
protected Supplier<com.atlassian.bonnie.Searchable>	searchableSupplier

Constructor Summary

Constructors

Constructor and Description
AbstractESTask(Supplier<com.atlassian.bonnie.Searchable> searchableSupplier, ESDocumentBuilder documentBuilder)

Method Summary

Modifier and Type	Method and Description
Optional<JournalEntry>	convertToJournalEntry(JournalIdentifier journalId) Convert to journal entry.
boolean	equals(Object o)
protected abstract JournalEntryType	getJournalEntryType()
long	getOrder()
int	hashCode()
abstract void	innerPerform(com.atlassian.bonnie.Searchable searchable, ESIndexRequestProcessor processor)
ESTask	order(long order) Set order of the task used for optimistic concurrency control
void	perform(ESIndexRequestProcessor processor) Perform this task with the specified ES Task processor.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.search.IndexTask

getDescription

Field Detail

searchableSupplier

protected final Supplier<com.atlassian.bonnie.Searchable> searchableSupplier

documentBuilder

protected final ESDocumentBuilder documentBuilder

order

protected long order

Constructor Detail

AbstractESTask

public AbstractESTask(Supplier<com.atlassian.bonnie.Searchable> searchableSupplier,
                      ESDocumentBuilder documentBuilder)

Method Detail

innerPerform

public abstract void innerPerform(@Nonnull
                                  com.atlassian.bonnie.Searchable searchable,
                                  ESIndexRequestProcessor processor)

getJournalEntryType

protected abstract JournalEntryType getJournalEntryType()

convertToJournalEntry

public Optional<JournalEntry> convertToJournalEntry(JournalIdentifier journalId)

Description copied from interface: ConvertibleToJournalEntry

Convert to journal entry.

Specified by:

convertToJournalEntry in interface ConvertibleToJournalEntry

Parameters:

journalId - journal identifier

Returns:

an optional containing a journal entry or empty if this cannot be converted.

perform

public final void perform(ESIndexRequestProcessor processor)

Description copied from interface: ESTask

Perform this task with the specified ES Task processor.

Specified by:

perform in interface ESTask

Parameters:

processor - a bulk processor

order

public ESTask order(long order)

Description copied from interface: ESTask

Set order of the task used for optimistic concurrency control

Specified by:

order in interface ESTask

Parameters:

order - a monotonic increasing order of the task

Returns:

this task

getOrder

public long getOrder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object