public interface RestClientBuilder extends javax.ws.rs.core.Configurable<RestClientBuilder>
Invoking newBuilder()
is intended to always create a new instance,
not use a cached version.
The RestClientBuilder
is a Configurable
class as defined
by JAX-RS. This allows a user to register providers, implementation specific
configuration.
Implementations are expected to implement this class and provide the instance
via the mechanism in RestClientBuilderResolver.instance()
.
Modifier and Type | Method and Description |
---|---|
RestClientBuilder |
baseUrl(URL url)
Specifies the base URL to be used when making requests.
|
<T> T |
build(Class<T> clazz)
Based on the configured RestClientBuilder, creates a new instance of the
given REST interface to invoke API calls against.
|
static RestClientBuilder |
newBuilder() |
static RestClientBuilder newBuilder()
RestClientBuilder baseUrl(URL url)
@Path("/api")
at the interface level and a
url
is given with
http://my-service:8080/service
then all REST calls will be
invoked with a url
of
http://my-service:8080/service/api
in addition to any
@Path
annotations included on the method.url
- the base Url for the service.<T> T build(Class<T> clazz) throws IllegalStateException, RestClientDefinitionException
T
- the type of the interfaceclazz
- the interface that defines REST API methods for useIllegalStateException
- if not all pre-requisites are satisfied for
the builder, this exception may get thrown. For instance, if a URL has
not been set.RestClientDefinitionException
- if the passed-in interface class is
invalid.Copyright © 2017 Eclipse Foundation. All rights reserved.