Package com.oracle.bmc.http.internal

Class RestClientFactory

java.lang.Object

com.oracle.bmc.http.internal.RestClientFactory

public class RestClientFactory
extends Object

RestClientFactory is responsible for creating a new REST client whenever a specific service instance is created.

The factory will configure all of the required filters and configuration options.

Constructor Summary

Constructors

Constructor	Description
RestClientFactory(ClientConfigurator clientConfigurator)	Creates a new REST client factor that allow the given configurator to register any additional handlers it wants to the underlying REST client.

Method Summary

Modifier and Type	Method	Description
RestClient	create(RequestSigner requestSigner)	Deprecated. use create(RequestSigner, Map) instead
RestClient	create(RequestSigner requestSigner, ClientConfiguration configuration)	Deprecated. use create(RequestSigner, Map, ClientConfiguration) instead
RestClient	create(RequestSigner defaultRequestSigner, Map<SigningStrategy,RequestSigner> requestSigners)	Creates a new client that will use the given AuthenticationDetailsProvider.
RestClient	create(RequestSigner defaultRequestSigner, Map<SigningStrategy,RequestSigner> requestSigners, ClientConfiguration configuration)	Creates a new client that will use the given AuthenticationDetailsProvider.
RestClient	create(RequestSigner defaultRequestSigner, Map<SigningStrategy,RequestSigner> requestSigners, ClientConfiguration configuration, boolean isNonBuffering)	Creates a new client that will use the given AuthenticationDetailsProvider and ClientConfiguration.
RestClient	create(RequestSigner defaultRequestSigner, Map<SigningStrategy,RequestSigner> requestSigners, ClientConfiguration configuration, boolean isNonBuffering, JaxRsCircuitBreaker circuitBreaker)	Creates a new client that will use the given AuthenticationDetailsProvider and ClientConfiguration.
RestClient	create(RequestSigner defaultRequestSigner, Map<SigningStrategy,RequestSigner> requestSigners, ClientConfiguration configuration, boolean isNonBuffering, JaxRsCircuitBreaker circuitBreaker, CircuitBreakerConfiguration circuitBreakerConfiguration)	Creates a new client that will use the given AuthenticationDetailsProvider and ClientConfiguration.
ClientConfigurator	getClientConfigurator()
static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()	Deprecated. use com.oracle.bmc.http.Serialization.getObjectMapper() instead

Methods inherited from class java.lang.Object

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

Constructor Detail

RestClientFactory

public RestClientFactory(@Nonnull
                         ClientConfigurator clientConfigurator)

Creates a new REST client factor that allow the given configurator to register any additional handlers it wants to the underlying REST client.

Parameters:

clientConfigurator - The configurator to customize the REST client.

Method Detail

create

@Deprecated
public RestClient create(RequestSigner requestSigner)

Deprecated.

use create(RequestSigner, Map) instead

Creates a new client that will use the given AuthenticationDetailsProvider.

Parameters:

requestSigner - The strategy used to sign requests.

Returns:

A new RestClient instance.

create

@Deprecated
public RestClient create(RequestSigner requestSigner,
                         ClientConfiguration configuration)

Deprecated.

use create(RequestSigner, Map, ClientConfiguration) instead

Creates a new client that will use the given AuthenticationDetailsProvider and ClientConfiguration.

Parameters:

requestSigner - The strategy used to sign requests.

configuration - The client configuration to use, or null for default configuration.

Returns:

A new RestClient instance.

create

public RestClient create(RequestSigner defaultRequestSigner,
                         Map<SigningStrategy,RequestSigner> requestSigners)

Creates a new client that will use the given AuthenticationDetailsProvider.

Parameters:

defaultRequestSigner - The default strategy used to sign requests.

requestSigners - The strategies used to sign requests, per signing strategy.

Returns:

A new RestClient instance.

create

public RestClient create(RequestSigner defaultRequestSigner,
                         Map<SigningStrategy,RequestSigner> requestSigners,
                         ClientConfiguration configuration)

Creates a new client that will use the given AuthenticationDetailsProvider.

Parameters:

defaultRequestSigner - The default strategy used to sign requests.

requestSigners - The strategies used to sign requests, per signing strategy.

configuration - The client configuration to use, or null for default configuration.

Returns:

A new RestClient instance.

create

public RestClient create(RequestSigner defaultRequestSigner,
                         Map<SigningStrategy,RequestSigner> requestSigners,
                         ClientConfiguration configuration,
                         boolean isNonBuffering)

Creates a new client that will use the given AuthenticationDetailsProvider and ClientConfiguration.

Parameters:

defaultRequestSigner - The default strategy used to sign requests.

requestSigners - The strategies used to sign requests, per signing strategy.

configuration - The client configuration to use, or null for default configuration.

isNonBuffering - The boolean value indicating if entities should be buffered

Returns:

A new RestClient instance.

create

public RestClient create(RequestSigner defaultRequestSigner,
                         Map<SigningStrategy,RequestSigner> requestSigners,
                         ClientConfiguration configuration,
                         boolean isNonBuffering,
                         JaxRsCircuitBreaker circuitBreaker)

Creates a new client that will use the given AuthenticationDetailsProvider and ClientConfiguration.

Parameters:

defaultRequestSigner - The default strategy used to sign requests.

requestSigners - The strategies used to sign requests, per signing strategy.

configuration - The client configuration to use, or null for default configuration.

isNonBuffering - The boolean value indicating if entities should be buffered.

circuitBreaker - The circuit breaker to use.

Returns:

A new RestClient instance.

create

public RestClient create(RequestSigner defaultRequestSigner,
                         Map<SigningStrategy,RequestSigner> requestSigners,
                         ClientConfiguration configuration,
                         boolean isNonBuffering,
                         JaxRsCircuitBreaker circuitBreaker,
                         CircuitBreakerConfiguration circuitBreakerConfiguration)

Creates a new client that will use the given AuthenticationDetailsProvider and ClientConfiguration.

Parameters:

defaultRequestSigner - The default strategy used to sign requests.

requestSigners - The strategies used to sign requests, per signing strategy.

configuration - The client configuration to use, or null for default configuration.

isNonBuffering - The boolean value indicating if entities should be buffered.

circuitBreakerConfiguration - The circuit breaker configuration to use.

Returns:

A new RestClient instance.

getObjectMapper

@Deprecated
public static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Deprecated.

use com.oracle.bmc.http.Serialization.getObjectMapper() instead

Returns the ObjectMapper used to handle JSON requests.

Exposed only for internal use.

Returns:

The ObjectMapper used.

getClientConfigurator

public ClientConfigurator getClientConfigurator()