org.sdase.commons.client.jersey.builder

Class PlatformClientBuilder

java.lang.Object

org.sdase.commons.client.jersey.builder.PlatformClientBuilder

public class PlatformClientBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PlatformClientBuilder(io.dropwizard.setup.Environment environment, HttpClientConfiguration httpClientConfiguration, io.opentracing.Tracer tracer, java.lang.String consumerToken)

Method Summary

Modifier and Type	Method and Description
T	addFilter(javax.ws.rs.client.ClientRequestFilter clientRequestFilter) Adds a request filter to the client.
<A> ApiClientBuilder<A>	api(java.lang.Class<A> apiInterface) Creates a client proxy implementation for accessing another service.
<A> ApiClientBuilder<A>	api(java.lang.Class<A> apiInterface, java.lang.String customName) Creates a client proxy implementation for accessing another service.
javax.ws.rs.client.Client	buildGenericClient(java.lang.String name) Builds a generic client that can be used for Http requests.
T	disableFollowRedirects() Set this client to not follow redirects and therewith automatically resolve 3xx status codes
PlatformClientBuilder	enableAuthenticationPassThrough() If authentication pass through is enabled, the JWT in the "Authorization" header of an incoming request will be added to the outgoing request.
PlatformClientBuilder	enableConsumerToken() If consumer token is enabled, the client will create a configured consumer token and add it as header to the outgoing request.
T	withConnectionTimeout(java.time.Duration connectionTimeout) Deprecated. The client is now configurable with the Dropwizard configuration. Please use HttpClientConfiguration.setConnectionTimeout(io.dropwizard.util.Duration) instead.
T	withReadTimeout(java.time.Duration readTimeout) Deprecated. The client is now configurable with the Dropwizard configuration. Please use HttpClientConfiguration.setTimeout(io.dropwizard.util.Duration) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlatformClientBuilder

public PlatformClientBuilder(io.dropwizard.setup.Environment environment,
                             HttpClientConfiguration httpClientConfiguration,
                             io.opentracing.Tracer tracer,
                             java.lang.String consumerToken)

Method Detail

enableAuthenticationPassThrough

public PlatformClientBuilder enableAuthenticationPassThrough()

If authentication pass through is enabled, the JWT in the "Authorization" header of an incoming request will be added to the outgoing request.

Returns:

this builder instance

enableConsumerToken

public PlatformClientBuilder enableConsumerToken()

If consumer token is enabled, the client will create a configured consumer token and add it as header to the outgoing request.

Returns:

this builder instance

addFilter

public T addFilter(javax.ws.rs.client.ClientRequestFilter clientRequestFilter)

Adds a request filter to the client.

Parameters:

clientRequestFilter - the filter to add

Returns:

this builder instance

withConnectionTimeout

@Deprecated
public T withConnectionTimeout(java.time.Duration connectionTimeout)

Deprecated. The client is now configurable with the Dropwizard configuration. Please use HttpClientConfiguration.setConnectionTimeout(io.dropwizard.util.Duration) instead.

Sets the connection timeout for the clients that are built with this instance. The connection timeout is the amount of time to wait until the connection to the server is established. The default is 500ms.

If the connection timeout is overdue a ProcessingException wrapping a ConnectTimeoutException is thrown by the client.

Parameters:

connectionTimeout - the time to wait until a connection to the remote service is established

Returns:

this builder instance

withReadTimeout

@Deprecated
public T withReadTimeout(java.time.Duration readTimeout)

Deprecated. The client is now configurable with the Dropwizard configuration. Please use HttpClientConfiguration.setTimeout(io.dropwizard.util.Duration) instead.

Sets the read timeout for the clients that are built with this instance. The read timeout is the timeout to wait for data in an established connection. Usually this timeout is violated when the client has sent the request and is waiting for the first byte of the response while the server is doing calculations, accessing a database or delegating to other services. The default is 2000ms. The read timeout should be set wisely according to the use case considering how long a user is willing to wait and how long backend operations need.

If the connection timeout is overdue a ProcessingException wrapping a SocketTimeoutException is thrown by the client.

Parameters:

readTimeout - the time to wait for content in an established connection

Returns:

this builder instance

disableFollowRedirects

public T disableFollowRedirects()

Set this client to not follow redirects and therewith automatically resolve 3xx status codes

Returns:

this builder instance

buildGenericClient

public javax.ws.rs.client.Client buildGenericClient(java.lang.String name)

Builds a generic client that can be used for Http requests.

Parameters:

name - the name of the client is used for metrics and thread names

Returns:

the client instance

api

public <A> ApiClientBuilder<A> api(java.lang.Class<A> apiInterface)

Creates a client proxy implementation for accessing another service.

Type Parameters:

A - the type of the api

Parameters:

apiInterface - the interface that declares the API using JAX-RS annotations.

Returns:

a builder to define the root path of the API for the proxy that is build

api

public <A> ApiClientBuilder<A> api(java.lang.Class<A> apiInterface,
                                   java.lang.String customName)

Creates a client proxy implementation for accessing another service. Allows to set a custom name if required, e.g. if you have multiple clients generated from the same interface.

Type Parameters:

A - the type of the api

Parameters:

apiInterface - the interface that declares the API using JAX-RS annotations.

customName - the custom name to use for the client. The name is used for the executor service and metrics. Names have to be unique.

Returns:

a builder to define the root path of the API for the proxy that is build