Package com.linecorp.armeria.spring.client

Class ArmeriaHttpExchangeAdapter

java.lang.Object

org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter

com.linecorp.armeria.spring.client.ArmeriaHttpExchangeAdapter

All Implemented Interfaces:

HttpClientAdapter, HttpExchangeAdapter, ReactorHttpExchangeAdapter

@UnstableApi
public final class ArmeriaHttpExchangeAdapter
extends AbstractReactorHttpExchangeAdapter

A ReactorHttpExchangeAdapter implementation for the Armeria WebClient. This class is used to create Spring HTTP Interface on top of Armeria WebClient.

Example usage:

 import com.linecorp.armeria.client.WebClient;
 import org.springframework.web.service.invoker.HttpServiceProxyFactory;

 WebClient webClient = ...;
 ArmeriaHttpExchangeAdapter adapter =
   ArmeriaHttpExchangeAdapter.of(webClient);
 MyService service =
   HttpServiceProxyFactory.builderFor(adapter)
                          .build()
                          .createClient(MyService.class);
 

Method Summary

Modifier and Type	Method	Description
static ArmeriaHttpExchangeAdapterBuilder	builder(WebClient webClient)	Returns a new ArmeriaHttpExchangeAdapterBuilder with the specified WebClient.
Mono<ResponseEntity<Void>>	exchangeForBodilessEntityMono(HttpRequestValues requestValues)
<T> Flux<T>	exchangeForBodyFlux(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType)
<T> Mono<T>	exchangeForBodyMono(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType)
<T> Mono<ResponseEntity<Flux<T>>>	exchangeForEntityFlux(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType)
<T> Mono<ResponseEntity<T>>	exchangeForEntityMono(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType)
Mono<HttpHeaders>	exchangeForHeadersMono(HttpRequestValues requestValues)
Mono<Void>	exchangeForMono(HttpRequestValues requestValues)
static ArmeriaHttpExchangeAdapter	of(WebClient webClient)	Creates a new instance with the specified WebClient.
boolean	supportsRequestAttributes()	Returns true because Armeria supports RequestAttribute.

Methods inherited from class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter

exchange, exchangeForBodilessEntity, exchangeForBody, exchangeForEntity, exchangeForHeaders, getBlockTimeout, getReactiveAdapterRegistry, requestToBodilessEntity, requestToBody, requestToBodyFlux, requestToEntity, requestToEntityFlux, requestToHeaders, requestToVoid, setBlockTimeout, setReactiveAdapterRegistry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.web.service.invoker.HttpClientAdapter

asReactorExchangeAdapter

Method Details

of

public static ArmeriaHttpExchangeAdapter of(WebClient webClient)

Creates a new instance with the specified WebClient.

builder

public static ArmeriaHttpExchangeAdapterBuilder builder(WebClient webClient)

Returns a new ArmeriaHttpExchangeAdapterBuilder with the specified WebClient.

exchangeForMono

public Mono<Void> exchangeForMono(HttpRequestValues requestValues)

exchangeForHeadersMono

public Mono<HttpHeaders> exchangeForHeadersMono(HttpRequestValues requestValues)

exchangeForBodyMono

public <T> Mono<T> exchangeForBodyMono(HttpRequestValues requestValues,
 ParameterizedTypeReference<T> bodyType)

exchangeForBodyFlux

public <T> Flux<T> exchangeForBodyFlux(HttpRequestValues requestValues,
 ParameterizedTypeReference<T> bodyType)

exchangeForBodilessEntityMono

public Mono<ResponseEntity<Void>> exchangeForBodilessEntityMono(HttpRequestValues requestValues)

exchangeForEntityMono

public <T> Mono<ResponseEntity<T>> exchangeForEntityMono(HttpRequestValues requestValues,
 ParameterizedTypeReference<T> bodyType)

exchangeForEntityFlux

public <T> Mono<ResponseEntity<Flux<T>>> exchangeForEntityFlux(HttpRequestValues requestValues,
 ParameterizedTypeReference<T> bodyType)

supportsRequestAttributes

public boolean supportsRequestAttributes()

Returns true because Armeria supports RequestAttribute. The attributes can be accessed in the Armeria decorators using RequestAttributeAccess.get(ClientRequestContext, String).