com.ibm.cloud.objectstorage.client.builder

Class AwsClientBuilder<Subclass extends AwsClientBuilder,TypeToBuild>

java.lang.Object

com.ibm.cloud.objectstorage.client.builder.AwsClientBuilder<Subclass,TypeToBuild>

Type Parameters:

Subclass - Concrete builder type, used for better fluent methods.

TypeToBuild - Type that this builder builds.

Direct Known Subclasses:

AwsAsyncClientBuilder, AwsSyncClientBuilder

@NotThreadSafe
public abstract class AwsClientBuilder<Subclass extends AwsClientBuilder,TypeToBuild>
extends Object

Base class for all service specific client builders.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AwsClientBuilder.EndpointConfiguration A container for configuration required to submit requests to a service (service endpoint and signing region)
protected class	AwsClientBuilder.SyncBuilderParams Presents a view of the builder to be used in a client constructor.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AwsClientBuilder(ClientConfigurationFactory clientConfigFactory)
protected	AwsClientBuilder(ClientConfigurationFactory clientConfigFactory, AwsRegionProvider regionProvider)

Method Summary

Modifier and Type	Method and Description
abstract TypeToBuild	build() Builds a client with the configure properties.
ClientConfiguration	getClientConfiguration() Gets the ClientConfiguration currently configured in the builder
AWSCredentialsProvider	getCredentials() Gets the AWSCredentialsProvider currently configured in the builder.
AwsClientBuilder.EndpointConfiguration	getEndpoint() Gets the service endpointConfiguration in use by the builder
RequestMetricCollector	getMetricsCollector() Gets the RequestMetricCollector in use by the builder.
String	getRegion() Gets the region in use by the builder.
List<RequestHandler2>	getRequestHandlers() Gets the list of request handlers in use by the builder.
protected Subclass	getSubclass()
protected AwsSyncClientParams	getSyncClientParams()
void	setClientConfiguration(ClientConfiguration config) Sets the ClientConfiguration to be used by the client.
void	setCredentials(AWSCredentialsProvider credentialsProvider) Sets the AWSCredentialsProvider used by the client.
void	setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration) Sets the endpoint configuration (service endpoint & signing region) to be used for requests.
void	setMetricsCollector(RequestMetricCollector metrics) Sets a custom RequestMetricCollector to use for the client.
void	setRegion(String region) Sets the region to be used by the client.
void	setRequestHandlers(RequestHandler2... handlers) Sets the request handlers to use in the client.
Subclass	withClientConfiguration(ClientConfiguration config) Sets the ClientConfiguration to be used by the client.
Subclass	withCredentials(AWSCredentialsProvider credentialsProvider) Sets the AWSCredentialsProvider used by the client.
Subclass	withEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration) Sets the endpoint configuration (service endpoint & signing region) to be used for requests.
Subclass	withIAMEndpoint(String iamEndpoint) Sets the IAM endpoint to use for token retrieval by the DefaultTokenManager and the DefaultTokenProvider.
Subclass	withIAMMaxRetry(int retryCount) Sets the maximum number of attempts for retrieving/refreshing IAM token by the DefaultTokenManager.
Subclass	withIAMTokenRefresh(double offset) Sets the time offset used for IAM token refresh by the DefaultTokenManager.
Subclass	withMetricsCollector(RequestMetricCollector metrics) Sets a custom RequestMetricCollector to use for the client.
Subclass	withRegion(Regions region) Sets the region to be used by the client.
Subclass	withRegion(String region) Sets the region to be used by the client.
Subclass	withRequestHandlers(RequestHandler2... handlers) Sets the request handlers to use in the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

AwsClientBuilder

protected AwsClientBuilder(ClientConfigurationFactory clientConfigFactory)

AwsClientBuilder

protected AwsClientBuilder(ClientConfigurationFactory clientConfigFactory,
                           AwsRegionProvider regionProvider)

Method Detail

getCredentials

public final AWSCredentialsProvider getCredentials()

Gets the AWSCredentialsProvider currently configured in the builder.

setCredentials

public final void setCredentials(AWSCredentialsProvider credentialsProvider)

Sets the AWSCredentialsProvider used by the client. If not specified the default is DefaultAWSCredentialsProviderChain.

Parameters:

credentialsProvider - New AWSCredentialsProvider to use.

withCredentials

public final Subclass withCredentials(AWSCredentialsProvider credentialsProvider)

Sets the AWSCredentialsProvider used by the client. If not specified the default is DefaultAWSCredentialsProviderChain.

Parameters:

credentialsProvider - New AWSCredentialsProvider to use.

Returns:

This object for method chaining.

withIAMEndpoint

public Subclass withIAMEndpoint(String iamEndpoint)

Sets the IAM endpoint to use for token retrieval by the DefaultTokenManager and the DefaultTokenProvider. This should only be over written for a dev or staging environment

Parameters:

iamEndpoint, - http endpoint for token retrieval

Returns:

This object for method chaining.

withIAMTokenRefresh

public Subclass withIAMTokenRefresh(double offset)

Sets the time offset used for IAM token refresh by the DefaultTokenManager. This should only be over written for a dev or staging environment

Parameters:

offset, - percentage of token life before expiration that token should be refreshed.

Returns:

This object for method chaining.

withIAMMaxRetry

