Package com.linecorp.armeria.client

Interface RestClient

All Superinterfaces:

ClientBuilderParams, Unwrappable

@UnstableApi
public interface RestClient
extends ClientBuilderParams, Unwrappable

A client designed for calling RESTful APIs conveniently.

Method Summary

Modifier and Type	Method	Description
static RestClientBuilder	builder()	Returns a new RestClientBuilder created without a base URI.
static RestClientBuilder	builder(SessionProtocol protocol, EndpointGroup endpointGroup)	Returns a new RestClientBuilder created with the specified SessionProtocol and base EndpointGroup.
static RestClientBuilder	builder(SessionProtocol protocol, EndpointGroup endpointGroup, String path)	Returns a new RestClientBuilder created with the specified SessionProtocol, base EndpointGroup and path.
static RestClientBuilder	builder(String uri)	Returns a new RestClientBuilder created with the specified base uri.
static RestClientBuilder	builder(String protocol, EndpointGroup endpointGroup)	Returns a new RestClientBuilder created with the specified protocol and base EndpointGroup.
static RestClientBuilder	builder(String protocol, EndpointGroup endpointGroup, String path)	Returns a new RestClientBuilder created with the specified protocol.
static RestClientBuilder	builder(URI uri)	Returns a new RestClientBuilder created with the specified base URI.
default RestClientPreparation	delete(String path)	Sets an HttpMethod.DELETE and the path and returns a fluent request builder.
default RestClientPreparation	get(String path)	Sets an HttpMethod.GET and the path and returns a fluent request builder.
static RestClient	of()	Returns a RestClient without a base URI using the default ClientFactory and the default ClientOptions.
static RestClient	of(WebClient webClient)	Returns a new RestClient with the specified WebClient.
static RestClient	of(SessionProtocol protocol, EndpointGroup endpointGroup)	Returns a new RestClient that connects to the specified EndpointGroup with the specified SessionProtocol using the default ClientFactory and the default ClientOptions.
static RestClient	of(SessionProtocol protocol, EndpointGroup endpointGroup, String path)	Returns a new RestClient that connects to the specified EndpointGroup with the specified SessionProtocol and path using the default ClientFactory and the default ClientOptions.
static RestClient	of(String uri)	Returns a new RestClient that connects to the specified uri using the default options.
static RestClient	of(String protocol, EndpointGroup endpointGroup)	Returns a new RestClient that connects to the specified EndpointGroup with the specified protocol using the default ClientFactory and the default ClientOptions.
static RestClient	of(String protocol, EndpointGroup endpointGroup, String path)	Returns a new RestClient that connects to the specified EndpointGroup with the specified protocol and path using the default ClientFactory and the default ClientOptions.
static RestClient	of(URI uri)	Returns a new RestClient that connects to the specified URI using the default options.
default RestClientPreparation	patch(String path)	Sets an HttpMethod.PATCH and the path and returns a fluent request builder.
RestClientPreparation	path(HttpMethod method, String path)	Sets the HttpMethod and the path and returns a fluent request builder.
default RestClientPreparation	post(String path)	Sets an HttpMethod.POST and the path and returns a fluent request builder.
default RestClientPreparation	put(String path)	Sets an HttpMethod.PUT and the path and returns a fluent request builder.
HttpClient	unwrap()	Unwraps this object and returns the object being decorated.

Methods inherited from interface com.linecorp.armeria.client.ClientBuilderParams

absolutePathRef, clientType, endpointGroup, options, scheme, uri

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

as, equalsIgnoreWrapper, unwrapAll

Method Details

of

static RestClient of()

Returns a RestClient without a base URI using the default ClientFactory and the default ClientOptions.

of

static RestClient of(WebClient webClient)

Returns a new RestClient with the specified WebClient.

of

static RestClient of(String uri)

Returns a new RestClient that connects to the specified uri using the default options.

Parameters:

uri - the URI of the server endpoint

Throws:

IllegalArgumentException - if the uri is not valid or its scheme is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

of

static RestClient of(URI uri)

Returns a new RestClient that connects to the specified URI using the default options.

Parameters:

uri - the URI of the server endpoint

Throws:

IllegalArgumentException - if the uri is not valid or its scheme is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

of

static RestClient of(String protocol,
 EndpointGroup endpointGroup)

Returns a new RestClient that connects to the specified EndpointGroup with the specified protocol using the default ClientFactory and the default ClientOptions.

Parameters:

protocol - the session protocol of the EndpointGroup

endpointGroup - the server EndpointGroup

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

of

static RestClient of(SessionProtocol protocol,
 EndpointGroup endpointGroup)

Returns a new RestClient that connects to the specified EndpointGroup with the specified SessionProtocol using the default ClientFactory and the default ClientOptions.

Parameters:

protocol - the SessionProtocol of the EndpointGroup

endpointGroup - the server EndpointGroup

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

of

static RestClient of(String protocol,
 EndpointGroup endpointGroup,
 String path)

