org.overlord.rtgov.common.elasticsearch

Class ElasticsearchClient

java.lang.Object

org.overlord.rtgov.common.elasticsearch.ElasticsearchClient

public class ElasticsearchClient
extends Object

ElasticSearch client.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SETTING The default settings.
static String	ELASTICSEARCH_HOSTS Default Elasticsearch hosts configuration.
static String	ELASTICSEARCH_SCHEDULE Default Elasticsearch schedule configuration.
protected static com.fasterxml.jackson.databind.ObjectMapper	MAPPER
static String	MAPPINGS Type mappings for the index this store is related to.
static String	SETTINGS Settings for the index this store is related to.

Constructor Summary

Constructors

Constructor and Description
ElasticsearchClient() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	add(String id, String document) This method adds a new document to ElasticSearch.
protected <V> void	addBulk(String id, String document)
void	close() This method closes the Elasticsearch client.
static <V> V	convertJsonToType(String json, Class<V> type) convert type to String.
static String	convertTypeToJson(Object obj) convert type to String.
String	get(String id) default implementation of getter returns a simple .json document as String.
int	getBulkSize() This method returns the _bulkSize.
Client	getElasticsearchClient() The Elasticsearch client.
String	getHosts() This method sets the hosts.
String	getIndex() This method returns the index.
long	getSchedule() This method returns the schedule.
String	getType() This method returns the index.
void	init() Initialize the client.
protected void	initClient(Client client)
void	remove(String id) This method removes the document with the supplied id.
void	setBulkSize(int bulkSize) This method sets the _bulkSize.
void	setHosts(String hosts) This method returns the hosts.
void	setIndex(String index) This method sets the index.
void	setSchedule(long schedule) This method sets the schedule.
void	setType(String type) This method sets the type.
String	toString()
void	update(String id, String document) This method updates the supplied document.

Methods inherited from class java.lang.Object

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

Field Detail

MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

ELASTICSEARCH_HOSTS

public static final String ELASTICSEARCH_HOSTS

Default Elasticsearch hosts configuration.

See Also:

Constant Field Values

ELASTICSEARCH_SCHEDULE

public static final String ELASTICSEARCH_SCHEDULE

Default Elasticsearch schedule configuration.

See Also:

Constant Field Values

SETTINGS

public static final String SETTINGS

Settings for the index this store is related to.

See Also:

Constant Field Values

MAPPINGS

public static final String MAPPINGS

Type mappings for the index this store is related to.

See Also:

Constant Field Values

DEFAULT_SETTING

public static final String DEFAULT_SETTING

The default settings.

See Also:

Constant Field Values

Constructor Detail

ElasticsearchClient

public ElasticsearchClient()

Default constructor.

Method Detail

getSchedule

public long getSchedule()

This method returns the schedule.

Returns:

The schedule

setSchedule

public void setSchedule(long schedule)

This method sets the schedule.

Parameters:

schedule - the schedule

getIndex

public String getIndex()

This method returns the index.

Returns:

The index

setIndex

public void setIndex(String index)

This method sets the index.

Parameters:

index - The index

getType

public String getType()

This method returns the index.

Returns:

The index

setType

public void setType(String type)

This method sets the type.

Parameters:

type - The type

getHosts

public String getHosts()

This method sets the hosts.

Returns:

The hosts

setHosts

public void setHosts(String hosts)

This method returns the hosts.

Parameters:

hosts - The hosts

getBulkSize

public int getBulkSize()

This method returns the _bulkSize.

Returns:

Returns _bulkSize

setBulkSize

public void setBulkSize(int bulkSize)

This method sets the _bulkSize.

Parameters:

bulkSize - The bulkSize

init

public void init()
          throws Exception

Initialize the client.

Throws:

Exception - Failed to initialize the client

initClient

protected void initClient(Client client)
                   throws Exception

Throws:

Exception

addBulk

protected <V> void addBulk(String id,
                           String document)

Type Parameters:

V -

Parameters:

id -

document -

add

public void add(String id,
                String document)
         throws Exception

This method adds a new document to ElasticSearch.

Parameters:

id - The id

document - The document

Throws:

Exception - Failed to add

remove

public void remove(String id)
            throws Exception

This method removes the document with the supplied id.

Parameters:

id - The id

Throws:

Exception - Failed to remove document

update

public void update(String id,
                   String document)

This method updates the supplied document.

Parameters:

id - The id

document - The document

get

public String get(String id)

default implementation of getter returns a simple .json document as String.

Parameters:

id - The id.

Returns:

Document as string.

convertTypeToJson

public static String convertTypeToJson(Object obj)

convert type to String.

Parameters:

obj - The object to convert

Returns:

The json document

convertJsonToType

public static <V> V convertJsonToType(String json,
                                      Class<V> type)

convert type to String.

Type Parameters:

V - type The object type

Parameters:

json - The json document

type - The type of the object to return

Returns:

The converted object

getElasticsearchClient

public Client getElasticsearchClient()

The Elasticsearch client.

Returns:

The client

close

public void close()

This method closes the Elasticsearch client.

toString

public String toString()

Overrides:

toString in class Object