Package com.linecorp.armeria.client.retrofit2

Class ArmeriaRetrofitBuilder

java.lang.Object

com.linecorp.armeria.client.AbstractClientOptionsBuilder

com.linecorp.armeria.client.retrofit2.ArmeriaRetrofitBuilder

public final class ArmeriaRetrofitBuilder
extends AbstractClientOptionsBuilder

A builder that creates a Retrofit which uses WebClient for sending requests.

See Also:

• ArmeriaRetrofit

Method Summary

Modifier and Type	Method	Description
ArmeriaRetrofitBuilder	addCallAdapterFactory(CallAdapter.Factory factory)	Adds the specified call adapter factory for supporting service method return types other than Call.
ArmeriaRetrofitBuilder	addConverterFactory(Converter.Factory factory)	Adds the specified converter factory for serialization and deserialization of objects.
ArmeriaRetrofitBuilder	addHeader(CharSequence name, Object value)	Adds the default HTTP header for an HttpRequest that will be sent by this Client.
ArmeriaRetrofitBuilder	addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)	Adds the default HTTP headers for an HttpRequest that will be sent by this Client.
ArmeriaRetrofitBuilder	auth(AuthToken token)	Sets the AuthToken header using HttpHeaderNames.AUTHORIZATION.
ArmeriaRetrofitBuilder	auth(BasicToken token)	Sets the HTTP basic access authentication header using HttpHeaderNames.AUTHORIZATION.
ArmeriaRetrofitBuilder	auth(OAuth1aToken token)	Sets the OAuth Core 1.0 Revision A header using HttpHeaderNames.AUTHORIZATION.
ArmeriaRetrofitBuilder	auth(OAuth2Token token)	Sets the OAuth 2.0 header using HttpHeaderNames.AUTHORIZATION.
Retrofit	build()	Returns a newly-created Retrofit based on the properties of this builder.
ArmeriaRetrofitBuilder	callbackExecutor(Executor executor)	Sets the Executor on which Callback methods are invoked when returning Call from your service method.
ArmeriaRetrofitBuilder	clearDecorators()	Clears all HTTP-level and RPC-level decorators set so far.
ArmeriaRetrofitBuilder	contextCustomizer(Consumer<? super ClientRequestContext> contextCustomizer)	Adds the specified ClientRequestContext customizer function so that it customizes the context in the thread that initiated the client call.
ArmeriaRetrofitBuilder	decorator(DecoratingHttpClientFunction decorator)	Adds the specified HTTP-level decorator.
ArmeriaRetrofitBuilder	decorator(Function<? super HttpClient,? extends HttpClient> decorator)	Adds the specified HTTP-level decorator.
ArmeriaRetrofitBuilder	endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper)	Sets a Function that remaps an Endpoint into an EndpointGroup.
ArmeriaRetrofitBuilder	factory(ClientFactory factory)	Sets the ClientFactory used for creating a client.
ArmeriaRetrofitBuilder	followRedirects()	Enables automatic redirection.
ArmeriaRetrofitBuilder	followRedirects(RedirectConfig redirectConfig)	Sets the RedirectConfig to enable automatic redirection.
ArmeriaRetrofitBuilder	maxResponseLength(long maxResponseLength)	Sets the maximum allowed length of a server response in bytes.
ArmeriaRetrofitBuilder	nonBaseClientFactory(BiFunction<? super SessionProtocol,? super Endpoint,? extends WebClient> nonBaseClientFactory)	Specifies the BiFunction that creates a new non-base WebClient, which is used for sending requests to other authorities than that of base URL.
<T> ArmeriaRetrofitBuilder	option(ClientOption<T> option, T value)	Adds the specified ClientOption and its value.
<T> ArmeriaRetrofitBuilder	option(ClientOptionValue<T> optionValue)	Adds the specified ClientOptionValue.
ArmeriaRetrofitBuilder	options(ClientOptions options)	Adds the specified ClientOptions.
ArmeriaRetrofitBuilder	options(ClientOptionValue<?>... options)	Adds the specified ClientOptionValues.
ArmeriaRetrofitBuilder	options(Iterable<ClientOptionValue<?>> options)	Adds the specified ClientOptionValues.
ArmeriaRetrofitBuilder	requestAutoAbortDelay(Duration delay)	Sets the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
ArmeriaRetrofitBuilder	requestAutoAbortDelayMillis(long delayMillis)	Sets the amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
ArmeriaRetrofitBuilder	requestIdGenerator(Supplier<RequestId> requestIdGenerator)	Sets the Supplier that generates a RequestId.
ArmeriaRetrofitBuilder	responseTimeout(Duration responseTimeout)	Sets the timeout of a response.
ArmeriaRetrofitBuilder	responseTimeoutMillis(long responseTimeoutMillis)	Sets the timeout of a response in milliseconds.
ArmeriaRetrofitBuilder	responseTimeoutMode(ResponseTimeoutMode responseTimeoutMode)	Sets the ResponseTimeoutMode which determines when a AbstractClientOptionsBuilder.responseTimeout(Duration)} will start to be scheduled.
ArmeriaRetrofitBuilder	rpcDecorator(DecoratingRpcClientFunction decorator)	Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.
ArmeriaRetrofitBuilder	rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)	Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.
ArmeriaRetrofitBuilder	setHeader(CharSequence name, Object value)	Sets the default HTTP header for an HttpRequest that will be sent by this Client.
ArmeriaRetrofitBuilder	setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)	Sets the default HTTP headers for an HttpRequest that will be sent by this Client.
ArmeriaRetrofitBuilder	streaming(boolean streaming)	Sets the streaming flag to make Armeria client fully support Streaming.
ArmeriaRetrofitBuilder	successFunction(SuccessFunction successFunction)	Sets a SuccessFunction that determines whether a request was handled successfully or not.
ArmeriaRetrofitBuilder	validateEagerly(boolean validateEagerly)	When calling Retrofit.create(java.lang.Class<T>) on the resulting Retrofit instance, eagerly validate the configuration of all methods in the supplied interface.
ArmeriaRetrofitBuilder	writeTimeout(Duration writeTimeout)	Sets the timeout of a socket write attempt.
ArmeriaRetrofitBuilder	writeTimeoutMillis(long writeTimeoutMillis)	Sets the timeout of a socket write attempt in milliseconds.

Methods inherited from class com.linecorp.armeria.client.AbstractClientOptionsBuilder

buildOptions, buildOptions, contextHook

Methods inherited from class java.lang.Object

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

Method Details

nonBaseClientFactory

public ArmeriaRetrofitBuilder nonBaseClientFactory(BiFunction<? super SessionProtocol,? super Endpoint,? extends WebClient> nonBaseClientFactory)

Specifies the BiFunction that creates a new non-base WebClient, which is used for sending requests to other authorities than that of base URL. If not specified, the non-base WebClient will have the same options with the base WebClient, which was specified with ArmeriaRetrofit.of(WebClient) or ArmeriaRetrofit.builder(WebClient).

To avoid the overhead of repetitive instantiation of WebClients, the WebClients returned by the specified BiFunction will be cached for each combination of:

• Whether the connection is secured (HTTPS or HTTPS)
• Host name
• Port number

You can use this method to create a customized non-base WebClient, for example to send an additional header, override the timeout or enforce HTTP/1:

 ArmeriaRetrofit.builder("http://example.com/")
                .nonBaseClientFactory((protocol, endpoint) -> {
                    // Enforce HTTP/1.
                    final SessionProtocol actualProtocol =
                            protocol.isTls() ? SessionProtocol.H1 : SessionProtocol.H1C;

                    return WebClient.builder(actualProtocol, endpoint)
                                    // Derive most settings from 'defaultWebClient'.
                                    .factory(defaultWebClient.factory())
                                    .options(defaultWebClient.options())
                                    // Set a custom header.
                                    .setHeader(HttpHeaderNames.AUTHORIZATION,
                                               "bearer my-access-token")
                                    // Override the timeout.
                                    .responseTimeout(Duration.ofSeconds(30))
                                    .build();
                })
                .build();
 

Note that the specified BiFunction is not used for sending requests to the base URL's authority. The default WebClient specified with ArmeriaRetrofit.of(WebClient) or ArmeriaRetrofit.builder(WebClient) will be used instead for such requests:

 // No need to use 'nonBaseClientFactory()' method.
 ArmeriaRetrofit.of(WebClient.builder("http://example.com/")
                             .setHeader(HttpHeaderNames.AUTHORIZATION,
                                        "bearer my-access-token")
                             .build());
 

addConverterFactory

public ArmeriaRetrofitBuilder addConverterFactory(Converter.Factory factory)

Adds the specified converter factory for serialization and deserialization of objects.

See Also:

• Retrofit.Builder.addConverterFactory(Converter.Factory)

addCallAdapterFactory

public ArmeriaRetrofitBuilder addCallAdapterFactory(CallAdapter.Factory factory)

Adds the specified call adapter factory for supporting service method return types other than Call.

See Also:

• Retrofit.Builder.addCallAdapterFactory(CallAdapter.Factory)

callbackExecutor

public ArmeriaRetrofitBuilder callbackExecutor(Executor executor)

Sets the Executor on which Callback methods are invoked when returning Call from your service method.

Note: executor is not used for custom method return types.

See Also:

• Retrofit.Builder.callbackExecutor(Executor)

streaming

public ArmeriaRetrofitBuilder streaming(boolean streaming)

Sets the streaming flag to make Armeria client fully support Streaming. If this flag is false, Armeria client will buffer all data and call a callback after receiving the data completely, even if a service method was annotated with Streaming. By enabling this flag, Armeria client will use the Executor specified with callbackExecutor(Executor) to read the data in a blocking way.

Note: It is not recommended to have the service methods both with and without the Streaming annotation in the same interface. Consider separating them into different interfaces and using different builder to build the service.

See Also:

• Streaming

validateEagerly

public ArmeriaRetrofitBuilder validateEagerly(boolean validateEagerly)

When calling Retrofit.create(java.lang.Class<T>) on the resulting Retrofit instance, eagerly validate the configuration of all methods in the supplied interface.

See Also:

• Retrofit.Builder.validateEagerly(boolean)

build

public Retrofit build()

Returns a newly-created Retrofit based on the properties of this builder.

options

public ArmeriaRetrofitBuilder options(ClientOptions options)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptions.

Overrides:

options in class AbstractClientOptionsBuilder

options

public ArmeriaRetrofitBuilder options(ClientOptionValue<?>... options)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValues.

Overrides:

options in class AbstractClientOptionsBuilder

options

public ArmeriaRetrofitBuilder options(Iterable<ClientOptionValue<?>> options)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValues.

Overrides:

options in class AbstractClientOptionsBuilder

option

public <T> ArmeriaRetrofitBuilder option(ClientOption<T> option,
 T value)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOption and its value.

Overrides:

option in class AbstractClientOptionsBuilder

option

public <T> ArmeriaRetrofitBuilder option(ClientOptionValue<T> optionValue)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValue.

Overrides:

option in class AbstractClientOptionsBuilder

factory

public ArmeriaRetrofitBuilder factory(ClientFactory factory)

Description copied from class: AbstractClientOptionsBuilder

Sets the ClientFactory used for creating a client. The default is ClientFactory.ofDefault().

Overrides:

factory in class AbstractClientOptionsBuilder

writeTimeout

public ArmeriaRetrofitBuilder writeTimeout(Duration writeTimeout)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a socket write attempt.

Overrides:

writeTimeout in class AbstractClientOptionsBuilder

Parameters:

writeTimeout - the timeout. 0 disables the timeout.

writeTimeoutMillis

public ArmeriaRetrofitBuilder writeTimeoutMillis(long writeTimeoutMillis)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a socket write attempt in milliseconds.

Overrides:

writeTimeoutMillis in class AbstractClientOptionsBuilder

Parameters:

writeTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

responseTimeout

public ArmeriaRetrofitBuilder responseTimeout(Duration responseTimeout)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a response.

Overrides:

responseTimeout in class AbstractClientOptionsBuilder

Parameters:

responseTimeout - the timeout. 0 disables the timeout.

responseTimeoutMillis

public ArmeriaRetrofitBuilder responseTimeoutMillis(long responseTimeoutMillis)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a response in milliseconds.

Overrides:

responseTimeoutMillis in class AbstractClientOptionsBuilder

Parameters:

responseTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

maxResponseLength

public ArmeriaRetrofitBuilder maxResponseLength(long maxResponseLength)

Description copied from class: AbstractClientOptionsBuilder

Sets the maximum allowed length of a server response in bytes.

Overrides:

maxResponseLength in class AbstractClientOptionsBuilder

Parameters:

maxResponseLength - the maximum length in bytes. 0 disables the limit.

requestAutoAbortDelay

public ArmeriaRetrofitBuilder requestAutoAbortDelay(Duration delay)

Description copied from class: AbstractClientOptionsBuilder