Returns a new RestClient that connects to the specified EndpointGroup with the specified protocol and path using the default ClientFactory and the default ClientOptions.

Parameters:

protocol - the session protocol of the EndpointGroup

endpointGroup - the server EndpointGroup

path - the path to the endpoint

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

of

static RestClient of(SessionProtocol protocol,
 EndpointGroup endpointGroup,
 String path)

Returns a new RestClient that connects to the specified EndpointGroup with the specified SessionProtocol and path using the default ClientFactory and the default ClientOptions.

Parameters:

protocol - the SessionProtocol of the EndpointGroup

endpointGroup - the server EndpointGroup

path - the path to the endpoint

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static RestClientBuilder builder()

Returns a new RestClientBuilder created without a base URI.

builder

static RestClientBuilder builder(String uri)

Returns a new RestClientBuilder created with the specified base uri.

Throws:

IllegalArgumentException - if the uri is not valid or its scheme is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static RestClientBuilder builder(URI uri)

Returns a new RestClientBuilder created with the specified base URI.

Throws:

IllegalArgumentException - if the uri is not valid or its scheme is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static RestClientBuilder builder(String protocol,
 EndpointGroup endpointGroup)

Returns a new RestClientBuilder created with the specified protocol and base EndpointGroup.

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static RestClientBuilder builder(SessionProtocol protocol,
 EndpointGroup endpointGroup)

Returns a new RestClientBuilder created with the specified SessionProtocol and base EndpointGroup.

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static RestClientBuilder builder(String protocol,
 EndpointGroup endpointGroup,
 String path)

Returns a new RestClientBuilder created with the specified protocol. base EndpointGroup and path.

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static RestClientBuilder builder(SessionProtocol protocol,
 EndpointGroup endpointGroup,
 String path)

Returns a new RestClientBuilder created with the specified SessionProtocol, base EndpointGroup and path.

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

get

default RestClientPreparation get(String path)

Sets an HttpMethod.GET and the path and returns a fluent request builder.

 RestClient restClient = RestClient.of("...");
 CompletableFuture<ResponseEntity<Customer>> response =
     restClient.get("/api/v1/customers/{customerId}")
               .pathParam("customerId", "0000001")
               .execute(Customer.class);
 

post

default RestClientPreparation post(String path)

Sets an HttpMethod.POST and the path and returns a fluent request builder.

 RestClient restClient = RestClient.of("...");
 CompletableFuture<ResponseEntity<Result>> response =
     restClient.post("/api/v1/customers")
               .contentJson(new Customer(...))
               .execute(Result.class);
 

put

default RestClientPreparation put(String path)

Sets an HttpMethod.PUT and the path and returns a fluent request builder.

 RestClient restClient = RestClient.of("...");
 CompletableFuture<ResponseEntity<Result>> response =
     restClient.put("/api/v1/customers")
               .contentJson(new Customer(...))
               .execute(Result.class);
 

patch

default RestClientPreparation patch(String path)

Sets an HttpMethod.PATCH and the path and returns a fluent request builder.

 RestClient restClient = RestClient.of("...");
 CompletableFuture<ResponseEntity<Result>> response =
     restClient.patch("/api/v1/customers")
               .contentJson(new Customer(...))
               .execute(Result.class);
 

delete

default RestClientPreparation delete(String path)

Sets an HttpMethod.DELETE and the path and returns a fluent request builder.

 RestClient restClient = RestClient.of("...");
 CompletableFuture<ResponseEntity<Result>> response =
     restClient.delete("/api/v1/customers")
               .pathParam("customerId", "0000001")
               .execute(Result.class);
 

path

RestClientPreparation path(HttpMethod method,
 String path)

Sets the HttpMethod and the path and returns a fluent request builder.

 RestClient restClient = RestClient.of("...");
 CompletableFuture<ResponseEntity<Customer>> response =
     restClient.path(HttpMethod.GET, "/api/v1/customers/{customerId}")
               .pathParam("customerId", "0000001")
               .execute(Customer.class);
 

unwrap

HttpClient unwrap()

Description copied from interface: Unwrappable

Unwraps this object and returns the object being decorated. If this Unwrappable is the innermost object, this method returns itself. For example:

 class Foo implements Unwrappable {}

 class Bar<T extends Unwrappable> extends AbstractUnwrappable<T> {
     Bar(T delegate) {
         super(delegate);
     }
 }

 class Qux<T extends Unwrappable> extends AbstractUnwrappable<T> {
     Qux(T delegate) {
         super(delegate);
     }
 }

 Foo foo = new Foo();
 assert foo.unwrap() == foo;

 Bar<Foo> bar = new Bar<>(foo);
 assert bar.unwrap() == foo;

 Qux<Bar<Foo>> qux = new Qux<>(bar);
 assert qux.unwrap() == bar;
 assert qux.unwrap().unwrap() == foo;
 

Specified by:

unwrap in interface Unwrappable