Top Description Fields Constructors Methods
com.oracle.bmc.common

public abstract Class ClientBuilderBase<B extends ClientBuilderBase, C>

extends Object
Class Inheritance
Known Direct Subclasses
com.oracle.bmc.common.RegionalClientBuilder
Type Parameters
<B>
actual class of the builder
Imports
com.oracle.bmc.ClientConfiguration, .Service, com.oracle.bmc.http.ClientConfigurator, com.oracle.bmc.http.client.HttpProvider, com.oracle.bmc.http.signing.RequestSignerFactory, .SigningStrategy, com.oracle.bmc.http.signing.internal.DefaultRequestSignerFactory, jakarta.annotation.Nonnull, java.util.ArrayList, .Collections, .HashMap, .List, .Map
Base client builder.

Field Summary

Modifier and TypeField and Description
protected List<ClientConfigurator>
additionalClientConfigurators

protected ClientConfigurator
clientConfigurator

protected ClientConfiguration
configuration

protected String
endpoint

pack-priv HttpProvider
httpProvider

protected RequestSignerFactory
requestSignerFactory

pack-priv final Service
service

pack-priv Map<SigningStrategy, RequestSignerFactory>
signingStrategyRequestSignerFactories

Constructor Summary

AccessConstructor and Description
public
ClientBuilderBase(Service service)

Method Summary

Modifier and TypeMethod and Description
public B

Returns:

this builder
additionalClientConfigurator(ClientConfigurator
the additional client configurator
additionalClientConfigurator)

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

public B

Returns:

this builder
additionalClientConfigurators(List<ClientConfigurator>
the additional client configurators
additionalClientConfigurators)

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

public abstract C

Returns:

a builder that can build the client
build(AbstractAuthenticationDetailsProvider
authentication details provider
authenticationDetailsProvider)

Set the authentication details provider.

public B

Returns:

this builder
clientConfigurator(ClientConfigurator
client configurator. May be null.
clientConfigurator)

Set the client configurator.

public B

Returns:

this builder
configuration(ClientConfiguration
configuration. May be null.
configuration)

Set the configuration.

public B

Returns:

this builder, with updated values
copyFrom(B
other builder
fromBuilder)

Set the values in this builder to be the same as in the provided other builder.

public B

Returns:

this builder
endpoint(String
endpoint
endpoint)

Set the endpoint for the client to be created.

public final B
httpProvider(HttpProvider httpProvider)

public B

Returns:

this builder
requestSignerFactory(RequestSignerFactory
request signer factory. May be null.
requestSignerFactory)

Set the request signer factory.

public B

Returns:

this builder
signingStrategyRequestSignerFactories(Map<SigningStrategy, RequestSignerFactory>
request signer factories for each signing strategy
signingStrategyRequestSignerFactories)

Set the request signer factories for each signing strategy.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

additionalClientConfiguratorsback to summary
protected List<ClientConfigurator> additionalClientConfigurators
clientConfiguratorback to summary
protected ClientConfigurator clientConfigurator
configurationback to summary
protected ClientConfiguration configuration
endpointback to summary
protected String endpoint
httpProviderback to summary
pack-priv HttpProvider httpProvider
requestSignerFactoryback to summary
protected RequestSignerFactory requestSignerFactory
serviceback to summary
pack-priv final Service service
signingStrategyRequestSignerFactoriesback to summary
pack-priv Map<SigningStrategy, RequestSignerFactory> signingStrategyRequestSignerFactories

Constructor Detail

ClientBuilderBaseback to summary
public ClientBuilderBase(Service service)

Method Detail

additionalClientConfiguratorback to summary
public B additionalClientConfigurator(ClientConfigurator additionalClientConfigurator)

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

Parameters
additionalClientConfigurator:ClientConfigurator

the additional client configurator

Returns:B

this builder

additionalClientConfiguratorsback to summary
public B additionalClientConfigurators(List<ClientConfigurator> additionalClientConfigurators)

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

Parameters
additionalClientConfigurators:List<ClientConfigurator>

the additional client configurators

Returns:B

this builder

buildback to summary
public abstract C build(AbstractAuthenticationDetailsProvider authenticationDetailsProvider)

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

Parameters
authenticationDetailsProvider:AbstractAuthenticationDetailsProvider

authentication details provider

Returns:C

a builder that can build the client

clientConfiguratorback to summary
public B clientConfigurator(ClientConfigurator clientConfigurator)

Set the client configurator. May be null.

Parameters
clientConfigurator:ClientConfigurator

client configurator. May be null.

Returns:B

this builder

configurationback to summary
public B configuration(ClientConfiguration configuration)

Set the configuration. May be null.

Parameters
configuration:ClientConfiguration

configuration. May be null.

Returns:B

this builder

copyFromback to summary
public B copyFrom(B fromBuilder)

Set the values in this builder to be the same as in the provided other builder.

Parameters
fromBuilder:B

other builder

Returns:B

this builder, with updated values

endpointback to summary
public B endpoint(String endpoint)

Set the endpoint for the client to be created.

Parameters
endpoint:String

endpoint

Returns:B

this builder

httpProviderback to summary
public final B httpProvider(HttpProvider httpProvider)
requestSignerFactoryback to summary
public B requestSignerFactory(RequestSignerFactory requestSignerFactory)

Set the request signer factory. May be null.

Parameters
requestSignerFactory:RequestSignerFactory

request signer factory. May be null.

Returns:B

this builder

signingStrategyRequestSignerFactoriesback to summary
public B signingStrategyRequestSignerFactories(Map<SigningStrategy, RequestSignerFactory> signingStrategyRequestSignerFactories)

Set the request signer factories for each signing strategy.

Parameters
signingStrategyRequestSignerFactories:Map<SigningStrategy, RequestSignerFactory>

request signer factories for each signing strategy

Returns:B

this builder