org.sdase.commons.client.jersey

Class ClientFactory

java.lang.Object

org.sdase.commons.client.jersey.ClientFactory

public class ClientFactory
extends java.lang.Object

A ClientFactory creates Http clients to access services within the SDA Platform or external services.

Method Summary

Modifier and Type	Method and Description
ExternalClientBuilder	externalClient() Starts creation of a client that calls APIs outside of the SDA SE Platform.
ExternalClientBuilder	externalClient(HttpClientConfiguration httpClientConfiguration) Starts creation of a client that calls APIs outside of the SDA SE Platform.
PlatformClientBuilder	platformClient() Starts creation of a client that calls APIs within the SDA SE Platform.
PlatformClientBuilder	platformClient(HttpClientConfiguration httpClientConfiguration) Starts creation of a client that calls APIs within the SDA SE Platform.

Methods inherited from class java.lang.Object

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

Method Detail

platformClient

public PlatformClientBuilder platformClient()

Starts creation of a client that calls APIs within the SDA SE Platform. This clients automatically send a Trace-Token from the incoming request or a new Trace-Token to the API resources and can optionally send a Consumer-Token or pass through the Authorization header from the incoming request.

The client is using gzip compression.

Returns:

a builder to configure the client

platformClient

public PlatformClientBuilder platformClient(HttpClientConfiguration httpClientConfiguration)

Starts creation of a client that calls APIs within the SDA SE Platform. This clients automatically send a Trace-Token from the incoming request or a new Trace-Token to the API resources and can optionally send a Consumer-Token or pass through the Authorization header from the incoming request.

Parameters:

httpClientConfiguration - Allows to pass additional configuration for the http client.

Returns:

a builder to configure the client

externalClient

public ExternalClientBuilder externalClient()

Starts creation of a client that calls APIs outside of the SDA SE Platform. This clients does no header magic.

The client is using gzip compression.

Returns:

a builder to configure the client

externalClient

public ExternalClientBuilder externalClient(HttpClientConfiguration httpClientConfiguration)

Starts creation of a client that calls APIs outside of the SDA SE Platform. This clients does no header magic.

Parameters:

httpClientConfiguration - Allows to pass additional configuration for the http client.

Returns:

a builder to configure the client