Class WebSocketSearchClient

java.lang.Object

io.fluxzero.sdk.common.websocket.AbstractWebsocketClient

io.fluxzero.sdk.persisting.search.client.WebSocketSearchClient

All Implemented Interfaces:

WebsocketEndpoint, SearchClient, AutoCloseable

public class WebSocketSearchClient
extends AbstractWebsocketClient
implements SearchClient

WebSocket-based implementation of the SearchClient that connects to the Fluxzero Runtime.

All operations (indexing, searching, deletion, statistics, etc.) are executed via a WebSocket protocol using a standardized API. This is the default production implementation used in deployed applications.

Requires an active connection to the Fluxzero Runtime's search module.

See Also:

• WebSocketClient

Nested Class Summary

Nested classes/interfaces inherited from class AbstractWebsocketClient

AbstractWebsocketClient.ClientHandshakeConfigurator, AbstractWebsocketClient.ConnectionSetup, AbstractWebsocketClient.PingRegistration, AbstractWebsocketClient.PreparedRequest<R>, AbstractWebsocketClient.WebSocketRequest

Nested classes/interfaces inherited from interface WebsocketEndpoint

WebsocketEndpoint.ReceiveTiming

Field Summary

Fields inherited from class AbstractWebsocketClient

CLIENT_HANDSHAKE_CONFIGURATOR_USER_PROPERTY, CLIENT_SESSION_ID_USER_PROPERTY, CONNECTION_RETRY_LOG_INTERVAL, CONNECTION_TIMEOUT_FAILSAFE_GRACE, defaultObjectMapper, defaultWebsocketConnector, NEGOTIATED_SESSION_ID_USER_PROPERTY, RUNTIME_SESSION_ID_USER_PROPERTY, RUNTIME_VERSION_USER_PROPERTY, SELECTED_COMPRESSION_ALGORITHM_USER_PROPERTY, SELECTED_TRANSPORT_FORMAT_USER_PROPERTY

Constructor Summary

Constructors

