Hop is a Java client for the RabbitMQ HTTP API.
Hop is designed to be easy to use from other JVM languages, primarily Groovy, Scala, and Kotlin.
N.B. that Clojure already includes an HTTP API client as part of Langohr, and you should use Langohr instead.
Hop provides a reactive, non-blocking IO client based on Reactor Netty. A blocking client is available as well.
This project is mature and covers all key RabbitMQ HTTP API endpoints.
Meaningful breaking API changes are reflected in the version. User documentation is currently kept in this README.
Project artifacts are available from Maven Central.
For milestones and release candidates, declare the milestone repository in your dependency manager.
If you want to use the blocking IO client, add the following dependencies:
<dependency>
<groupId>com.rabbitmq</groupId>
<artifactId>http-client</artifactId>
<version>5.2.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.15.3</version>
</dependency>compile "com.rabbitmq:http-client:5.2.0"
compile "com.fasterxml.jackson.core:jackson-databind:2.15.3"If you want to use the reactive, non-blocking IO client, add the following dependencies:
<dependency>
<groupId>com.rabbitmq</groupId>
<artifactId>http-client</artifactId>
<version>5.2.0</version>
</dependency>
<dependency>
<groupId>io.projectreactor.netty</groupId>
<artifactId>reactor-netty</artifactId>
<version>1.1.12</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.15.3</version>
</dependency>compile "com.rabbitmq:http-client:5.2.0"
compile "io.projectreactor.netty:reactor-netty:1.1.12"
compile "com.fasterxml.jackson.core:jackson-databind:2.15.3"Milestones and release candidates are available on the RabbitMQ Milestone Repository:
Maven:
<repositories>
<repository>
<id>packagecloud-rabbitmq-maven-milestones</id>
<url>https://packagecloud.io/rabbitmq/maven-milestones/maven2</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>Gradle:
repositories {
maven {
url "https://packagecloud.io/rabbitmq/maven-milestones/maven2"
}
}To use snapshots, add the following dependencies:
<dependency>
<groupId>com.rabbitmq</groupId>
<artifactId>http-client</artifactId>
<version>5.3.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.15.3</version>
</dependency>compile "com.rabbitmq:http-client:5.3.0-SNAPSHOT"
compile "com.fasterxml.jackson.core:jackson-databind:2.15.3"Add the Sonatype OSS snapshot repository to your dependency manager:
Maven:
<repositories>
<repository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
<releases>
<enabled>false</enabled>
</releases>
</repository>
</repositories>Gradle:
repositories {
maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
mavenCentral()
}Hop faithfully follows RabbitMQ HTTP API conventions in its API. You interact with the server
using a single class, Client, which needs an API endpoint and
a pair of credentials to be instantiated:
import com.rabbitmq.http.client.Client;
import com.rabbitmq.http.client.ClientParameters;
Client c = new Client(
new ClientParameters()
.url("http://127.0.0.1:15672/api/")
.username("guest")
.password("guest")
);The synchronous client uses Java 11’s HttpClient internally.
The client uses sensible defaults, but it is possible to customize the HttpClient instance and requests creation with JdkHttpClientHttpLayer#configure():
HttpLayerFactory httpLayerFactory =
JdkHttpClientHttpLayer.configure() // (1)
.clientBuilderConsumer(
clientBuilder -> // (2)
clientBuilder
.connectTimeout(Duration.ofSeconds(10)))
.requestBuilderConsumer(
requestBuilder -> // (3)
requestBuilder
.timeout(Duration.ofSeconds(10))
.setHeader("Authorization", authorization("guest", "guest")))
.create(); // (4)
Client c =
new Client(
new ClientParameters()
.url("http://127.0.0.1:15672/api/")
.username("guest")
.password("guest")
.httpLayerFactory(httpLayerFactory)); // (5)-
Configure the HTTP layer factory
-
Configure the creation of the
HttpClientinstance -
Configure the creation of each request
-
Instantiate the HTTP layer factory
-
Set the HTTP layer factory
Set the SSLContext on the HttpClient builder to configure TLS:
SSLContext sslContext = SSLContext.getInstance("TLSv1.3"); // (1)
sslContext.init(kmf.getKeyManagers(), tmf.getTrustManagers(), random); // (2)
HttpLayerFactory factory =
JdkHttpClientHttpLayer.configure()
.clientBuilderConsumer(builder -> builder.sslContext(sslContext)) // (3)
.create();-
Create the SSL context
-
Initialize the SSL context
-
Set the SSL context on the client builder
Note the HttpClient enables hostname verification by default.
This is a good thing for security, but it can generate surprising failures.
Hostname verification can be disabled globally with the jdk.internal.httpclient.disableHostnameVerification system property for development or test purposes, but at no cost in a production environment.
// list cluster nodes
c.getNodes();
// get status and metrics of individual node
c.getNode("[email protected]");// list client connections
c.getConnections();
// get status and metrics of individual connection
c.getConnection("127.0.0.1:61779 -> 127.0.0.1:5672");
// forcefully close connection
c.closeConnection("127.0.0.1:61779 -> 127.0.0.1:5672");// list all channels
c.getChannels();
// list channels on individual connection
c.getChannels("127.0.0.1:61779 -> 127.0.0.1:5672");
// list detailed channel info
c.getChannel("127.0.0.1:61779 -> 127.0.0.1:5672 (3)");// list all queues
c.getQueues();
// list all queues in a vhost
c.getQueues();
// declare a queue that's not durable, auto-delete,
// and non-exclusive
c.declareQueue("/", "queue1", new QueueInfo(false, true, false));
// bind a queue
c.bindQueue("/", "queue1", "amq.fanout", "routing-key");
// delete a queue
c.deleteQueue("/", "queue1");// list bindings where exchange "an.exchange" is source
// (other things are bound to it)
c.getBindingsBySource("/", "an.exchange");
// list bindings where exchange "an.exchange" is destination
// (it is bound to other exchanges)
c.getBindingsByDestination("/", "an.exchange");Start the broker:
docker run -it --rm --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:3.12-managementConfigure the broker for the test suite:
export HOP_RABBITMQCTL="DOCKER:rabbitmq"
./ci/before-build.shLaunch the test suite:
./mvnw testTo run the suite against a specific RabbitMQ node, export HOP_RABBITMQCTL
and HOP_RABBITMQ_PLUGINS to point at rabbitmqctl and rabbitmq-plugins
from the installation.
Then set up the node that is assumed to be running:
./ci/before-build.shThis will enable several plugins used by the test suite and configure the node to use a much shorter event refresh interval so that HTTP API reflects system state changes with less of a delay.
To run the tests:
./mvnw testThe test suite assumes RabbitMQ is running locally with stock settings and a few plugins are enabled:
-
rabbitmq_management(listening on port 15672) -
rabbitmq_shovel_management -
rabbitmq_federation_management
To run the suite against a specific RabbitMQ node, export HOP_RABBITMQCTL
and HOP_RABBITMQ_PLUGINS
to point at rabbitmqctl and rabbitmq-plugins from the installation.
The test suite can use a different port than 15672 by specifying it with the
rabbitmq.management.port system property:
./mvnw test -Drabbitmq.management.port=15673This library uses semantic versioning.
See the RabbitMQ Java libraries support page for the support timeline of this library.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent