Managing Apicurio Registry content using a Java client
This chapter explains how to use the Apicurio Registry Java client:
Apicurio Registry Java client
You can manage artifacts stored in Apicurio Registry using a Java client application. You can create, read, update, or delete artifacts stored in the registry using the Apicurio Registry Java client classes. You can also perform admin functions using the client, such as managing global rules or importing and exporting registry data.
You can access the Apicurio Registry Java client by adding the correct dependency to your project. For more details, see Writing Apicurio Registry client applications.
The Apicurio Registry client is implemented using the HTTP client provided by the JDK. This gives you the ability to customize its use, for example, by adding custom headers or enabling options for Transport Layer Security (TLS) authentication. For more details, see Apicurio Registry Java client configuration.
Writing Apicurio Registry client applications
This section explains how to manage artifacts stored in Apicurio Registry using a Java client application.
-
Apicurio Registry must be installed and running in your environment
-
Add the following dependency to your Maven project:
<dependency> <groupId>io.apicurio</groupId> <artifactId>apicurio-registry-client</artifactId> <version>${apicurio-registry.version}</version> </dependency>
-
Create a registry client as follows:
public class ClientExample { private static final RegistryRestClient client; public static void main(String[] args) throws Exception { // Create a registry client String registryUrl = "https://my-registry.my-domain.com/apis/registry/v2"; (1) RegistryClient client = RegistryClientFactory.create(registryUrl); (2) } }
1 If you specify an example registry URL of https://my-registry.my-domain.com
, the client will automatically append/apis/registry/v2
.2 For more options when creating a Apicurio Registry client, see the Java client configuration in the next section. -
When the client is created, you can use all the operations from the Apicurio Registry REST API through the client. For more details, see the Apicurio Registry REST API documentation.
-
For an open source example of how to use and customize the Apicurio Registry client, see the Registry REST client demonstration example
-
For details on how to use the Apicurio Registry Kafka client serializers/deserializers (SerDes) in producer and consumer applications, see Validating schemas using Kafka client serializers/deserializers in Java clients
Apicurio Registry Java client configuration
The Apicurio Registry Java client includes the following configuration options, based on the client factory:
Option | Description | Arguments |
---|---|---|
Plain client |
Basic REST client used to interact with a running registry. |
|
Client with custom configuration |
Registry client using the configuration provided by the user. |
|
Client with custom configuration and authentication |
Registry client that accepts a map containing custom configuration. This is useful, for example, to add custom headers to the calls. This also requires providing an |
|
Custom header configuration
To configure custom headers, you must add the apicurio.registry.request.headers
prefix to the configs
map key. For example, a key of apicurio.registry.request.headers.Authorization
with a value of Basic: xxxxx
results in a header of Authorization
with value of Basic: xxxxx
.
TLS configuration options
You can configure Transport Layer Security (TLS) authentication for the Apicurio Registry Java client using the following properties:
-
apicurio.registry.request.ssl.truststore.location
-
apicurio.registry.request.ssl.truststore.password
-
apicurio.registry.request.ssl.truststore.type
-
apicurio.registry.request.ssl.keystore.location
-
apicurio.registry.request.ssl.keystore.password
-
apicurio.registry.request.ssl.keystore.type
-
apicurio.registry.request.ssl.key.password