Camel Components

Elasticsearch Low level Rest Client

Since Camel 4.3

Only producer is supported

The ElasticSearch component allows you to interface with ElasticSearch 8.x API or OpenSearch using the ElasticSearch Java Low level Rest Client.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-elasticsearch-rest-client</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI format

elasticsearch-rest-client://clusterName[?options]

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level.

For example, a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre-configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

You can configure components using:

  • the Component DSL.

  • in a configuration file (application.properties, *.yaml files, etc).

  • directly in the Java code.

Configuring Endpoint Options

You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders.

Property placeholders provide a few benefits:

  • They help prevent using hardcoded urls, port numbers, sensitive information, and other settings.

  • They allow externalizing the configuration from the code.

  • They help the code to become more flexible and reusable.

The following two sections list all the options, firstly for the component followed by the endpoint.

Component Options

The Elasticsearch Low level Rest Client component supports the following options which are listed below.

Name Description Default Type

connectionTimeout (producer)

Connection timeout.

30000

int

hostAddressesList (producer)

List of host Addresses, multiple hosts can be separated by comma.

String

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

socketTimeout (producer)

Socket timeout.

30000

int

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

enableSniffer (advanced)

Enabling Sniffer.

false

boolean

restClient (advanced)

Autowired Rest Client of type org.elasticsearch.client.RestClient. This is only for advanced usage.

RestClient

sniffAfterFailureDelay (advanced)

Sniffer after failure delay (in millis).

60000

int

snifferInterval (advanced)

Sniffer interval (in millis).

60000

int

certificatePath (security)

Certificate Path.

String

password (security)

Password.

String

sslContextParameters (security)

To configure security using SSLContextParameters. When configured, this takes precedence over the certificatePath option.

SSLContextParameters

useGlobalSslContextParameters (security)

Enable usage of global SSL context parameters.

false

boolean

user (security)

Username.

String

Endpoint Options

The Elasticsearch Low level Rest Client endpoint is configured using URI syntax:

elasticsearch-rest-client:clusterName

With the following path and query parameters:

Path Parameters

Name Description Default Type

clusterName (producer)

Required Cluster Name.

String

Query Parameters

Name Description Default Type

connectionTimeout (producer)

Connection timeout.

30000

int

hostAddressesList (producer)

List of host Addresses, multiple hosts can be separated by comma.

String

indexName (producer)

Index Name.

String

operation (producer)

Operation.

Enum values:

  • INDEX_OR_UPDATE

  • GET_BY_ID

  • DELETE

  • CREATE_INDEX

  • DELETE_INDEX

  • SEARCH

ElasticsearchRestClientOperation

socketTimeout (producer)

Socket timeout.

30000

int

lazyStartProducer (producer (advanced))

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

enableSniffer (advanced)

Enabling Sniffer.

false

boolean

restClient (advanced)

Autowired Rest Client of type org.elasticsearch.client.RestClient. This is only for advanced usage.

RestClient

sniffAfterFailureDelay (advanced)

Sniffer after failure delay (in millis).

60000

int

snifferInterval (advanced)

Sniffer interval (in millis).

60000

int

certificatePath (security)

Certificate Path.

String

password (security)

Password.

String

sslContextParameters (security)

To configure security using SSLContextParameters. When configured, this takes precedence over the certificatePath option. This allows configuring named groups, signature schemes, cipher suites, and protocols for the TLS connection.

SSLContextParameters

user (security)

Username.

String

Message Headers

The Elasticsearch Low level Rest Client component supports the following message header(s), which is/are listed below:

Name Description Default Type

CamelElasticsearchId (producer)

Constant: ID

ID of the object to index or retrieve or delete.

String

CamelElasticsearchSearchQuery (producer)

Constant: SEARCH_QUERY

The JSON Query to perform for search.

String

CamelElasticsearchIndexSettings (producer)

Constant: INDEX_SETTINGS

Advanced - The JSON Index Settings and/or Mappings Query to perform to create an index.

