Dropwizard Elasticsearch Bundle

Addon bundle for Dropwizard to support Elasticsearch

License	Apache 2.0
Categories	DropWizard Container Microservices Search Business Logic Libraries Elasticsearch
GroupId	io.dropwizard.modules
ArtifactId	dropwizard-elasticsearch
Last Version	1.2.0-1
Release Date	Oct 18, 2017
Type	jar
Description	Dropwizard Elasticsearch Bundle Addon bundle for Dropwizard to support Elasticsearch
Project URL	https://github.com/dropwizard/dropwizard-elasticsearch
Source Code Management	https://github.com/dropwizard/dropwizard-elasticsearch

Download dropwizard-elasticsearch

Filename	Size
dropwizard-elasticsearch-1.2.0-1.pom
dropwizard-elasticsearch-1.2.0-1.jar	11 KB
dropwizard-elasticsearch-1.2.0-1-sources.jar	7 KB
dropwizard-elasticsearch-1.2.0-1-javadoc.jar	77 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.dropwizard.modules/dropwizard-elasticsearch/ -->
<dependency>
    <groupId>io.dropwizard.modules</groupId>
    <artifactId>dropwizard-elasticsearch</artifactId>
    <version>1.2.0-1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.dropwizard.modules/dropwizard-elasticsearch/
implementation 'io.dropwizard.modules:dropwizard-elasticsearch:1.2.0-1'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.dropwizard.modules/dropwizard-elasticsearch/
implementation ("io.dropwizard.modules:dropwizard-elasticsearch:1.2.0-1")

Apache Buildr

'io.dropwizard.modules:dropwizard-elasticsearch:jar:1.2.0-1'

Apache Ivy

<dependency org="io.dropwizard.modules" name="dropwizard-elasticsearch" rev="1.2.0-1">
  <artifact name="dropwizard-elasticsearch" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.dropwizard.modules', module='dropwizard-elasticsearch', version='1.2.0-1')
)

Scala SBT

libraryDependencies += "io.dropwizard.modules" % "dropwizard-elasticsearch" % "1.2.0-1"

Leiningen

[io.dropwizard.modules/dropwizard-elasticsearch "1.2.0-1"]

Dependencies

compile (2)

Group / Artifact	Type	Version
io.dropwizard : dropwizard-core	jar
org.elasticsearch : elasticsearch	jar	2.4.6

test (2)

Group / Artifact	Type	Version
junit : junit	jar	4.12
org.mockito : mockito-core	jar	2.11.0

Project Modules

There are no modules declared in this project.

Dropwizard Elasticsearch

A set of classes for using Elasticsearch (version 2.3.0 and higher) in a Dropwizard application.

The package provides a lifecycle-managed client class (ManagedEsClient), a configuration class with the most common options (EsConfiguration), and some health checks which can instantly be used in any Dropwizard application.

Usage

Just add EsConfiguration to your Configuration class and create an ManagedEsClient instance in the run method of your service.

You can also add one of the existing health checks to your Environment in the same method. At least the usage of EsClusterHealthCheck is strongly advised.

public class DemoApplication extends Application<DemoConfiguration> {
    // [...]
    @Override
    public void run(DemoConfiguration config, Environment environment) {
        final ManagedEsClient managedClient = new ManagedEsClient(configuration.getEsConfiguration());
        environment.lifecycle().manage(managedClient);
        environment.healthChecks().register("ES cluster health", new EsClusterHealthCheck(managedClient.getClient()));
        // [...]
    }
}

Configuration

The following configuration settings are supported by EsConfiguration:

• nodeClient: When true, ManagedEsClient will create a NodeClient, otherwise a TransportClient; default: true
• servers: A list of servers for usage with the created TransportClient if nodeClient is false
• clusterName: The name of the Elasticsearch cluster; default: "elasticsearch"
• settings: Any additional settings for Elasticsearch, see Configuration
• settingsFile: Any additional settings file for Elasticsearch, see Configuration

An example configuration file for creating a Node Client could like this:

clusterName: MyClusterName
settings:
  node.name: MyCustomNodeName

The order of precedence is: nodeClient/servers/clusterName > settings > settingsFile, meaning that any setting in settingsFile can be overwritten with settings which in turn get overwritten by the specific settings like clusterName.

Maven Artifacts

This project is available on Maven Central. To add it to your project simply add the following dependencies to your pom.xml:

<dependency>
  <groupId>io.dropwizard.modules</groupId>
  <artifactId>dropwizard-elasticsearch</artifactId>
  <version>1.2.0-1</version>
</dependency>

Support

Please file bug reports and feature requests in GitHub issues.

Acknowledgements

Thanks to Alexander Reelsen (@spinscale) for his Dropwizard Blog Sample which sparked the idea for this project.

License

Copyright (c) 2013-2017 Jochen Schalanda

This library is licensed under the Apache License, Version 2.0.

See http://www.apache.org/licenses/LICENSE-2.0.html or the LICENSE file in this repository for the full license text.

Dropwizard

Versions

Version
1.2.0-1 Oct 18, 2017
1.1.0-1 Mar 23, 2017
1.0.0-2 Mar 23, 2017
1.0.0-1 Jul 30, 2016
1.0.0-rc2-1 May 9, 2016
0.9.2-1 May 9, 2016
0.9.1-1 Dec 21, 2015
0.9.0-1 Oct 28, 2015
0.9.0-rc5-1 Oct 25, 2015
0.8.0-1 Mar 12, 2015
0.7.0-1 Aug 2, 2014