Package com.atlassian.confluence.plugins.opensearch

Class OpenSearchCustomSearchIndexRegistry

java.lang.Object

com.atlassian.confluence.plugins.opensearch.OpenSearchCustomSearchIndexRegistry

All Implemented Interfaces:

CustomSearchIndexRegistry

public class OpenSearchCustomSearchIndexRegistry
extends Object
implements CustomSearchIndexRegistry

Since:

8.6

Constructor Summary

Constructors

Constructor	Description
OpenSearchCustomSearchIndexRegistry(OpenSearchSearchIndexAccessorFactory openSearchSearchIndexAccessorFactory, OpenSearchIndexManagerFactory indexManagerFactory)

Method Summary

Modifier and Type	Method	Description
SearchIndexAccessor	add(String name, @Nullable AnalyzerDescriptorProvider analyzerDescriptorProvider)	This method can be called multiple times but a new SearchIndexAccessor instance will be created only once for the first call.
SearchIndexAccessor	get(String name)	This method returns the SearchIndexAccessor corresponding to the index represented by its unique name.
void	remove(String name)	Remove the custom index from the registry.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchCustomSearchIndexRegistry

public OpenSearchCustomSearchIndexRegistry(OpenSearchSearchIndexAccessorFactory openSearchSearchIndexAccessorFactory,
 OpenSearchIndexManagerFactory indexManagerFactory)

Method Details

add

public SearchIndexAccessor add(String name,
 @Nullable AnalyzerDescriptorProvider analyzerDescriptorProvider)
                        throws SearchIndexAccessException

Description copied from interface: CustomSearchIndexRegistry

This method can be called multiple times but a new SearchIndexAccessor instance will be created only once for the first call. The same instance will be returned by subsequent calls to the method with the same name.

It is highly recommended that the name is prefixed with the plugin key to avoid naming conflicts and/or unintentionally sharing indexes with another plugin.

Specified by:

add in interface CustomSearchIndexRegistry

Parameters:

name - the unique name of the custom index. The name should have a plugin key as its prefix to avoid naming conflicts.

analyzerDescriptorProvider - provider for a MappingAnalyzerDescriptor representing a Lucene Analyzer, or null if KeywordAnalyzer is used.

Returns:

a SearchIndexAccessor that can access to this custom index.

Throws:

SearchIndexAccessException

get

public SearchIndexAccessor get(String name)
                        throws SearchIndexAccessException

Description copied from interface: CustomSearchIndexRegistry

This method returns the SearchIndexAccessor corresponding to the index represented by its unique name.

Specified by:

get in interface CustomSearchIndexRegistry

Parameters:

name - the name of the custom index

Returns:

a SearchIndexAccessor that can access to this custom index

Throws:

SearchIndexAccessException - if the custom search index does not exist

remove

public void remove(String name)
            throws SearchIndexAccessException

Description copied from interface: CustomSearchIndexRegistry

Remove the custom index from the registry. The internal lucene connection will be also closed.

Specified by:

remove in interface CustomSearchIndexRegistry

Parameters:

name - the name of the custom index

Throws:

SearchIndexAccessException - if the custom search index does not exist