Java client

The OpenSearch Java client allows you to interact with your OpenSearch clusters through Java methods and data structures rather than HTTP methods and raw JSON.

For example, you can submit requests to your cluster using objects to create indices, add data to documents, or complete some other operation using the client’s built-in methods.

Install the client

To start using the OpenSearch Java client, ensure that you have the following dependencies in your project’s pom.xml file:

  1. <dependency>
  2.   <groupId>org.opensearch.client</groupId>
  3.   <artifactId>opensearch-rest-client</artifactId>
  4.   <version>2.3.0</version>
  5. </dependency>
  6. <dependency>
  7.   <groupId>org.opensearch.client</groupId>
  8.   <artifactId>opensearch-java</artifactId>
  9.   <version>2.0.0</version>
  10. </dependency>

If you’re using Gradle, add the following dependencies to your project.

  1. dependencies {
  2.     implementation 'org.opensearch.client:opensearch-rest-client: 2.3.0'
  3.     implementation 'org.opensearch.client:opensearch-java:2.0.0'
  4. }

You can now start your OpenSearch cluster.

Security

Before using the REST client in your Java application, you must configure the application’s truststore to connect to the security plugin. If you are using self-signed certificates or demo configurations, you can use the following command to create a custom truststore and add in root authority certificates.

If you’re using certificates from a trusted Certificate Authority (CA), you don’t need to configure the truststore.

  1. keytool -import <path-to-cert> -alias <alias-to-call-cert> -keystore <truststore-name>

You can now point your Java client to the truststore and set basic authentication credentials that can access a secure cluster (refer to the sample code below on how to do so).

If you run into issues when configuring security, see common issues and troubleshoot TLS.

Sample data

This section uses a class called IndexData, which is a simple Java class that stores basic data and methods. For your own OpenSearch cluster, you might find that you need a more robust class to store your data.

IndexData class

  1. static class IndexData {
  2.   private String firstName;
  3.   private String lastName;
  5.   public IndexData(String firstName, String lastName) {
  6.     this.firstName = firstName;
  7.     this.lastName = lastName;
  8.   }
  10.   public String getFirstName() {
  11.     return firstName;
  12.   }
  14.   public void setFirstName(String firstName) {
  15.     this.firstName = firstName;
  16.   }
  18.   public String getLastName() {
  19.     return lastName;
  20.   }
  22.   public void setLastName(String lastName) {
  23.     this.lastName = lastName;
  24.   }
  26.   @Override
  27.   public String toString() {
  28.     return String.format("IndexData{first name='%s', last name='%s'}", firstName, lastName);
  29.   }
  30. }

Initialize the client with SSL and TLS enabled

This code example uses basic credentials that come with the default OpenSearch configuration. If you’re using the Java client with your own OpenSearch cluster, be sure to change the code to use your own credentials.

The following sample code initializes a client with SSL and TLS enabled:

  1. import org.apache.http.HttpHost;
  2. import org.apache.http.auth.AuthScope;
  3. import org.apache.http.auth.UsernamePasswordCredentials;
  4. import org.apache.http.client.CredentialsProvider;
  5. import org.apache.http.impl.client.BasicCredentialsProvider;
  6. import org.apache.http.impl.nio.client.HttpAsyncClientBuilder;
  7. import org.opensearch.client.RestClient;
  8. import org.opensearch.client.RestClientBuilder;
  9. import org.opensearch.client.base.RestClientTransport;
  10. import org.opensearch.client.base.Transport;
  11. import org.opensearch.client.json.jackson.JacksonJsonpMapper;
  12. import org.opensearch.client.opensearch.OpenSearchClient;
  13. import org.opensearch.client.opensearch._global.IndexRequest;
  14. import org.opensearch.client.opensearch._global.IndexResponse;
  15. import org.opensearch.client.opensearch._global.SearchResponse;
  16. import org.opensearch.client.opensearch.indices.*;
  17. import org.opensearch.client.opensearch.indices.put_settings.IndexSettingsBody;
  19. import java.io.IOException;
  21. public class OpenSearchClientExample {
  22.   public static void main(String[] args) {
  23.     RestClient restClient = null;
  24.     try{
  25.     System.setProperty("javax.net.ssl.trustStore", "/full/path/to/keystore");
  26.     System.setProperty("javax.net.ssl.trustStorePassword", "password-to-keystore");
  28.     //Only for demo purposes. Don't specify your credentials in code.
  29.     final CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
  30.     credentialsProvider.setCredentials(AuthScope.ANY,
  31.         new UsernamePasswordCredentials("admin", "admin"));
  33.     //Initialize the client with SSL and TLS enabled
  34.     restClient = RestClient.builder(new HttpHost("localhost", 9200, "https")).
  35.       setHttpClientConfigCallback(new RestClientBuilder.HttpClientConfigCallback() {
  36.         @Override
  37.         public HttpAsyncClientBuilder customizeHttpClient(HttpAsyncClientBuilder httpClientBuilder) {
  38.         return httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider);
  39.         }
  40.       }).build();
  41.     Transport transport = new RestClientTransport(restClient, new JacksonJsonpMapper());
  42.     OpenSearchClient client = new OpenSearchClient(transport);
  43.   }
  44.  }
  45. }

OpenSearch client examples

This section has sample code that shows you how to create an index with non-default settings, add a document to the index, search for the document, delete the document, and finally delete the index.

Create an index with non-default settings

  1. String index = "sample-index";
  2. CreateRequest createIndexRequest = new CreateRequest.Builder().index(index).build();
  3. client.indices().create(createIndexRequest);
  5. IndexSettings indexSettings = new IndexSettings.Builder().autoExpandReplicas("0-all").build();
  6. IndexSettingsBody settingsBody = new IndexSettingsBody.Builder().settings(indexSettings).build();
  7. PutSettingsRequest putSettingsRequest = new PutSettingsRequest.Builder().index(index).value(settingsBody).build();
  8. client.indices().putSettings(putSettingsRequest);

Index data

  1. IndexData indexData = new IndexData("first_name", "Bruce");
  2. IndexRequest<IndexData> indexRequest = new IndexRequest.Builder<IndexData>().index(index).id("1").value(indexData).build();
  3. client.index(indexRequest);

Search for the document

  1. SearchResponse<IndexData> searchResponse = client.search(s -> s.index(index), IndexData.class);
  2. for (int i = 0; i< searchResponse.hits().hits().size(); i++) {
  3.   System.out.println(searchResponse.hits().hits().get(i).source());
  4. }

Delete the document

The following sample code deletes a document whose ID is 1.

  1. client.delete(b -> b.index(index).id("1"));

Delete the index

  1. DeleteRequest deleteRequest = new DeleteRequest.Builder().index(index).build();
  2. DeleteResponse deleteResponse = client.indices().delete(deleteRequest);
  4. } catch (IOException e){
  5.     System.out.println(e.toString());
  6. } finally {
  7.     try {
  8.       if (restClient != null) {
  9.         restClient.close();
  10.       }
  11.     } catch (IOException e) {
  12.         System.out.println(e.toString());
  13.       }
  14.     }
  15.   }
  16. }

Complete code sample

  1. import org.apache.http.HttpHost;
  2. import org.apache.http.auth.AuthScope;
  3. import org.apache.http.auth.UsernamePasswordCredentials;
  4. import org.apache.http.client.CredentialsProvider;
  5. import org.apache.http.impl.client.BasicCredentialsProvider;
  6. import org.apache.http.impl.nio.client.HttpAsyncClientBuilder;
  7. import org.opensearch.client.RestClient;
  8. import org.opensearch.client.RestClientBuilder;
  9. import org.opensearch.client.base.RestClientTransport;
  10. import org.opensearch.client.base.Transport;
  11. import org.opensearch.client.json.jackson.JacksonJsonpMapper;
  12. import org.opensearch.client.opensearch.OpenSearchClient;
  13. import org.opensearch.client.opensearch._global.IndexRequest;
  14. import org.opensearch.client.opensearch._global.IndexResponse;
  15. import org.opensearch.client.opensearch._global.SearchResponse;
  16. import org.opensearch.client.opensearch.indices.*;
  17. import org.opensearch.client.opensearch.indices.put_settings.IndexSettingsBody;
  19. import java.io.IOException;
  21. public class OpenSearchClientExample {
  22.   public static void main(String[] args) {
  23.     RestClient restClient = null;
  24.     try{
  25.     System.setProperty("javax.net.ssl.trustStore", "/full/path/to/keystore");
  26.     System.setProperty("javax.net.ssl.trustStorePassword", "password-to-keystore");
  28.     //Only for demo purposes. Don't specify your credentials in code.
  29.     final CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
  30.     credentialsProvider.setCredentials(AuthScope.ANY,
  31.       new UsernamePasswordCredentials("admin", "admin"));
  33.     //Initialize the client with SSL and TLS enabled
  34.     restClient = RestClient.builder(new HttpHost("localhost", 9200, "https")).
  35.       setHttpClientConfigCallback(new RestClientBuilder.HttpClientConfigCallback() {
  36.         @Override
  37.         public HttpAsyncClientBuilder customizeHttpClient(HttpAsyncClientBuilder httpClientBuilder) {
  38.         return httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider);
  39.         }
  40.       }).build();
  41.     Transport transport = new RestClientTransport(restClient, new JacksonJsonpMapper());
  42.     OpenSearchClient client = new OpenSearchClient(transport);
  44.     //Create the index
  45.     String index = "sample-index";
  46.     CreateRequest createIndexRequest = new CreateRequest.Builder().index(index).build();
  47.     client.indices().create(createIndexRequest);
  49.     //Add some settings to the index
  50.     IndexSettings indexSettings = new IndexSettings.Builder().autoExpandReplicas("0-all").build();
  51.     IndexSettingsBody settingsBody = new IndexSettingsBody.Builder().settings(indexSettings).build();
  52.     PutSettingsRequest putSettingsRequest = new PutSettingsRequest.Builder().index(index).value(settingsBody).build();
  53.     client.indices().putSettings(putSettingsRequest);
  55.     //Index some data
  56.     IndexData indexData = new IndexData("first_name", "Bruce");
  57.     IndexRequest<IndexData> indexRequest = new IndexRequest.Builder<IndexData>().index(index).id("1").value(indexData).build();
  58.     client.index(indexRequest);
  60.     //Search for the document
  61.     SearchResponse<IndexData> searchResponse = client.search(s -> s.index(index), IndexData.class);
  62.     for (int i = 0; i< searchResponse.hits().hits().size(); i++) {
  63.       System.out.println(searchResponse.hits().hits().get(i).source());
  64.     }
  66.     //Delete the document
  67.     client.delete(b -> b.index(index).id("1"));
  69.     // Delete the index
  70.     DeleteRequest deleteRequest = new DeleteRequest.Builder().index(index).build();
  71.     DeleteResponse deleteResponse = client.indices().delete(deleteRequest);
  73.     } catch (IOException e){
  74.       System.out.println(e.toString());
  75.     } finally {
  76.       try {
  77.         if (restClient != null) {
  78.           restClient.close();
  79.         }
  80.       } catch (IOException e) {
  81.         System.out.println(e.toString());
  82.       }
  83.     }
  84.   }
  85. }