com.oracle.bmc.common

Class ClientBuilderBase<B extends ClientBuilderBase,C>

java.lang.Object

com.oracle.bmc.common.ClientBuilderBase<B,C>

Type Parameters:

B - actual class of the builder

Direct Known Subclasses:

AbstractStreamBasedClientBuilder, AbstractVaultBasedClientBuilder, IdentityDomainsAsyncClient.Builder, IdentityDomainsClient.Builder, RegionalClientBuilder

public abstract class ClientBuilderBase<B extends ClientBuilderBase,C>
extends Object

Base client builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ClientConfigurator>	additionalClientConfigurators
protected ClientConfigurator	clientConfigurator
protected ClientConfiguration	configuration
protected String	endpoint
protected RequestSignerFactory	requestSignerFactory
protected RestClientFactoryBuilder	restClientFactoryBuilder
protected Service	service
protected Map<SigningStrategy,RequestSignerFactory>	signingStrategyRequestSignerFactories

Constructor Summary

Constructors

Constructor and Description
ClientBuilderBase(Service service)

Method Summary

Modifier and Type	Method and Description
B	additionalClientConfigurator(ClientConfigurator additionalClientConfigurator) Add an additional client configurator to be run after the primary configurator.
abstract C	build(AbstractAuthenticationDetailsProvider authenticationDetailsProvider) Set the authentication details provider.
B	clientConfigurator(ClientConfigurator clientConfigurator) Set the client configurator.
B	configuration(ClientConfiguration configuration) Set the configuration.
B	endpoint(String endpoint) Set the endpoint for the client to be created.
B	requestSignerFactory(RequestSignerFactory requestSignerFactory) Set the request signer factory.
B	restClientFactoryBuilder(RestClientFactoryBuilder restClientFactoryBuilder) Set the builder for the RestClientFactory.
B	signingStrategyRequestSignerFactories(Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories) Set the request signer factories for each signing strategy.

Methods inherited from class java.lang.Object

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

Field Detail

service

protected final Service service

configuration

protected ClientConfiguration configuration

clientConfigurator

protected ClientConfigurator clientConfigurator

additionalClientConfigurators

protected List<ClientConfigurator> additionalClientConfigurators

requestSignerFactory

protected RequestSignerFactory requestSignerFactory

signingStrategyRequestSignerFactories

protected Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories

endpoint

protected String endpoint

restClientFactoryBuilder

protected RestClientFactoryBuilder restClientFactoryBuilder

Constructor Detail

ClientBuilderBase

public ClientBuilderBase(Service service)

Method Detail

configuration

public B configuration(ClientConfiguration configuration)

Set the configuration. May be null.

Parameters:

configuration - configuration. May be null.

Returns:

this builder

clientConfigurator

public B clientConfigurator(ClientConfigurator clientConfigurator)

Set the client configurator. May be null.

Parameters:

clientConfigurator - client configurator. May be null.

Returns:

this builder

additionalClientConfigurator

public B additionalClientConfigurator(@Nonnull
                                      ClientConfigurator additionalClientConfigurator)

Add an additional client configurator to be run after the primary configurator.

Parameters:

additionalClientConfigurator - the additional client configurator

Returns:

this builder

requestSignerFactory

public B requestSignerFactory(RequestSignerFactory requestSignerFactory)

Set the request signer factory. May be null.

Parameters:

requestSignerFactory - request signer factory. May be null.

Returns:

this builder

endpoint

public B endpoint(String endpoint)

Set the endpoint for the client to be created.

Parameters:

endpoint - endpoint

Returns:

this builder

signingStrategyRequestSignerFactories

public B signingStrategyRequestSignerFactories(Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories)

Set the request signer factories for each signing strategy.

Parameters:

signingStrategyRequestSignerFactories - request signer factories for each signing strategy

Returns:

this builder

restClientFactoryBuilder

public B restClientFactoryBuilder(RestClientFactoryBuilder restClientFactoryBuilder)

Set the builder for the RestClientFactory.

Parameters:

restClientFactoryBuilder - the builder for the RestClientFactory.

Returns:

this builder

build

public abstract C build(@Nonnull
                        AbstractAuthenticationDetailsProvider authenticationDetailsProvider)

Set the authentication details provider. Once this is called, the builder can build the client.

Parameters:

authenticationDetailsProvider - authentication details provider

Returns:

a builder that can build the client