String

CamelElasticsearchIndexName (producer)

Constant: INDEX_NAME

The Index name.

String

CamelElasticsearchOperation (producer)

Constant: OPERATION

The operation to perform.

Enum values:

  • INDEX_OR_UPDATE

  • GET_BY_ID

  • DELETE

  • CREATE_INDEX

  • DELETE_INDEX

  • SEARCH

ElasticsearchRestClientOperation

Message Body

The message body at each side of the Elasticsearch Low level Rest Client component: Consumer is the body of the messages the consumer creates, Consumer reply the bodies a consumer that answers its caller can reply with, Producer input the bodies the producer can send or write, and Producer output the body after the producer.

Side Body Description

Producer input

text, bytes, stream, file, value, map or null

By the operation, set by the operation option or the CamelElasticsearchOperation header. INDEX_OR_UPDATE sends the body as the JSON document: text, bytes, a stream or a file of it; a Map or a POJO is sent as its toString() and fails, so marshal it to JSON first. GET_BY_ID and DELETE take the id as the body, or from the CamelElasticsearchId header when the body is empty. SEARCH takes a Map of field names and values to match, or else the JSON query of the CamelElasticsearchSearchQuery header; a JSON text body is not used, and with neither all documents match. CREATE_INDEX and DELETE_INDEX do not use the body: the settings of a new index are in the CamelElasticsearchIndexSettings header.

  • With operation=INDEX_OR_UPDATE: text, bytes, stream or file

  • With operation=GET_BY_ID: text, value or null

  • With operation=DELETE: text, value or null

  • With operation=SEARCH: map or null

  • With operation=CREATE_INDEX: any

  • With operation=DELETE_INDEX: any

Producer output

text or value

The id of the document as text for INDEX_OR_UPDATE. GET_BY_ID gives the source of the document as JSON text, and SEARCH a JSON array of the sources of the hits as text: unmarshal them to read their fields. DELETE, CREATE_INDEX and DELETE_INDEX give true. A missing id or index, or an index that is already there, fails with the error of the server: a GET_BY_ID of a missing id fails with 404 rather than giving null.

  • With operation=INDEX_OR_UPDATE: text (java.lang.String)

  • With operation=GET_BY_ID: text (java.lang.String)

  • With operation=SEARCH: text (java.lang.String)

  • With operation=DELETE: value (java.lang.Boolean)

  • With operation=CREATE_INDEX: value (java.lang.Boolean)

  • With operation=DELETE_INDEX: value (java.lang.Boolean)

The bodies are the ones with the default options. A side that is not listed is not known, and tooling does not guess it. The carriers, the sides and the tools that use them are described in Message Body Types.

Elasticsearch Low level Rest Client Operations

Set an endpoint URI option or exchange header with a name of operation and a value of one of the following supported options.

operation message body description

INDEX_OR_UPDATE

String, byte[], Reader or InputStream content to index or update

Adds or updates content to an index and returns the resulting id in the message body. You can set the name of the target index from the indexName URI parameter option, or by providing a message header with the key INDEX_NAME. When updating indexed content, you must provide its id via a message header with the key ID .

GET_BY_ID

String id of content to retrieve

Retrieves a JSON String representation of the indexed document, corresponding to the given index id and sets it as the message exchange body. You can set the name of the target index from the indexName URI parameter option, or by providing a message header with the key INDEX_NAME. You must provide the index id of the content to retrieve either in the message body, or via a message header with the key ID .

DELETE

String id of content to delete

Deletes the specified indexName and returns a boolean value as the message exchange body, indicating whether the operation was successful. You can set the name of the target index from the indexName URI parameter option, or by providing a message header with the key INDEX_NAME. You must provide the index id of the content to delete either in the message body, or via a message header with the key ID .

CREATE_INDEX

