Package com.atlassian.confluence.plugins.opensearch

Class SearchTokenTracker

java.lang.Object

com.atlassian.confluence.plugins.opensearch.SearchTokenTracker

@ParametersAreNonnullByDefault
public class SearchTokenTracker
extends Object

Tracks search tokens in memory, and associates them with the corresponding OpenSearch PIT (Point in Time) id. The implementation replicates the existing Lucene implementation: MultiReaderBasedConnection

Since:

9.0

Constructor Summary

Constructors

Constructor	Description
SearchTokenTracker(OpenSearchConfig config)

Method Summary

Modifier and Type	Method	Description
SearchWithToken	createToken(ISearch search, @Nullable String pit)	Creates a new SearchWithToken for the provided search and PIT
@Nullable String	getPitId(SearchWithToken searchWithToken)	Resolves the PIT id for the given SearchWithToken

Methods inherited from class java.lang.Object

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

Constructor Details

SearchTokenTracker

public SearchTokenTracker(OpenSearchConfig config)

Method Details

createToken

public SearchWithToken createToken(ISearch search,
 @Nullable String pit)

Creates a new SearchWithToken for the provided search and PIT

Parameters:

search -

pit - OpenSearch PIT id (optional)

Returns:

a new SearchWithToken for the provided search and PIT

getPitId

public @Nullable String getPitId(SearchWithToken searchWithToken)
                          throws SearchTokenExpiredException

Resolves the PIT id for the given SearchWithToken

Parameters:

searchWithToken -

Returns:

the associated PIT for the token, or null if token is undefined i.e. SearchWithToken.TOKEN_UNDEFINED

Throws:

SearchTokenExpiredException - if the provided token has expired