Red Hat Summit Red Hat SummitSupportConsoleDéveloppeursCommencer un essaiContact

Ce contenu n'est pas disponible dans la langue sélectionnée.

46.5. Configuring the Client Endpoint

Overview
Copier lien

It is possible to augment the functionality of the base javax.ws.rs.client.Client object by registering and configuring features and providers.

Example
Copier lien

The following example shows a client configured to have a logging feature, a custom entity provider, and to set the prettyLogging property to true: 
// Java
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Client;
import org.apache.cxf.feature.LoggingFeature;
...
Client client = ClientBuilder.newClient();
client.register(LoggingFeature.class)
      .register(MyCustomEntityProvider.class)
      .property("LoggingFeature.prettyLogging","true");
Copy to Clipboard Toggle word wrap

Configurable API for registering objects
Copier lien

The Client class supports the Configurable API for registering objects, which provides several variants of the register method. In most cases, you would register either a class or an object instance, as shown in the following examples: 
client.register(LoggingFeature.class)
client.register(new LoggingFeature())
Copy to Clipboard Toggle word wrap
For more details about the register variants, see the reference documentation for Configurable.

What can you configure on the client?
Copier lien

You can configure the following aspects of a client endpoint:
  • Features
  • Providers
  • Properties
  • Filters
  • Interceptors

Features
Copier lien

A javax.ws.rs.core.Feature is effectively a plug-in that adds an extra feature or functionality to a JAX-RS client. Often, a feature installs one or more interceptors in order to provide the required functionality.

Providers
Copier lien

A provider is a particular kind of client plug-in that provides a mapping capability. The JAX-RS 2.0 specification defines the following kinds of provider:
Entity providers
An entity provider provides the capability of mapping between a specific media type a Java type. For more details, see Section 46.4, “Parsing Requests and Responses”.
Exception mapping providers
An exception mapping provider maps a checked runtime exception to an instance of Response.
Context providers
A context provider is used on the server side, to supply context to resource classes and other service providers.

Filters
Copier lien

A JAX-RS 2.0 filter is a plug-in that gives you access to the URI, headers, and miscellaneous context data at various points (extension points) of the message processing pipeline. For details, see Chapter 58, JAX-RS 2.0 Filters and Interceptors.

Interceptors
Copier lien

A JAX-RS 2.0 interceptor is a plug-in that gives you access to the message body of a request or response as it is being read or written. For details, see Chapter 58, JAX-RS 2.0 Filters and Interceptors.

Properties
Copier lien

By setting one or more properties on the client, you can customize the configuration of a registered feature or a registered provider.

Other configurable types
Copier lien

It is possible, not only to configure a javax.ws.rs.client.Client (and javax.ws.rs.client.ClientBuilder) object, but also a WebTarget object. When you change the configuration of a WebTarget object, the underlying client configuration is deep copied to give the new WebTarget configuration. Hence, it is possible to change the configuration of the WebTarget object without changing the configuration of the original Client object.
Retour au début
Red Hat logoGithubredditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance. Découvrez nos récentes mises à jour.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez le Blog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

Theme

© 2025 Red Hat