Creates the specified indexName and returns a boolean value as the message exchange body, indicating whether the operation was successful. You can set the name of the target index to create from the indexName URI parameter option, or by providing a message header with the key CamelElasticsearchIndexName. You may also provide a header with the key CamelElasticsearchIndexSettings where the value is a JSON String representation of the index settings.

DELETE_INDEX

Deletes the specified indexName and returns a boolean value as the message exchange body, indicating whether the operation was successful. You can set the name of the target index to create from the indexName URI parameter option, or by providing a message header with the key CamelElasticsearchIndexName.

SEARCH

Map (optional)

Search for content with either a Map of String keys & values of query criteria in the body, or a JSON string representation of the query in the CamelElasticsearchSearchQuery header, which wins over the body. A JSON string in the body is not used: with no Map body and no header, all documents match. Matching documents are returned as a JSON array string of their sources set on the message exchange body. You can set the JSON query String by providing a message header with the key CamelElasticsearchSearchQuery. You can set the message exchange body to a Map of String keys & values for the query criteria.

Examples

Index Content Example

To index some content.

  • Java

  • XML

  • YAML

from("direct:index")
    .setBody().constant("{\"content\": \"ElasticSearch With Camel\"}")
    .to("elasticsearch-rest-client://myCluster?operation=INDEX_OR_UPDATE&indexName=myIndex");
<route>
  <from uri="direct:index"/>
  <setBody>
    <constant>{"content": "ElasticSearch With Camel"}</constant>
  </setBody>
  <to uri="elasticsearch-rest-client://myCluster?operation=INDEX_OR_UPDATE&amp;indexName=myIndex"/>
</route>
- route:
    from:
      uri: direct:index
      steps:
        - setBody:
            constant: '{"content": "ElasticSearch With Camel"}'
        - to:
            uri: elasticsearch-rest-client://myCluster
            parameters:
              operation: INDEX_OR_UPDATE
              indexName: myIndex

To update existing indexed content, provide the ID message header and the message body with the updated content.

  • Java

  • XML

  • YAML

from("direct:index")
    .setHeader("CamelElasticsearchId").constant("1")
    .setBody().constant("{\"content\": \"ElasticSearch REST Client With Camel\"}")
    .to("elasticsearch-rest-client://myCluster?operation=INDEX_OR_UPDATE&indexName=myIndex");
<route>
  <from uri="direct:index"/>
  <setHeader name="CamelElasticsearchId">
    <constant>1</constant>
  </setHeader>
  <setBody>
    <constant>{"content": "ElasticSearch REST Client With Camel"}</constant>
  </setBody>
  <to uri="elasticsearch-rest-client://myCluster?operation=INDEX_OR_UPDATE&amp;indexName=myIndex"/>
</route>
- route:
    from:
      uri: direct:index
      steps:
        - setHeader:
            name: CamelElasticsearchId
            constant: "1"
        - setBody:
            constant: '{"content": "ElasticSearch REST Client With Camel"}'
        - to:
            uri: elasticsearch-rest-client://myCluster
            parameters:
              operation: INDEX_OR_UPDATE
              indexName: myIndex

Get By ID Example

  • Java

  • XML

  • YAML

from("direct:getById")
    .setHeader("CamelElasticsearchId").constant("1")
    .to("elasticsearch-rest-client://myCluster?operation=GET_BY_ID&indexName=myIndex");
<route>
  <from uri="direct:getById"/>
  <setHeader name="CamelElasticsearchId">
    <constant>1</constant>
  </setHeader>
  <to uri="elasticsearch-rest-client://myCluster?operation=GET_BY_ID&amp;indexName=myIndex"/>
</route>
- route:
    from:
      uri: direct:getById
      steps:
        - setHeader:
            name: CamelElasticsearchId
            constant: "1"
        - to:
            uri: elasticsearch-rest-client://myCluster
            parameters:
              operation: GET_BY_ID
              indexName: myIndex

Delete Example

To delete indexed content, provide the ID message header.

  • Java

  • XML

  • YAML