Sets the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete. This may be useful when you want to send additional data even after the response is complete. Specify Duration.ZERO to abort the HttpRequest immediately. Any negative value will not abort the request automatically. There is no delay by default.

Overrides:

requestAutoAbortDelay in class AbstractClientOptionsBuilder

requestAutoAbortDelayMillis

public ArmeriaRetrofitBuilder requestAutoAbortDelayMillis(long delayMillis)

Description copied from class: AbstractClientOptionsBuilder

Sets the amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete. This may be useful when you want to send additional data even after the response is complete. Specify 0 to abort the HttpRequest immediately. Any negative value will not abort the request automatically. There is no delay by default.

Overrides:

requestAutoAbortDelayMillis in class AbstractClientOptionsBuilder

requestIdGenerator

public ArmeriaRetrofitBuilder requestIdGenerator(Supplier<RequestId> requestIdGenerator)

Description copied from class: AbstractClientOptionsBuilder

Sets the Supplier that generates a RequestId.

Overrides:

requestIdGenerator in class AbstractClientOptionsBuilder

successFunction

public ArmeriaRetrofitBuilder successFunction(SuccessFunction successFunction)

Description copied from class: AbstractClientOptionsBuilder

Sets a SuccessFunction that determines whether a request was handled successfully or not. If unspecified, SuccessFunction.ofDefault() is used.

Overrides:

successFunction in class AbstractClientOptionsBuilder

endpointRemapper

public ArmeriaRetrofitBuilder endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper)

Description copied from class: AbstractClientOptionsBuilder

Sets a Function that remaps an Endpoint into an EndpointGroup. This ClientOption is useful when you need to override a single target host into a group of hosts to enable client-side load-balancing, e.g.

 MyService.Iface client =
     Clients.newClient("tbinary+http://example.com/api",
                       MyService.Iface.class);

 EndpointGroup myGroup = EndpointGroup.of(Endpoint.of("node-1.example.com")),
                                          Endpoint.of("node-2.example.com")));

 MyService.Iface derivedClient =
     Clients.newDerivedClient(client, options -> {
         return options.toBuilder()
                       .endpointRemapper(endpoint -> {
                           if (endpoint.host().equals("example.com")) {
                               return myGroup;
                           } else {
                               return endpoint;
                           }
                       })
                       .build();
     });

 // This request goes to 'node-1.example.com' or 'node-2.example.com'.
 derivedClient.call();
 

Note that the remapping does not occur recursively but only once.

Overrides:

endpointRemapper in class AbstractClientOptionsBuilder

See Also:

• ClientOptions.ENDPOINT_REMAPPER
• ClientOptions.endpointRemapper()

decorator

public ArmeriaRetrofitBuilder decorator(Function<? super HttpClient,? extends HttpClient> decorator)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified HTTP-level decorator.

Overrides:

decorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the Function that transforms an HttpClient to another

decorator

public ArmeriaRetrofitBuilder decorator(DecoratingHttpClientFunction decorator)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified HTTP-level decorator.

Overrides:

decorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the DecoratingHttpClientFunction that intercepts an invocation

clearDecorators

public ArmeriaRetrofitBuilder clearDecorators()

Description copied from class: AbstractClientOptionsBuilder

Clears all HTTP-level and RPC-level decorators set so far.

Overrides:

clearDecorators in class AbstractClientOptionsBuilder

rpcDecorator

public ArmeriaRetrofitBuilder rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)

Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.

Overrides:

rpcDecorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the Function that transforms an RpcClient to another

rpcDecorator

public ArmeriaRetrofitBuilder rpcDecorator(DecoratingRpcClientFunction decorator)

Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.

Overrides:

rpcDecorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the DecoratingRpcClientFunction that intercepts an invocation

addHeader

public ArmeriaRetrofitBuilder addHeader(CharSequence name,
 Object value)

Description copied from class: AbstractClientOptionsBuilder

Adds the default HTTP header for an HttpRequest that will be sent by this Client.

Note that the values of the default HTTP headers could be overridden if the same HttpHeaderNames are defined in the HttpRequest.headers() or ClientRequestContext.additionalRequestHeaders().

Overrides:

addHeader in class AbstractClientOptionsBuilder

addHeaders

public ArmeriaRetrofitBuilder addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from class: AbstractClientOptionsBuilder

Adds the default HTTP headers for an HttpRequest that will be sent by this Client.

