-
- All Superinterfaces:
- Configurable<Client>
public interface Client extends Configurable<Client>
Client is the main entry point to the fluent API used to build and execute client requests in order to consume responses returned. Clients are heavy-weight objects that manage the client-side communication infrastructure. Initialization as well as disposal of aClient
instance may be a rather expensive operation. It is therefore advised to construct only a small number ofClient
instances in the application. Client instances must beproperly closed
before being disposed to avoid leaking resources.- Since:
- 2.0
- Author:
- Marek Potociar
- See Also:
Configurable
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description void
close()
Close client instance and all it's associated resources.HostnameVerifier
getHostnameVerifier()
Get the hostname verifier configured in the client ornull
in case no hostname verifier has been configured.SSLContext
getSslContext()
Get the SSL context configured to be used with the current client run-time.Invocation.Builder
invocation(Link link)
Build an invocation builder from a link.WebTarget
target(Link link)
Build a new web resource target.WebTarget
target(String uri)
Build a new web resource target.WebTarget
target(URI uri)
Build a new web resource target.WebTarget
target(UriBuilder uriBuilder)
Build a new web resource target.
-
-
-
Method Detail
-
close
void close()
Close client instance and all it's associated resources. Subsequent calls have no effect and are ignored. Once the client is closed, invoking any other method on the client instance would result in anIllegalStateException
being thrown. Calling this method effectively invalidates allresource targets
produced by the client instance. Invoking any method on such targets once the client is closed would result in anIllegalStateException
being thrown.
-
target
WebTarget target(String uri)
Build a new web resource target.- Parameters:
uri
- web resource URI. May contain template parameters. Must not benull
.- Returns:
- web resource target bound to the provided URI.
- Throws:
IllegalArgumentException
- in case the supplied string is not a valid URI template.NullPointerException
- in case the supplied argument isnull
.
-
target
WebTarget target(URI uri)
Build a new web resource target.- Parameters:
uri
- web resource URI. Must not benull
.- Returns:
- web resource target bound to the provided URI.
- Throws:
NullPointerException
- in case the supplied argument isnull
.
-
target
WebTarget target(UriBuilder uriBuilder)
Build a new web resource target.- Parameters:
uriBuilder
- web resource URI represented as URI builder. Must not benull
.- Returns:
- web resource target bound to the provided URI.
- Throws:
NullPointerException
- in case the supplied argument isnull
.
-
target
WebTarget target(Link link)
Build a new web resource target.- Parameters:
link
- link to a web resource. Must not benull
.- Returns:
- web resource target bound to the linked web resource.
- Throws:
NullPointerException
- in case the supplied argument isnull
.
-
invocation
Invocation.Builder invocation(Link link)
Build an invocation builder from a link. It uses the URI and the type of the link to initialize the invocation builder. The type is used as the initial value for the HTTP Accept header, if present.
- Parameters:
link
- link to build invocation from. Must not benull
.- Returns:
- newly created invocation builder.
- Throws:
NullPointerException
- in case link isnull
.
-
getSslContext
SSLContext getSslContext()
Get the SSL context configured to be used with the current client run-time.- Returns:
- SSL context configured to be used with the current client run-time.
-
getHostnameVerifier
HostnameVerifier getHostnameVerifier()
Get the hostname verifier configured in the client ornull
in case no hostname verifier has been configured.- Returns:
- client hostname verifier or
null
if not set.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 15:07:45 Cette version de la page est en cache (à la date du 21/08/2025 15:07:45) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/ws/rs/client/Client.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.