Ecwid Consul API

Java client for Consul HTTP API (http://consul.io)

License

License

Categories

Categories

consul-api Container Microservices
GroupId

GroupId

com.ecwid.consul
ArtifactId

ArtifactId

consul-api
Last Version

Last Version

1.4.5
Release Date

Release Date

Type

Type

jar
Description

Description

Ecwid Consul API
Java client for Consul HTTP API (http://consul.io)
Project URL

Project URL

https://github.com/Ecwid/consul-api
Source Code Management

Source Code Management

https://github.com/Ecwid/consul-api.git

Download consul-api

How to add to project

<!-- https://jarcasting.com/artifacts/com.ecwid.consul/consul-api/ -->
<dependency>
    <groupId>com.ecwid.consul</groupId>
    <artifactId>consul-api</artifactId>
    <version>1.4.5</version>
</dependency>
// https://jarcasting.com/artifacts/com.ecwid.consul/consul-api/
implementation 'com.ecwid.consul:consul-api:1.4.5'
// https://jarcasting.com/artifacts/com.ecwid.consul/consul-api/
implementation ("com.ecwid.consul:consul-api:1.4.5")
'com.ecwid.consul:consul-api:jar:1.4.5'
<dependency org="com.ecwid.consul" name="consul-api" rev="1.4.5">
  <artifact name="consul-api" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.ecwid.consul', module='consul-api', version='1.4.5')
)
libraryDependencies += "com.ecwid.consul" % "consul-api" % "1.4.5"
[com.ecwid.consul/consul-api "1.4.5"]

Dependencies

runtime (3)

Group / Artifact Type Version
com.google.code.gson : gson jar 2.8.2
org.apache.httpcomponents : httpcore jar 4.4.9
org.apache.httpcomponents : httpclient jar 4.5.5

test (5)

Group / Artifact Type Version
org.junit.jupiter : junit-jupiter-api jar 5.1.0
org.mockito : mockito-core jar 2.23.0
org.hamcrest : hamcrest-library jar 1.3
org.slf4j : slf4j-simple jar 1.7.25
com.pszymczyk.consul : embedded-consul jar 1.0.2

Project Modules

There are no modules declared in this project.

consul-api

Build Status

Java client for Consul HTTP API (http://consul.io)

Supports all API endpoints (http://www.consul.io/docs/agent/http.html), all consistency modes and parameters (tags, datacenters etc.)

How to use

ConsulClient client = new ConsulClient("localhost");

// set KV
byte[] binaryData = new byte[] {1,2,3,4,5,6,7};
client.setKVBinaryValue("someKey", binaryData);

client.setKVValue("com.my.app.foo", "foo");
client.setKVValue("com.my.app.bar", "bar");
client.setKVValue("com.your.app.foo", "hello");
client.setKVValue("com.your.app.bar", "world");

// get single KV for key
Response<GetValue> keyValueResponse = client.getKVValue("com.my.app.foo");
System.out.println(keyValueResponse.getValue().getKey() + ": " + keyValueResponse.getValue().getDecodedValue()); // prints "com.my.app.foo: foo"

// get list of KVs for key prefix (recursive)
Response<List<GetValue>> keyValuesResponse = client.getKVValues("com.my");
keyValuesResponse.getValue().forEach(value -> System.out.println(value.getKey() + ": " + value.getDecodedValue())); // prints "com.my.app.foo: foo" and "com.my.app.bar: bar"

//list known datacenters
Response<List<String>> response = client.getCatalogDatacenters();
System.out.println("Datacenters: " + response.getValue());

// register new service
NewService newService = new NewService();
newService.setId("myapp_01");
newService.setName("myapp");
newService.setTags(Arrays.asList("EU-West", "EU-East"));
newService.setPort(8080);
client.agentServiceRegister(newService);

// register new service with associated health check
NewService newService = new NewService();
newService.setId("myapp_02");
newService.setTags(Collections.singletonList("EU-East"));
newService.setName("myapp");
newService.setPort(8080);

NewService.Check serviceCheck = new NewService.Check();
serviceCheck.setScript("/usr/bin/some-check-script");
serviceCheck.setInterval("10s");
newService.setCheck(serviceCheck);

client.agentServiceRegister(newService);

// query for healthy services based on name (returns myapp_01 and myapp_02 if healthy)
HealthServicesRequest request = HealthServicesRequest.newBuilder()
					.setPassing(true)
					.setQueryParams(QueryParams.DEFAULT)
					.build();
Response<List<HealthService>> healthyServices = client.getHealthServices("myapp", request);

// query for healthy services based on name and tag (returns myapp_01 if healthy)
HealthServicesRequest request = HealthServicesRequest.newBuilder()
					.setTag("EU-West")
					.setPassing(true)
					.setQueryParams(QueryParams.DEFAULT)
					.build();
Response<List<HealthService>> healthyServices = client.getHealthServices("myapp", request);

How to add consul-api into your project

Gradle

compile "com.ecwid.consul:consul-api:1.4.5"

Maven

<dependency>
  <groupId>com.ecwid.consul</groupId>
  <artifactId>consul-api</artifactId>
  <version>1.4.5</version>
</dependency>

How to build from sources

  • Checkout the sources
  • ./gradlew build

Gradle will compile sources, package classes (sources and javadocs too) into jars and run all tests. The build results will located in build/libs/ folder

com.ecwid.consul

Ecwid

Versions

Version
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.1
1.3.0
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.11
1.1.10
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2