Configuring X-Pack Java Clients

Deprecated in 7.0.0.

The TransportClient is deprecated in favour of the Java High Level REST Client and will be removed in Elasticsearch 8.0. The migration guide describes all the steps needed to migrate.

If you want to use a Java transport client with a cluster where X-Pack is installed, then you must download and configure the X-Pack transport client.

  1. Add the X-Pack transport JAR file to your CLASSPATH. You can download the X-Pack distribution and extract the JAR file manually or you can get it from the Elasticsearch Maven repository. As with any dependency, you will also need its transitive dependencies. Refer to the X-Pack POM file for your version when downloading for offline usage.

  2. If you are using Maven, you need to add the X-Pack JAR file as a dependency in your project’s pom.xml file:

    1. <project ...>
    2.      <repositories>
    3.      <!-- add the elasticsearch repo -->
    4.       <repository>
    5.          <id>elasticsearch-releases</id>
    6.          <url>https://artifacts.elastic.co/maven</url>
    7.          <releases>
    8.           <enabled>true</enabled>
    9.          </releases>
    10.          <snapshots>
    11.             <enabled>false</enabled>
    12.          </snapshots>
    13.       </repository>
    14.       ...
    15.    </repositories>
    16.    ...
    18.    <dependencies>
    19.       <!-- add the x-pack jar as a dependency -->
    20.       <dependency>
    21.          <groupId>org.elasticsearch.client</groupId>
    22.          <artifactId>x-pack-transport</artifactId>
    23.               <version>{version}</version>
    24.       </dependency>
    25.       ...
    26.    </dependencies>
    27.    ...
    29. </project>

  3. If you are using Gradle, you need to add the X-Pack JAR file as a dependency in your build.gradle file:

    1. repositories {
    2.   /* ... Any other repositories ... */
    4.   // Add the Elasticsearch Maven Repository
    5.   maven {
    6.     name "elastic"
    7.     url "https://artifacts.elastic.co/maven"
    8.   }
    9. }
    11. dependencies {
    12.   compile "org.elasticsearch.client:x-pack-transport:{version}"
    14.   /* ... */
    15. }

  4. If you are using a repository manager such as Nexus OSS within your company, you need to add the repository as per the following screenshot:

    Adding the Elastic repo in Nexus

    Then in your project’s pom.xml if using maven, add the following repositories and dependencies definitions:

    1. <dependencies>
    2.     <dependency>
    3.         <groupId>org.elasticsearch.client</groupId>
    4.         <artifactId>x-pack-transport</artifactId>
    5.         <version>{version}</version>
    6.     </dependency>
    7. </dependencies>
    9. <repositories>
    10.     <repository>
    11.         <id>local-nexus</id>
    12.         <name>Elastic Local Nexus</name>
    13.         <url>http://0.0.0.0:8081/repository/elasticsearch/</url>
    14.         <releases>
    15.             <enabled>true</enabled>
    16.         </releases>
    17.         <snapshots>
    18.             <enabled>false</enabled>
    19.         </snapshots>
    20.     </repository>
    21.   </repositories>

  5. If you are using Elastic Stack security features, there are more configuration steps. See Java Client and security.