Constructor	Description
WebSocketSearchClient(String endPointUrl, WebSocketClient client)
WebSocketSearchClient(URI endpointUri, WebSocketClient client)
WebSocketSearchClient(URI endpointUri, WebSocketClient client, boolean sendMetrics)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	adoptModelMigration(io.fluxzero.common.api.search.AdoptModelMigration request)	Atomically adopts a previously inspected and application-verified staged Model document while retaining the accepted normalized source until an ordinary Model write ends legacy-write coexistence.
CompletableFuture<Void>	bulkUpdate(Collection<io.fluxzero.common.api.search.DocumentUpdate> batch, io.fluxzero.common.Guarantee guarantee)	Performs a batch update on a set of documents.
CompletableFuture<Void>	createAuditTrail(io.fluxzero.common.api.search.CreateAuditTrail request)	Configures Fluxzero to use a search collection as a searchable audit trail.
CompletableFuture<Void>	delete(io.fluxzero.common.api.search.SearchQuery query, io.fluxzero.common.Guarantee guarantee, int batchSize)	Deletes documents matching a given query using the requested batch size.
CompletableFuture<Void>	delete(String documentId, String collection, io.fluxzero.common.Guarantee guarantee)	Deletes a document by its unique id and collection name.
CompletableFuture<Void>	deleteCollection(String collection, io.fluxzero.common.Guarantee guarantee)	Deletes an entire document collection and all its contents.
boolean	documentExists(io.fluxzero.common.api.search.HasDocument request)	Checks whether a document with the given criteria exists.
Optional<io.fluxzero.common.api.search.SerializedDocument>	fetch(io.fluxzero.common.api.search.GetDocument request)	Fetches a single serialized document matching the given request.
Collection<io.fluxzero.common.api.search.SerializedDocument>	fetch(io.fluxzero.common.api.search.GetDocuments request)	Fetches a collection of serialized documents that match the given request.
List<io.fluxzero.common.api.search.FacetStats>	fetchFacetStats(io.fluxzero.common.api.search.SearchQuery query)	Retrieves facet statistics (i.e., value counts) for a given query.
CompletableFuture<List<io.fluxzero.common.api.search.FacetStats>>	fetchFacetStatsAsync(io.fluxzero.common.api.search.SearchQuery query)	Asynchronously retrieves facet statistics for a given query.
io.fluxzero.common.api.search.SearchHistogram	fetchHistogram(io.fluxzero.common.api.search.GetSearchHistogram request)	Fetches a histogram (bucketed time-series view) for documents matching the query.
CompletableFuture<io.fluxzero.common.api.search.SearchHistogram>	fetchHistogramAsync(io.fluxzero.common.api.search.GetSearchHistogram request)	Asynchronously fetches a histogram for documents matching the query.
io.fluxzero.common.api.search.GetDocumentResult	fetchModelDocument(io.fluxzero.common.api.search.GetDocument request)	Fetches a direct Model document together with the durable head written by the same materialization transaction.
List<io.fluxzero.common.api.search.DocumentStats>	fetchStatistics(io.fluxzero.common.api.search.SearchQuery query, List<String> fields, List<String> groupBy)	Retrieves search statistics (counts, averages, etc.) over matching documents.
CompletableFuture<List<io.fluxzero.common.api.search.DocumentStats>>	fetchStatisticsAsync(io.fluxzero.common.api.search.SearchQuery query, List<String> fields, List<String> groupBy)	Asynchronously retrieves search statistics over matching documents.
io.fluxzero.common.api.search.GetModelMigrationResult	getModelMigration(io.fluxzero.common.api.search.GetModelMigration request)	Retrieves the production and staged direct documents used to verify one Model migration.
io.fluxzero.common.api.search.GetModelMigrationsResult	getModelMigrations(io.fluxzero.common.api.search.GetModelMigrations request)	Retrieves a bounded batch of staged direct Model migrations.
List<io.fluxzero.common.api.search.SearchCollection>	getSearchCollections()	Retrieves existing regular search collections and audit trails.
CompletableFuture<Void>	index(List<io.fluxzero.common.api.search.SerializedDocument> documents, io.fluxzero.common.Guarantee guarantee, boolean ifNotExists)	Indexes a list of serialized documents into the search engine.
CompletableFuture<Void>	move(io.fluxzero.common.api.search.SearchQuery query, String targetCollection, io.fluxzero.common.Guarantee guarantee)	Moves documents matching a given query to the given target collection.
CompletableFuture<Void>	move(String documentId, String collection, String targetCollection, io.fluxzero.common.Guarantee guarantee)	Moves a document to another collection.
CompletableFuture<Void>	rewriteModelGraphDocument(io.fluxzero.common.api.search.SerializedDocument document, String expectedManifest, io.fluxzero.common.Guarantee guarantee)	Conditionally replaces one materialized model-graph document while its manifest still matches the handled version.
Stream<SearchHit<io.fluxzero.common.api.search.SerializedDocument>>	search(io.fluxzero.common.api.search.SearchDocuments searchDocuments, int fetchSize)	Executes a streaming search query using the given criteria and fetch size.
CompletableFuture<List<SearchHit<io.fluxzero.common.api.search.SerializedDocument>>>	searchAsync(io.fluxzero.common.api.search.SearchDocuments searchDocuments, int fetchSize)	Asynchronously executes a search query using the given criteria and fetch size and materializes the matching hits.
Stream<SearchHit<io.fluxzero.common.api.search.SerializedDocument>>	searchModelGraph(io.fluxzero.common.api.search.SearchModelGraphDocuments searchDocuments, int fetchSize)	Executes a current-state model search and composes each matching root's explicitly placed child graph.
CompletableFuture<List<SearchHit<io.fluxzero.common.api.search.SerializedDocument>>>	searchModelGraphAsync(io.fluxzero.common.api.search.SearchModelGraphDocuments searchDocuments, int fetchSize)	Asynchronously searches and composes current independent-model graphs.
Stream<SearchHit<io.fluxzero.common.api.search.SerializedDocument>>	searchModels(io.fluxzero.common.api.search.SearchModelDocuments searchDocuments, int fetchSize)	Executes a bounded current-state search across independent model relationships.
CompletableFuture<List<SearchHit<io.fluxzero.common.api.search.SerializedDocument>>>	searchModelsAsync(io.fluxzero.common.api.search.SearchModelDocuments searchDocuments, int fetchSize)	Asynchronously executes a bounded current-state search across independent model relationships.

Methods inherited from class AbstractWebsocketClient

abort, captureReceiveTiming, close, close, connectToServer, connectToServer, createConnectionRetryConfiguration, createConnectionSetup, createConnectionSetup, getCloseHandshakeTimeout, getCompressionAlgorithm, getConnectionTimeoutFailsafeGrace, getNegotiatedSessionId, getRuntimeVersion, getTransportFormat, handleClose, handleError, handleMessage, handlePong, handleResult, handleResult, jfrResultType, logConnectionRetryStatus, logSuccessfulReconnect, maxRequestBatchSize, metricsMetadata, nextReconnectJitter, onClose, onError, onMessage, onMessage, onOpen, onPong, outstandingRequest, payloadCodecs, prepareRequest, prepareRequest, prepareResults, restoreResultContext, restoreResultContext, retryOutstandingRequests, retryOutstandingRequestsAsync, retryOutstandingRequestsDelay, schedulePing, send, send, sendAndWait, sendCommand, sendPing, sendPreparedRequests, startRequestBatchEvent, toString, transportCodec, transportMetricPublicationTimeout, tryPublishMetrics

