com.atlassian.jira.sharing.index

Class DefaultSharedEntityIndexer

java.lang.Object

com.atlassian.jira.sharing.index.DefaultSharedEntityIndexer

All Implemented Interfaces:

SharedEntityIndexer

public class DefaultSharedEntityIndexer
extends Object
implements SharedEntityIndexer

default implementation

Since:

v3.13

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultSharedEntityIndexer.EntityDocument Holds a Document and an identifying Term so we can delete any pre-existing document.
static interface	DefaultSharedEntityIndexer.EntityDocumentFactory

Field Summary

Fields

Modifier and Type	Field and Description
static Index.Manager	NULL_MANAGER used only when closing and shutting down so we don't create stray index directories

Constructor Summary

Constructors

Constructor and Description
DefaultSharedEntityIndexer(ShareTypeFactory shareTypeFactory, SharedEntitySearchContextToQueryFactoryMap searchContextToQueryFactoryMap, SharedEntityAccessor.Factory accessorFactory, DirectoryFactory directoryFactory, UserManager userManager, ReplicatedIndexManager replicatedIndexManager, ApplicationProperties applicationProperties, IndexBackupContributionStrategy backupPreparationStrategy)

Method Summary

Modifier and Type	Method and Description
String	clear(SharedEntity.TypeDescriptor<?> type) Clear a particular type's index.
void	contributeToSnapshot(SharedEntity.TypeDescriptor<? extends SharedEntity> entityType, BackupBuilder backupBuilder) Contribute a set of files that represent shared entity index of entityType to the given backupBuilder to include them in the backup being created when this method was called.
Index.Result	deIndex(Set<SharedEntity> sharedEntities, boolean shouldReplicate) Delete multiple documents in the index
Index.Result	deIndex(SharedEntity entity) Delete a document from the index.
Collection<String>	getAllIndexPaths()
Index.Result	index(Set<SharedEntity> sharedEntities, boolean shouldReplicate) Add or update multiple documents in the index
Index.Result	index(SharedEntity entity) Add or update a document in the index.
Index.Result	index(SharedEntity entity, boolean shouldReplicate) Add or update a document in the index.
long	optimize(SharedEntity.TypeDescriptor<?> type) Optimize a particular type's index.
void	recreate(SharedEntity.TypeDescriptor<?> type) Recreate the index.
void	shutdown(SharedEntity.TypeDescriptor<?> type) Shutdown a particular type's index.
<S extends SharedEntity> SharedEntitySearchResult<S>	withSearcher(SharedEntity.TypeDescriptor<S> type, java.util.function.Function<SharedEntitySearcher<S>,SharedEntitySearchResult<S>> searcherOperation)

Methods inherited from class java.lang.Object

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

Field Detail

NULL_MANAGER

public static final Index.Manager NULL_MANAGER

used only when closing and shutting down so we don't create stray index directories

Constructor Detail

DefaultSharedEntityIndexer

public DefaultSharedEntityIndexer(ShareTypeFactory shareTypeFactory,
                                  SharedEntitySearchContextToQueryFactoryMap searchContextToQueryFactoryMap,
                                  SharedEntityAccessor.Factory accessorFactory,
                                  DirectoryFactory directoryFactory,
                                  UserManager userManager,
                                  ReplicatedIndexManager replicatedIndexManager,
                                  ApplicationProperties applicationProperties,
                                  IndexBackupContributionStrategy backupPreparationStrategy)

Method Detail

index

public Index.Result index(SharedEntity entity)

Description copied from interface: SharedEntityIndexer

Add or update a document in the index.

Specified by:

index in interface SharedEntityIndexer

Parameters:

entity - the entity to add to the index

deIndex

public Index.Result deIndex(SharedEntity entity)

Description copied from interface: SharedEntityIndexer

Delete a document from the index.

Specified by:

deIndex in interface SharedEntityIndexer

Parameters:

entity - the entity to remove from the index

index

public Index.Result index(SharedEntity entity,
                          boolean shouldReplicate)

Description copied from interface: SharedEntityIndexer

Add or update a document in the index.

Specified by:

index in interface SharedEntityIndexer

Parameters:

entity - the entity to add to the index

shouldReplicate - whether or not the index changes should be replicated to the other nodes in the cluster.

index

public Index.Result index(Set<SharedEntity> sharedEntities,
                          boolean shouldReplicate)

Description copied from interface: SharedEntityIndexer

Add or update multiple documents in the index

Specified by:

index in interface SharedEntityIndexer

Parameters:

sharedEntities - a Set of entities to add to the index

shouldReplicate - whether or not the index changes should be replicated to the other nodes in the cluster.

deIndex

public Index.Result deIndex(Set<SharedEntity> sharedEntities,
                            boolean shouldReplicate)

Description copied from interface: SharedEntityIndexer

Delete multiple documents in the index

Specified by:

deIndex in interface SharedEntityIndexer

Parameters:

sharedEntities - a Set of entities to remove from the index

shouldReplicate - whether or not the index changes should be replicated to the other nodes in the cluster.

withSearcher

public <S extends SharedEntity> SharedEntitySearchResult<S> withSearcher(SharedEntity.TypeDescriptor<S> type,
                                                                         java.util.function.Function<SharedEntitySearcher<S>,SharedEntitySearchResult<S>> searcherOperation)

Specified by:

withSearcher in interface SharedEntityIndexer

optimize

public long optimize(SharedEntity.TypeDescriptor<?> type)

Description copied from interface: SharedEntityIndexer

Optimize a particular type's index.

Specified by:

optimize in interface SharedEntityIndexer

Parameters:

type - describes the particular index

Returns:

the number of milliseconds taken to optimize

clear

public String clear(SharedEntity.TypeDescriptor<?> type)

Description copied from interface: SharedEntityIndexer

Clear a particular type's index. Return the path.

Specified by:

clear in interface SharedEntityIndexer

Parameters:

type - describes the particular index

recreate

public void recreate(SharedEntity.TypeDescriptor<?> type)

Description copied from interface: SharedEntityIndexer

Recreate the index. Clear it if it currently exists, create a new one if it doesn't.

Specified by:

recreate in interface SharedEntityIndexer

contributeToSnapshot

public void contributeToSnapshot(SharedEntity.TypeDescriptor<? extends SharedEntity> entityType,
                                 BackupBuilder backupBuilder)

Description copied from interface: SharedEntityIndexer

Contribute a set of files that represent shared entity index of entityType to the given backupBuilder to include them in the backup being created when this method was called.

Specified by:

contributeToSnapshot in interface SharedEntityIndexer

Parameters:

entityType - type of SharedEntity index to be added to the snapshot

backupBuilder - temporary(reference should not be stored) builder of backup file. All existing and nonempty files passed to it's accept method will be included in archive being created during the call.

shutdown

public void shutdown(SharedEntity.TypeDescriptor<?> type)

Description copied from interface: SharedEntityIndexer

Shutdown a particular type's index.

Specified by:

shutdown in interface SharedEntityIndexer

Parameters:

type - describes the particular index

getAllIndexPaths

public Collection<String> getAllIndexPaths()

Specified by:

getAllIndexPaths in interface SharedEntityIndexer

Returns:

all the paths where the indexes are