from("direct:getById")
    .setHeader("CamelElasticsearchId").constant("1")
    .to("elasticsearch-rest-client://myCluster?operation=DELETE&indexName=myIndex");
<route>
  <from uri="direct:getById"/>
  <setHeader name="CamelElasticsearchId">
    <constant>1</constant>
  </setHeader>
  <to uri="elasticsearch-rest-client://myCluster?operation=DELETE&amp;indexName=myIndex"/>
</route>
- route:
    from:
      uri: direct:getById
      steps:
        - setHeader:
            name: CamelElasticsearchId
            constant: "1"
        - to:
            uri: elasticsearch-rest-client://myCluster
            parameters:
              operation: DELETE
              indexName: myIndex

Create Index Example

To create a new index.

  • Java

  • XML

  • YAML

from("direct:createIndex")
    .to("elasticsearch-rest-client://myCluster?operation=CREATE_INDEX&indexName=myIndex");
<route>
  <from uri="direct:createIndex"/>
  <to uri="elasticsearch-rest-client://myCluster?operation=CREATE_INDEX&amp;indexName=myIndex"/>
</route>
- route:
    from:
      uri: direct:createIndex
      steps:
        - to:
            uri: elasticsearch-rest-client://myCluster
            parameters:
              operation: CREATE_INDEX
              indexName: myIndex

To create a new index with some custom settings.

Java-only: uses a Java String variable for index settings
String indexSettings = "{\"settings\":{\"number_of_replicas\": 1,\"number_of_shards\": 3,\"analysis\": {},\"refresh_interval\": \"1s\"},\"mappings\":{\"dynamic\": false,\"properties\": {\"title\": {\"type\": \"text\", \"analyzer\": \"english\"}}}}";
Java-only: route using the indexSettings Java variable
from("direct:createIndex")
    .setHeader("CamelElasticsearchIndexSettings").constant(indexSettings)
    .to("elasticsearch-rest-client://myCluster?operation=CREATE_INDEX&indexName=myIndex");

Delete Index Example

To delete an index.

  • Java

  • XML

  • YAML

from("direct:deleteIndex")
    .to("elasticsearch-rest-client://myCluster?operation=DELETE_INDEX&indexName=myIndex");
<route>
  <from uri="direct:deleteIndex"/>
  <to uri="elasticsearch-rest-client://myCluster?operation=DELETE_INDEX&amp;indexName=myIndex"/>
</route>
- route:
    from:
      uri: direct:deleteIndex
      steps:
        - to:
            uri: elasticsearch-rest-client://myCluster
            parameters:
              operation: DELETE_INDEX
              indexName: myIndex

Search Example

Search with a JSON query.

  • Java

  • XML

  • YAML

from("direct:search")
    .setHeader("CamelElasticsearchSearchQuery").constant("{\"query\":{\"match\":{\"content\":\"ElasticSearch With Camel\"}}}")
    .to("elasticsearch-rest-client://myCluster?operation=SEARCH&indexName=myIndex");
<route>
  <from uri="direct:search"/>
  <setHeader name="CamelElasticsearchSearchQuery">
    <constant>{"query":{"match":{"content":"ElasticSearch With Camel"}}}</constant>
  </setHeader>
  <to uri="elasticsearch-rest-client://myCluster?operation=SEARCH&amp;indexName=myIndex"/>
</route>
- route:
    from:
      uri: direct:search
      steps:
        - setHeader:
            name: CamelElasticsearchSearchQuery
            constant: '{"query":{"match":{"content":"ElasticSearch With Camel"}}}'
        - to:
            uri: elasticsearch-rest-client://myCluster
            parameters:
              operation: SEARCH
              indexName: myIndex

Search on specific field(s) using Map.

Java-only: creating a search criteria Map
Map<String, String> criteria = new HashMap<>();
criteria.put("content", "Camel");
Java-only: route using the criteria Java variable
from("direct:search")
    .setBody().constant(criteria)
    .to("elasticsearch-rest-client://myCluster?operation=SEARCH&indexName=myIndex");