Package com.linecorp.armeria.client.resteasy

Class ArmeriaJaxrsClientEngine

java.lang.Object

com.linecorp.armeria.client.resteasy.ArmeriaJaxrsClientEngine

All Implemented Interfaces:

Closeable, AutoCloseable, ClientHttpEngine, AsyncClientHttpEngine

@UnstableApi
public class ArmeriaJaxrsClientEngine
extends Object
implements AsyncClientHttpEngine, Closeable

An implementation of AsyncClientHttpEngine based on Armeria WebClient. This provides the main entry point for JAX-RS client-side based on Armeria.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.resteasy.client.jaxrs.engines.AsyncClientHttpEngine

AsyncClientHttpEngine.ResultExtractor<T extends Object>

Constructor Summary

Constructors

Constructor	Description
ArmeriaJaxrsClientEngine(WebClient client)	Constructs ArmeriaJaxrsClientEngine based on WebClient.
ArmeriaJaxrsClientEngine(WebClient client, int bufferSize, Duration readTimeout)	Constructs ArmeriaJaxrsClientEngine based on WebClient and other parameters.

Method Summary

Modifier and Type	Method	Description
void	close()
HostnameVerifier	getHostnameVerifier()	Armeria does not allow to access the HostnameVerifier from WebClient API.
SSLContext	getSslContext()	Armeria does not allow to access the ssl-context from WebClient API.
javax.ws.rs.core.Response	invoke(javax.ws.rs.client.Invocation request)
<T> Future<T>	submit(ClientInvocation request, boolean buffered, javax.ws.rs.client.InvocationCallback<T> callback, AsyncClientHttpEngine.ResultExtractor<T> extractor)
<T> CompletableFuture<T>	submit(ClientInvocation request, boolean buffered, AsyncClientHttpEngine.ResultExtractor<T> extractor, ExecutorService executorService)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.resteasy.client.jaxrs.engines.AsyncClientHttpEngine

submit

Methods inherited from interface org.jboss.resteasy.client.jaxrs.ClientHttpEngine

isFollowRedirects, setFollowRedirects

Constructor Details

ArmeriaJaxrsClientEngine

public ArmeriaJaxrsClientEngine(WebClient client)

Constructs ArmeriaJaxrsClientEngine based on WebClient.

Parameters:

client - WebClient instance to be used by this AsyncClientHttpEngine to facilitate HTTP communications.

ArmeriaJaxrsClientEngine

public ArmeriaJaxrsClientEngine(WebClient client,
int bufferSize,
@Nullable
Duration readTimeout)

Constructs ArmeriaJaxrsClientEngine based on WebClient and other parameters.

Parameters:

client - WebClient instance to be used by this AsyncClientHttpEngine to facilitate HTTP communications.

bufferSize - the size of the buffer used to handle HTTP data output streams, this matches the value previously set to ResteasyClientBuilder.responseBufferSize(int)

readTimeout - response read timeout previously set to ResteasyClientBuilder.readTimeout(long, TimeUnit)

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ClientHttpEngine

Specified by:

close in interface Closeable

getSslContext

@Nullable
public SSLContext getSslContext()

Armeria does not allow to access the ssl-context from WebClient API. This functionality must be achieved by configuring WebClientBuilder.

Specified by:

getSslContext in interface ClientHttpEngine

Throws:

UnsupportedOperationException - always

getHostnameVerifier

@Nullable
public HostnameVerifier getHostnameVerifier()

Armeria does not allow to access the HostnameVerifier from WebClient API. This functionality must be achieved by configuring WebClientBuilder.

Specified by:

getHostnameVerifier in interface ClientHttpEngine

Throws:

UnsupportedOperationException - always

invoke

public javax.ws.rs.core.Response invoke(javax.ws.rs.client.Invocation request)

Specified by:

invoke in interface ClientHttpEngine

submit

public <T> Future<T> submit(ClientInvocation request,
boolean buffered,
@Nullable
javax.ws.rs.client.InvocationCallback<T> callback,
AsyncClientHttpEngine.ResultExtractor<T> extractor)

Specified by:

submit in interface AsyncClientHttpEngine

submit

public <T> CompletableFuture<T> submit(ClientInvocation request,
boolean buffered,
AsyncClientHttpEngine.ResultExtractor<T> extractor,
@Nullable
ExecutorService executorService)

Specified by:

submit in interface AsyncClientHttpEngine