Note that the values of the default HTTP headers could be overridden if the same HttpHeaderNames are defined in the HttpRequest.headers() or ClientRequestContext.additionalRequestHeaders().

Overrides:

addHeaders in class AbstractClientOptionsBuilder

setHeader

public ArmeriaRetrofitBuilder setHeader(CharSequence name,
 Object value)

Description copied from class: AbstractClientOptionsBuilder

Sets the default HTTP header for an HttpRequest that will be sent by this Client.

Note that the default HTTP header could be overridden if the same HttpHeaderNames are defined in HttpRequest.headers() or ClientRequestContext.additionalRequestHeaders().

Overrides:

setHeader in class AbstractClientOptionsBuilder

setHeaders

public ArmeriaRetrofitBuilder setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from class: AbstractClientOptionsBuilder

Sets the default HTTP headers for an HttpRequest that will be sent by this Client.

Note that the values of the default HTTP headers could be overridden if the same HttpHeaderNames are defined in HttpRequest.headers() or ClientRequestContext.additionalRequestHeaders().

Overrides:

setHeaders in class AbstractClientOptionsBuilder

auth

public ArmeriaRetrofitBuilder auth(BasicToken token)

Description copied from class: AbstractClientOptionsBuilder

Sets the HTTP basic access authentication header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

auth

public ArmeriaRetrofitBuilder auth(OAuth1aToken token)

Description copied from class: AbstractClientOptionsBuilder

Sets the OAuth Core 1.0 Revision A header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

auth

public ArmeriaRetrofitBuilder auth(OAuth2Token token)

Description copied from class: AbstractClientOptionsBuilder

Sets the OAuth 2.0 header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

auth

public ArmeriaRetrofitBuilder auth(AuthToken token)

Description copied from class: AbstractClientOptionsBuilder

Sets the AuthToken header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

followRedirects

public ArmeriaRetrofitBuilder followRedirects()

Description copied from class: AbstractClientOptionsBuilder

Enables automatic redirection.

Overrides:

followRedirects in class AbstractClientOptionsBuilder

followRedirects

public ArmeriaRetrofitBuilder followRedirects(RedirectConfig redirectConfig)

Description copied from class: AbstractClientOptionsBuilder

Sets the RedirectConfig to enable automatic redirection.

Overrides:

followRedirects in class AbstractClientOptionsBuilder

contextCustomizer

public ArmeriaRetrofitBuilder contextCustomizer(Consumer<? super ClientRequestContext> contextCustomizer)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientRequestContext customizer function so that it customizes the context in the thread that initiated the client call. The given customizer function is evaluated before the customizer function specified by Clients.withContextCustomizer(Consumer).

 static final ThreadLocal<String> USER_ID = new ThreadLocal<>();
 static final AttributeKey<String> USER_ID_ATTR = AttributeKey.valueOf("USER_ID");
 ...
 MyClientStub client =
     Clients.builder(...)
            .contextCustomizer(ctx -> {
                // This customizer will be invoked from the thread that initiates a client call.
                ctx.setAttr(USER_ID_ATTR, USER_ID.get());
            })
            .build(MyClientStub.class);

 // Good:
 // The context data is set by the thread that initiates the client call.
 USER_ID.set("user1");
 try {
     client.executeSomething1(..);
     ...
     client.executeSomethingN(..);
 } finally {
     // Should clean up the thread local storage.
     USER_ID.remove();
 }

 // Bad:
 USER_ID.set("user1");
 executor.execute(() -> {
     // The variable in USER_ID won't be propagated to the context.
     // The variable is not valid at the moment client.executeSomething1() is called.
      client.executeSomething1(..);
 });
 

Note that certain properties of ClientRequestContext, such as:

• ClientRequestContext.endpoint()
• RequestContext.localAddress()
• RequestContext.remoteAddress()

may be null while the customizer function runs, because the target host of the Request is not determined yet.

Overrides:

contextCustomizer in class AbstractClientOptionsBuilder

See Also:

• Clients.withContextCustomizer(Consumer)

responseTimeoutMode

public ArmeriaRetrofitBuilder responseTimeoutMode(ResponseTimeoutMode responseTimeoutMode)

Description copied from class: AbstractClientOptionsBuilder

Sets the ResponseTimeoutMode which determines when a AbstractClientOptionsBuilder.responseTimeout(Duration)} will start to be scheduled.

Overrides:

responseTimeoutMode in class AbstractClientOptionsBuilder

See Also:

• ResponseTimeoutMode