Methods inherited from class Object

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

Methods inherited from interface SearchClient

close, delete, deleteCollection

Constructor Details

WebSocketSearchClient

public WebSocketSearchClient(String endPointUrl,
 WebSocketClient client)

WebSocketSearchClient

public WebSocketSearchClient(URI endpointUri,
 WebSocketClient client)

WebSocketSearchClient

public WebSocketSearchClient(URI endpointUri,
 WebSocketClient client,
 boolean sendMetrics)

Method Details

getSearchCollections

public List<io.fluxzero.common.api.search.SearchCollection> getSearchCollections()

Description copied from interface: SearchClient

Retrieves existing regular search collections and audit trails.

Implementations predating this operation may throw UnsupportedOperationException.

Specified by:

getSearchCollections in interface SearchClient

Returns:

the available collections with their storage types, in deterministic order

index

public CompletableFuture<Void> index(List<io.fluxzero.common.api.search.SerializedDocument> documents,
 io.fluxzero.common.Guarantee guarantee,
 boolean ifNotExists)

Description copied from interface: SearchClient

Indexes a list of serialized documents into the search engine.

Specified by:

index in interface SearchClient

Parameters:

documents - the documents to index

guarantee - delivery guarantee (see Guarantee)

ifNotExists - if true, only index documents that do not already exist

Returns:

a future that completes when the operation is done

rewriteModelGraphDocument

public CompletableFuture<Void> rewriteModelGraphDocument(io.fluxzero.common.api.search.SerializedDocument document,
 String expectedManifest,
 io.fluxzero.common.Guarantee guarantee)

Description copied from interface: SearchClient

Conditionally replaces one materialized model-graph document while its manifest still matches the handled version. Implementations without durable model-graph projections may retain the unsupported default.

Specified by:

rewriteModelGraphDocument in interface SearchClient

bulkUpdate

public CompletableFuture<Void> bulkUpdate(Collection<io.fluxzero.common.api.search.DocumentUpdate> batch,
 io.fluxzero.common.Guarantee guarantee)

Description copied from interface: SearchClient

Performs a batch update on a set of documents.

Specified by:

bulkUpdate in interface SearchClient

Parameters:

batch - the update operations to perform

guarantee - delivery guarantee

Returns:

a future that completes when the updates have been applied

search

public Stream<SearchHit<io.fluxzero.common.api.search.SerializedDocument>> search(io.fluxzero.common.api.search.SearchDocuments searchDocuments,
 int fetchSize)

Description copied from interface: SearchClient

Executes a streaming search query using the given criteria and fetch size.

Specified by:

search in interface SearchClient

Parameters:

searchDocuments - the search parameters and query

fetchSize - the number of results to fetch per page

Returns:

a stream of search hits matching the query

searchAsync

public CompletableFuture<List<SearchHit<io.fluxzero.common.api.search.SerializedDocument>>> searchAsync(io.fluxzero.common.api.search.SearchDocuments searchDocuments,
 int fetchSize)

Description copied from interface: SearchClient

Asynchronously executes a search query using the given criteria and fetch size and materializes the matching hits.

The default implementation adapts SearchClient.search(SearchDocuments, int) to a future. Remote clients can override this method to use a native asynchronous transport.

Specified by:

searchAsync in interface SearchClient

Parameters:

searchDocuments - the search parameters and query

fetchSize - the number of results to fetch per page

Returns:

a future with search hits matching the query

searchModels

public Stream<SearchHit<io.fluxzero.common.api.search.SerializedDocument>> searchModels(io.fluxzero.common.api.search.SearchModelDocuments searchDocuments,
 int fetchSize)

Description copied from interface: SearchClient

Executes a bounded current-state search across independent model relationships.

Specified by:

searchModels in interface SearchClient

searchModelsAsync

public CompletableFuture<List<SearchHit<io.fluxzero.common.api.search.SerializedDocument>>> searchModelsAsync(io.fluxzero.common.api.search.SearchModelDocuments searchDocuments,
 int fetchSize)

Description copied from interface: SearchClient

Asynchronously executes a bounded current-state search across independent model relationships.

