io.dropwizard.elasticsearch.managed

Class ManagedEsClient

java.lang.Object

io.dropwizard.elasticsearch.managed.ManagedEsClient

All Implemented Interfaces:

io.dropwizard.lifecycle.Managed

public class ManagedEsClient
extends Object
implements io.dropwizard.lifecycle.Managed

A Dropwizard managed Elasticsearch Client. Depending on the EsConfiguration a Node Client or a TransportClient a is being created and its lifecycle is managed by Dropwizard.

See Also:

Node Client, Transport Client

Constructor Summary

Constructors

Constructor and Description
ManagedEsClient(org.elasticsearch.client.Client client) Create a new managed Elasticsearch Client from the provided Client.
ManagedEsClient(EsConfiguration config) Create a new managed Elasticsearch Client.
ManagedEsClient(org.elasticsearch.node.Node node) Create a new managed Elasticsearch Client from the provided Node.

Method Summary

Modifier and Type	Method and Description
org.elasticsearch.client.Client	getClient() Get the managed Elasticsearch Client instance.
void	start() Starts the Elasticsearch Node (if appropriate).
void	stop() Stops the Elasticsearch Client and (if appropriate) Node objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedEsClient

public ManagedEsClient(EsConfiguration config)

Create a new managed Elasticsearch Client. If EsConfiguration.nodeClient is true, a Node Client is being created, otherwise a TransportClient is being created with EsConfiguration.servers as transport addresses.

Parameters:

config - a valid EsConfiguration instance

ManagedEsClient

public ManagedEsClient(org.elasticsearch.node.Node node)

Create a new managed Elasticsearch Client from the provided Node.

Parameters:

node - a valid Node instance

ManagedEsClient

public ManagedEsClient(org.elasticsearch.client.Client client)

Create a new managed Elasticsearch Client from the provided Client.

Parameters:

client - an initialized Client instance

Method Detail

start

public void start()
           throws Exception

Starts the Elasticsearch Node (if appropriate). Called before the service becomes available.

Specified by:

start in interface io.dropwizard.lifecycle.Managed

Throws:

Exception - if something goes wrong; this will halt the service startup.

stop

public void stop()
          throws Exception

Stops the Elasticsearch Client and (if appropriate) Node objects. Called after the service is no longer accepting requests.

Specified by:

stop in interface io.dropwizard.lifecycle.Managed

Throws:

Exception - if something goes wrong.

getClient

public org.elasticsearch.client.Client getClient()

Get the managed Elasticsearch Client instance.

Returns:

a valid Elasticsearch Client instance