org.modeshape.jcr.index.elasticsearch.client

Class EsClient

java.lang.Object

org.modeshape.jcr.index.elasticsearch.client.EsClient

public class EsClient
extends Object

HTTP-based interface for the Elasticsearch engine.

Constructor Summary

Constructors

Constructor and Description
EsClient(String host, int port) Creates new instance.

Method Summary

Modifier and Type	Method and Description
long	count(String name, String type) Counts entries.
boolean	createIndex(String name, String type, EsRequest mappings) Creates new index.
void	deleteAll(String name, String type) Deletes all documents.
boolean	deleteDocument(String name, String type, String id) Deletes document.
boolean	deleteIndex(String name) Deletes index.
void	flush(String name) Flushes index data.
EsRequest	getDocument(String name, String type, String id) Searches indexed document.
boolean	indexExists(String name) Tests for the index existence with specified name.
void	refresh(String name) Refreshes index data.
EsResponse	search(String name, String type, EsRequest query) Executes query.
boolean	storeDocument(String name, String type, String id, EsRequest doc) Indexes document.

Methods inherited from class java.lang.Object

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

Constructor Detail

EsClient

public EsClient(String host,
                int port)

Creates new instance.

Parameters:

host - the address of the ES engine.

port - the port number of ES engine.

Method Detail

indexExists

public boolean indexExists(String name)
                    throws IOException

Tests for the index existence with specified name.

Parameters:

name - the name of the index to test.

Returns:

true if index with given name exists and false otherwise.

Throws:

IOException - communication exception.

createIndex

public boolean createIndex(String name,
                           String type,
                           EsRequest mappings)
                    throws IOException

Creates new index.

Parameters:

name - the name of the index to test.

type - index type

mappings - field mapping definition.

Returns:

true if index was created.

Throws:

IOException - communication exception.

deleteIndex

public boolean deleteIndex(String name)
                    throws IOException

Deletes index.

Parameters:

name - the name of the index to be deleted.

Returns:

true if index was deleted.

Throws:

IOException

storeDocument

public boolean storeDocument(String name,
                             String type,
                             String id,
                             EsRequest doc)
                      throws IOException

Indexes document.

Parameters:

name - the name of the index.

type - index type

id - document id

doc - document

Returns:

true if document was indexed.

Throws:

IOException

getDocument

public EsRequest getDocument(String name,
                             String type,
                             String id)
                      throws IOException

Searches indexed document.

Parameters:

name - index name.

type - index type.

id - document identifier.

Returns:

document if it was found or null.

Throws:

IOException

deleteDocument

public boolean deleteDocument(String name,
                              String type,
                              String id)
                       throws IOException

Deletes document.

Parameters:

name - index name.

type - index type.

id - document id

Returns:

true if it was deleted.

Throws:

IOException

deleteAll

public void deleteAll(String name,
                      String type)
               throws IOException

Deletes all documents.

Parameters:

name - index name

type - index type.

Throws:

IOException

flush

public void flush(String name)
           throws IOException

Flushes index data.

Parameters:

name - index name.

Throws:

IOException

refresh

public void refresh(String name)
             throws IOException

Refreshes index data.

Parameters:

name - index name.

Throws:

IOException

search

public EsResponse search(String name,
                         String type,
                         EsRequest query)
                  throws IOException

Executes query.

Parameters:

name - index name.

type - index type.

query - query to be executed

Returns:

search results in json format.

Throws:

IOException

count

public long count(String name,
                  String type)
           throws IOException

Counts entries.

Parameters:

name - index name.

type - index type.

Returns:

number of indexed entries.

Throws:

IOException