Specified by:

searchModelsAsync in interface SearchClient

searchModelGraph

public Stream<SearchHit<io.fluxzero.common.api.search.SerializedDocument>> searchModelGraph(io.fluxzero.common.api.search.SearchModelGraphDocuments searchDocuments,
 int fetchSize)

Description copied from interface: SearchClient

Executes a current-state model search and composes each matching root's explicitly placed child graph.

Specified by:

searchModelGraph in interface SearchClient

searchModelGraphAsync

public CompletableFuture<List<SearchHit<io.fluxzero.common.api.search.SerializedDocument>>> searchModelGraphAsync(io.fluxzero.common.api.search.SearchModelGraphDocuments searchDocuments,
 int fetchSize)

Description copied from interface: SearchClient

Asynchronously searches and composes current independent-model graphs.

Specified by:

searchModelGraphAsync in interface SearchClient

documentExists

public boolean documentExists(io.fluxzero.common.api.search.HasDocument request)

Description copied from interface: SearchClient

Checks whether a document with the given criteria exists.

Specified by:

documentExists in interface SearchClient

Parameters:

request - an object describing the document (e.g., id and collection)

Returns:

true if the document exists, false otherwise

fetch

public Optional<io.fluxzero.common.api.search.SerializedDocument> fetch(io.fluxzero.common.api.search.GetDocument request)

Description copied from interface: SearchClient

Fetches a single serialized document matching the given request.

Specified by:

fetch in interface SearchClient

Parameters:

request - an object describing the document to retrieve

Returns:

an optional containing the document, if found

fetchModelDocument

public io.fluxzero.common.api.search.GetDocumentResult fetchModelDocument(io.fluxzero.common.api.search.GetDocument request)

Description copied from interface: SearchClient

Fetches a direct Model document together with the durable head written by the same materialization transaction.

Specified by:

fetchModelDocument in interface SearchClient

getModelMigration

public io.fluxzero.common.api.search.GetModelMigrationResult getModelMigration(io.fluxzero.common.api.search.GetModelMigration request)

Description copied from interface: SearchClient

Retrieves the production and staged direct documents used to verify one Model migration.

Specified by:

getModelMigration in interface SearchClient

getModelMigrations

public io.fluxzero.common.api.search.GetModelMigrationsResult getModelMigrations(io.fluxzero.common.api.search.GetModelMigrations request)

Description copied from interface: SearchClient

Retrieves a bounded batch of staged direct Model migrations.

Specified by:

getModelMigrations in interface SearchClient

adoptModelMigration

public CompletableFuture<Void> adoptModelMigration(io.fluxzero.common.api.search.AdoptModelMigration request)

Description copied from interface: SearchClient

Atomically adopts a previously inspected and application-verified staged Model document while retaining the accepted normalized source until an ordinary Model write ends legacy-write coexistence.

Specified by:

adoptModelMigration in interface SearchClient

fetch

public Collection<io.fluxzero.common.api.search.SerializedDocument> fetch(io.fluxzero.common.api.search.GetDocuments request)

Description copied from interface: SearchClient

Fetches a collection of serialized documents that match the given request.

Specified by:

fetch in interface SearchClient

Parameters:

request - an object describing the documents to retrieve

Returns:

a collection of retrieved documents matching

fetchStatistics

public List<io.fluxzero.common.api.search.DocumentStats> fetchStatistics(io.fluxzero.common.api.search.SearchQuery query,
 List<String> fields,
 List<String> groupBy)

Description copied from interface: SearchClient

Retrieves search statistics (counts, averages, etc.) over matching documents.

Specified by:

fetchStatistics in interface SearchClient

Parameters:

query - the query to filter documents

fields - the fields to compute statistics for

groupBy - field names used to group statistics

Returns:

a list of DocumentStats

fetchStatisticsAsync

public CompletableFuture<List<io.fluxzero.common.api.search.DocumentStats>> fetchStatisticsAsync(io.fluxzero.common.api.search.SearchQuery query,
 List<String> fields,
 List<String> groupBy)

Description copied from interface: SearchClient

Asynchronously retrieves search statistics over matching documents.

The default implementation adapts SearchClient.fetchStatistics(SearchQuery, List, List) to a future. Remote clients can override this method to use a native asynchronous transport.

Specified by:

fetchStatisticsAsync in interface SearchClient

Parameters:

query - the query to filter documents

fields - the fields to compute statistics for

groupBy - field names used to group statistics

Returns:

a future with search statistics

fetchHistogram