public Subclass withIAMMaxRetry(int retryCount)

Sets the maximum number of attempts for retrieving/refreshing IAM token by the DefaultTokenManager. This should only be over written for a dev or staging environment

Parameters:

offset, - offset in seconds from token expiry time.

Returns:

This object for method chaining.

getClientConfiguration

public final ClientConfiguration getClientConfiguration()

Gets the ClientConfiguration currently configured in the builder

setClientConfiguration

public final void setClientConfiguration(ClientConfiguration config)

Sets the ClientConfiguration to be used by the client. If not specified the default is typically PredefinedClientConfigurations.defaultConfig() but may differ per service.

Parameters:

config - Custom configuration to use

withClientConfiguration

public final Subclass withClientConfiguration(ClientConfiguration config)

Sets the ClientConfiguration to be used by the client. If not specified the default is typically PredefinedClientConfigurations.defaultConfig() but may differ per service.

Parameters:

config - Custom configuration to use

Returns:

This object for method chaining.

getMetricsCollector

public final RequestMetricCollector getMetricsCollector()

Gets the RequestMetricCollector in use by the builder.

setMetricsCollector

public final void setMetricsCollector(RequestMetricCollector metrics)

Sets a custom RequestMetricCollector to use for the client.

Parameters:

metrics - Custom RequestMetricCollector to use.

withMetricsCollector

public final Subclass withMetricsCollector(RequestMetricCollector metrics)

Sets a custom RequestMetricCollector to use for the client.

Parameters:

metrics - Custom RequestMetricCollector to use.

Returns:

This object for method chaining.

getRegion

public final String getRegion()

Gets the region in use by the builder.

setRegion

public final void setRegion(String region)

Sets the region to be used by the client. This will be used to determine both the service endpoint (eg: https://sns.us-west-1.amazonaws.com) and signing region (eg: us-west-1) for requests. If neither region or endpoint configuration AwsClientBuilder.setEndpointConfiguration(EndpointConfiguration) are explicitly provided in the builder the AwsClientBuilder.DEFAULT_REGION_PROVIDER is consulted.

Parameters:

region - Region to use

withRegion

public final Subclass withRegion(Regions region)

Sets the region to be used by the client. This will be used to determine both the service endpoint (eg: https://sns.us-west-1.amazonaws.com) and signing region (eg: us-west-1) for requests. If neither region or endpoint configuration AwsClientBuilder.setEndpointConfiguration(EndpointConfiguration) are explicitly provided in the builder the AwsClientBuilder.DEFAULT_REGION_PROVIDER is consulted.

For regions not explicitly in the Regions enum use the AwsClientBuilder.withRegion(String) overload.

Parameters:

region - Region to use

Returns:

This object for method chaining.

withRegion

public final Subclass withRegion(String region)

Sets the region to be used by the client. This will be used to determine both the service endpoint (eg: https://sns.us-west-1.amazonaws.com) and signing region (eg: us-west-1) for requests. If neither region or endpoint configuration AwsClientBuilder.setEndpointConfiguration(EndpointConfiguration) are explicitly provided in the builder the AwsClientBuilder.DEFAULT_REGION_PROVIDER is consulted.

Parameters:

region - Region to use

Returns:

This object for method chaining.

getEndpoint

public final AwsClientBuilder.EndpointConfiguration getEndpoint()

Gets the service endpointConfiguration in use by the builder

setEndpointConfiguration

public final void setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration)

Sets the endpoint configuration (service endpoint & signing region) to be used for requests. If neither region AwsClientBuilder.setRegion(String) or endpoint configuration are explicitly provided in the builder the AwsClientBuilder.DEFAULT_REGION_PROVIDER is consulted.

Only use this if using a non-standard service endpoint - the recommended approach for configuring a client is to use AwsClientBuilder.setRegion(String)

Parameters:

endpointConfiguration - The endpointConfiguration to use

withEndpointConfiguration

public final Subclass withEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration)

Sets the endpoint configuration (service endpoint & signing region) to be used for requests. If neither region AwsClientBuilder.withRegion(String) or endpoint configuration are explicitly provided in the builder the AwsClientBuilder.DEFAULT_REGION_PROVIDER is consulted.

Only use this if using a non-standard service endpoint - the recommended approach for configuring a client is to use AwsClientBuilder.withRegion(String)

Parameters:

endpointConfiguration - The endpointConfiguration to use

Returns:

This object for method chaining.

getRequestHandlers

public final List<RequestHandler2> getRequestHandlers()

Gets the list of request handlers in use by the builder.

setRequestHandlers

public final void setRequestHandlers(RequestHandler2... handlers)

Sets the request handlers to use in the client.

Parameters:

handlers - Request handlers to use for client.

withRequestHandlers

public final Subclass withRequestHandlers(RequestHandler2... handlers)

Sets the request handlers to use in the client.

Parameters:

handlers - Request handlers to use for client.

Returns:

This object for method chaining.

build

public abstract TypeToBuild build()

Builds a client with the configure properties.

Returns:

Client instance to make API calls with.

getSyncClientParams

protected final AwsSyncClientParams getSyncClientParams()

Returns:

An instance of AwsSyncClientParams that has all params to be used in the sync client constructor.

getSubclass

protected final Subclass getSubclass()