Class ElasticsearchEngine

java.lang.Object

com.codename1.backend.search.ElasticsearchEngine

All Implemented Interfaces:

SearchEngine, Closeable, AutoCloseable

public final class ElasticsearchEngine
extends Object
implements SearchEngine

Elasticsearch (7 and 8) and OpenSearch over their REST API.

The request bodies used are the subset both projects share: bool queries with multi_match and term, terms aggregations, highlight and track_total_hits. Basic authentication comes from the URL, an API key from cn1.search.apiKey, and an Amazon OpenSearch domain is signed with SigV4 instead.

Method Summary

Modifier and Type	Method	Description
static ElasticsearchEngine	aws(String host, String service, String region)	An Amazon OpenSearch domain (service "es") or serverless collection ("aoss") at host, signed with credentials resolved the usual way.
void	close()	Releases connections.
static ElasticsearchEngine	connect(String url, String apiKey)	A cluster at url (http:// or https://, user and password in the URL when it needs them); apiKey is the encoded key or null.
boolean	delete(String index, String id)	Removes a document; returns whether there was one.
void	deleteIndex(String index)	Removes an index and every document in it; a missing one is not an error.
Map	get(String index, String id)	The document stored under id, or null.
void	index(String index, String id, Map document)	Adds a document under id, replacing any already there.
void	refresh(String index)	Makes every write so far visible to SearchEngine.search(String, SearchQuery).
SearchResult	search(String index, SearchQuery q)	Runs a query.

Methods inherited from class Object

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

Method Details

connect

public static ElasticsearchEngine connect(String url,
 String apiKey)
                                   throws IOException

A cluster at url (http:// or https://, user and password in the URL when it needs them); apiKey is the encoded key or null.

Throws:

IOException

aws

public static ElasticsearchEngine aws(String host,
 String service,
 String region)
                               throws IOException

An Amazon OpenSearch domain (service "es") or serverless collection ("aoss") at host, signed with credentials resolved the usual way.

Throws:

IOException

index

public void index(String index,
 String id,
 Map document)
           throws IOException

Description copied from interface: SearchEngine

Adds a document under id, replacing any already there.

Specified by:

index in interface SearchEngine

Throws:

IOException

delete

public boolean delete(String index,
 String id)
               throws IOException

Description copied from interface: SearchEngine

Removes a document; returns whether there was one.

Specified by:

delete in interface SearchEngine

Throws:

IOException

get

public Map get(String index,
 String id)
        throws IOException

Description copied from interface: SearchEngine

The document stored under id, or null.

Specified by:

get in interface SearchEngine

Throws:

IOException

search

public SearchResult search(String index,
 SearchQuery q)
                    throws IOException

Description copied from interface: SearchEngine

Runs a query.

Specified by:

search in interface SearchEngine

Throws:

IOException

refresh

public void refresh(String index)
             throws IOException

Description copied from interface: SearchEngine

Makes every write so far visible to SearchEngine.search(String, SearchQuery). Search clusters publish writes about once a second; tests and read-your-write flows call this.

Specified by:

refresh in interface SearchEngine

Throws:

IOException

deleteIndex

public void deleteIndex(String index)
                 throws IOException

Description copied from interface: SearchEngine

Removes an index and every document in it; a missing one is not an error.

Specified by:

deleteIndex in interface SearchEngine

Throws:

IOException

close

public void close()

Description copied from interface: SearchEngine

Releases connections. An engine from SearchEngines.current() is closed by the server and must not be closed by the caller.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SearchEngine