public io.fluxzero.common.api.search.SearchHistogram fetchHistogram(io.fluxzero.common.api.search.GetSearchHistogram request)

Description copied from interface: SearchClient

Fetches a histogram (bucketed time-series view) for documents matching the query.

Specified by:

fetchHistogram in interface SearchClient

Parameters:

request - the histogram query parameters

Returns:

a SearchHistogram representing the result

fetchHistogramAsync

public CompletableFuture<io.fluxzero.common.api.search.SearchHistogram> fetchHistogramAsync(io.fluxzero.common.api.search.GetSearchHistogram request)

Description copied from interface: SearchClient

Asynchronously fetches a histogram for documents matching the query.

The default implementation adapts SearchClient.fetchHistogram(GetSearchHistogram) to a future. Remote clients can override this method to use a native asynchronous transport.

Specified by:

fetchHistogramAsync in interface SearchClient

Parameters:

request - the histogram query parameters

Returns:

a future with the histogram for matching documents

fetchFacetStats

public List<io.fluxzero.common.api.search.FacetStats> fetchFacetStats(io.fluxzero.common.api.search.SearchQuery query)

Description copied from interface: SearchClient

Retrieves facet statistics (i.e., value counts) for a given query.

Specified by:

fetchFacetStats in interface SearchClient

Parameters:

query - the query to match documents against

Returns:

a list of facet statistics

fetchFacetStatsAsync

public CompletableFuture<List<io.fluxzero.common.api.search.FacetStats>> fetchFacetStatsAsync(io.fluxzero.common.api.search.SearchQuery query)

Description copied from interface: SearchClient

Asynchronously retrieves facet statistics for a given query.

The default implementation adapts SearchClient.fetchFacetStats(SearchQuery) to a future. Remote clients can override this method to use a native asynchronous transport.

Specified by:

fetchFacetStatsAsync in interface SearchClient

Parameters:

query - the query to match documents against

Returns:

a future with facet statistics

delete

public CompletableFuture<Void> delete(io.fluxzero.common.api.search.SearchQuery query,
 io.fluxzero.common.Guarantee guarantee,
 int batchSize)

Description copied from interface: SearchClient

Deletes documents matching a given query using the requested batch size.

A value of 0 uses the runtime default, a positive value requests that batch size, and a negative value requests a single unbounded statement.

Specified by:

delete in interface SearchClient

Parameters:

query - the search query specifying which documents to delete

guarantee - delivery guarantee

batchSize - requested delete batch size

Returns:

a future that completes when the deletion has been performed

move

public CompletableFuture<Void> move(io.fluxzero.common.api.search.SearchQuery query,
 String targetCollection,
 io.fluxzero.common.Guarantee guarantee)

Description copied from interface: SearchClient

Moves documents matching a given query to the given target collection.

Specified by:

move in interface SearchClient

Parameters:

query - the search query specifying which documents to move

targetCollection - the name of the collection to move documents to

guarantee - delivery guarantee

Returns:

a future that completes when the move has been performed

delete

public CompletableFuture<Void> delete(String documentId,
 String collection,
 io.fluxzero.common.Guarantee guarantee)

Description copied from interface: SearchClient

Deletes a document by its unique id and collection name.

Specified by:

delete in interface SearchClient

Parameters:

documentId - the document id

collection - the collection to delete from

guarantee - delivery guarantee

Returns:

a future that completes when the deletion has been performed

move

public CompletableFuture<Void> move(String documentId,
 String collection,
 String targetCollection,
 io.fluxzero.common.Guarantee guarantee)

Description copied from interface: SearchClient

Moves a document to another collection.

Specified by:

move in interface SearchClient

Parameters:

documentId - the document id

collection - the collection to move from

targetCollection - the collection to move to

guarantee - delivery guarantee

Returns:

a future that completes when the move has been performed

deleteCollection

public CompletableFuture<Void> deleteCollection(String collection,
 io.fluxzero.common.Guarantee guarantee)

Description copied from interface: SearchClient

Deletes an entire document collection and all its contents.

Specified by:

deleteCollection in interface SearchClient

Parameters:

collection - the name of the collection to delete

guarantee - delivery guarantee

Returns:

a future that completes when the collection has been deleted

createAuditTrail

public CompletableFuture<Void> createAuditTrail(io.fluxzero.common.api.search.CreateAuditTrail request)

Description copied from interface: SearchClient

Configures Fluxzero to use a search collection as a searchable audit trail.

Specified by:

createAuditTrail in interface SearchClient

Parameters:

request - a request object specifying the collection to use as an audit trail and retention configuration

Returns:

a future that completes when the audit trail has been created.