com.atlassian.confluence.index

Interface ReIndexer

All Known Implementing Classes:

LuceneReIndexer

Deprecated.

since 7.10 - use IndexManager.reIndex(), class will be made unavailable from public API in next 8.x release

@Deprecated
public interface ReIndexer

Responsible for triggering re-indexing / rebuilding of the Confluence search index.

Warning: Client code should use IndexManager.reIndex() instead of this class, because it will ensure proper locking is in place. Calling ReIndexer directly can result to races with other index operations.

Method Summary

Modifier and Type	Method and Description
void	reIndex(EnumSet<ReIndexOption> options, Progress progress) Deprecated. Triggers a system wide re-index all entities from the database.
void	reIndex(EnumSet<ReIndexOption> options, @NonNull SearchQuery searchQuery, Progress progress) Deprecated. Triggers a system wide re-index re-index all entities loaded from searchQuery.
default void	reIndex(Progress progress) Deprecated. Triggers a system wide re-index.
void	reIndex(ReIndexSpec spec, Progress progress) Deprecated. Trigger reindex large amount of content entities accoding to the given specification.
default void	reIndex(Set<ReIndexOption> options, Progress progress) Deprecated. since 5.10. Use reIndex(EnumSet, Progress) instead.
default void	reIndex(Set<ReIndexOption> options, SearchQuery searchQuery, Progress progress) Deprecated. since 5.10. Use reIndex(EnumSet, SearchQuery, Progress) instead.

Method Detail

reIndex

default void reIndex(Progress progress)

Deprecated.

Triggers a system wide re-index.

Parameters:

progress - object to track progress of re-index.

reIndex

@Deprecated
default void reIndex(Set<ReIndexOption> options,
                                 Progress progress)

Deprecated. since 5.10. Use reIndex(EnumSet, Progress) instead.

reIndex

@Deprecated
default void reIndex(Set<ReIndexOption> options,
                                 SearchQuery searchQuery,
                                 Progress progress)

Deprecated. since 5.10. Use reIndex(EnumSet, SearchQuery, Progress) instead.

reIndex

void reIndex(EnumSet<ReIndexOption> options,
             Progress progress)

Deprecated.

Triggers a system wide re-index all entities from the database.

Parameters:

options - Optional. Allows a subset of all searchable content to be re-indexed.

progress - object to track progress of re-index.

reIndex

void reIndex(EnumSet<ReIndexOption> options,
             @NonNull SearchQuery searchQuery,
             Progress progress)

Deprecated.

Triggers a system wide re-index re-index all entities loaded from searchQuery.

Parameters:

options - Optional. Allows a subset of all searchable content to be re-indexed.

searchQuery - A query that may be used to load the entities to be re-indexed.

progress - object to track progress of re-index.

reIndex

@ExperimentalApi
void reIndex(ReIndexSpec spec,
                              Progress progress)

Deprecated.

Trigger reindex large amount of content entities accoding to the given specification.

Parameters:

spec -

progress -

Since:

7.0