com.amazon.dax.client.dynamodbv2

Class AmazonDaxClientBuilderAbstract<Builder extends AmazonDaxClientBuilderAbstract<Builder>>

java.lang.Object

com.amazon.dax.client.dynamodbv2.AmazonDaxClientBuilderAbstract<Builder>

Direct Known Subclasses:

AmazonDaxAsyncClientBuilder, AmazonDaxClientBuilder

public abstract class AmazonDaxClientBuilderAbstract<Builder extends AmazonDaxClientBuilderAbstract<Builder>>
extends Object

Abstract class for DAX client builders.

Field Summary

Fields

Modifier and Type	Field and Description
protected static AwsRegionProvider	DEFAULT_REGION_PROVIDER
protected static org.apache.commons.logging.Log	LOG
protected ClientConfig	mClientConfig
protected AWSCredentialsProvider	mCredentials
protected String[]	mHosts
protected Region	mRegion
protected AwsRegionProvider	mRegionProvider
protected boolean	mSkipHostnameVerification

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AmazonDaxClientBuilderAbstract()
protected	AmazonDaxClientBuilderAbstract(AwsRegionProvider regionProvider)

Method Summary

Modifier and Type	Method and Description
abstract AmazonDynamoDB	build()
ClientConfig	getClientConfiguration() Returns the ClientConfiguration currently configured in the builder
AWSCredentialsProvider	getCredentials() Returns the AWSCredentialsProvider currently configured in the builder.
String[]	getEndpoint() Returns the service endpointConfiguration in use by the builder
String	getRegion() Returns the region in use by the builder.
protected void	resolveCredentials(ClientConfig config)
protected void	resolveEndpoint(ClientConfig config)
protected void	resolveRegion(ClientConfig config)
void	setClientConfiguration(ClientConfig config) Sets the ClientConfiguration to be used by the client.
void	setCredentials(AWSCredentialsProvider credentialsProvider) Sets the AWSCredentialsProvider used by the client.
void	setEndpointConfiguration(String... hosts) Sets the endpoint configuration to be used for requests.
void	setRegion(String region) Sets the region to be used by the client.
Builder	withClientConfiguration(ClientConfig config) Sets the ClientConfiguration to be used by the client
Builder	withCredentials(AWSCredentialsProvider credentialsProvider) Sets the AWSCredentialsProvider used by the client.
Builder	withEndpointConfiguration(String... hosts) Sets the endpoint configuration to be used for requests.
Builder	withRegion(Regions region) Sets the region to be used by the client.
Builder	withRegion(String regionName) Sets the region to be used by the client.
Builder	withSkipHostnameVerification(boolean skipHostnameVerification) Sets if hostname verification is skipped or not for TLS.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

DEFAULT_REGION_PROVIDER

protected static final AwsRegionProvider DEFAULT_REGION_PROVIDER

mRegionProvider

protected final AwsRegionProvider mRegionProvider

mRegion

protected Region mRegion

mCredentials

protected AWSCredentialsProvider mCredentials

mClientConfig

protected ClientConfig mClientConfig

mHosts

protected String[] mHosts

mSkipHostnameVerification

protected boolean mSkipHostnameVerification

Constructor Detail

AmazonDaxClientBuilderAbstract

protected AmazonDaxClientBuilderAbstract()

AmazonDaxClientBuilderAbstract

protected AmazonDaxClientBuilderAbstract(AwsRegionProvider regionProvider)

Method Detail

build

public abstract AmazonDynamoDB build()

resolveEndpoint

protected void resolveEndpoint(ClientConfig config)

resolveCredentials

protected void resolveCredentials(ClientConfig config)

resolveRegion

protected void resolveRegion(ClientConfig config)

getCredentials

public final AWSCredentialsProvider getCredentials()

Returns the AWSCredentialsProvider currently configured in the builder.

Returns:

the AWSCredentialsProvider used by the client

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 Builder 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.

getRegion

public final String getRegion()

Returns the region in use by the builder.

Returns:

region in use

setRegion

public final void setRegion(String region)

Sets the region to be used by the client.

Parameters:

region - Region to use

withRegion

public final Builder withRegion(Regions region)

Sets the region to be used by the client.

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

Parameters:

region - Region to use

Returns:

This object for method chaining.

withRegion

public final Builder withRegion(String regionName)

Sets the region to be used by the client.

Parameters:

regionName - Region to use

Returns:

This object for method chaining.

getClientConfiguration

public final ClientConfig getClientConfiguration()

Returns the ClientConfiguration currently configured in the builder

Returns:

ClientConfiguration currently configured in the builder

setClientConfiguration

public final void setClientConfiguration(ClientConfig config)

Sets the ClientConfiguration to be used by the client.

If not specified the default is typically PredefinedClientConfigurations.defaultConfig() but may differ per service. Note that part of the configuration can be overridden by the configs of this builder (endpoint, region, credentials) when build() is called.

Parameters:

config - Custom configuration to use

withClientConfiguration

public final Builder withClientConfiguration(ClientConfig config)

Sets the ClientConfiguration to be used by the client

If not specified the default is typically PredefinedClientConfigurations.defaultConfig() but may differ per service. Note that part of the configuration can be overridden by the configs of this builder (endpoint, region, credentials) when build() is called.

Parameters:

config - Custom configuration to use

Returns:

This object for method chaining.

getEndpoint

public final String[] getEndpoint()

Returns the service endpointConfiguration in use by the builder

Returns:

the service endpointConfiguration in use by the builder

setEndpointConfiguration

public final void setEndpointConfiguration(String... hosts)

Sets the endpoint configuration to be used for requests.

Parameters:

hosts - The endpointConfiguration to use, in the form [scheme://]hostname:port

withEndpointConfiguration

public final Builder withEndpointConfiguration(String... hosts)

Sets the endpoint configuration to be used for requests.

Parameters:

hosts - The endpointConfiguration to use, in the form [scheme://]hostname:port

Returns:

This object for method chaining.

withSkipHostnameVerification

public final Builder withSkipHostnameVerification(boolean skipHostnameVerification)

Sets if hostname verification is skipped or not for TLS. If not used, hostname verification is enabled by default.

Parameters:

skipHostnameVerification - skip hostname verification of TLS connections. This parameter has no impact on unecrypted clusters. The default is to perform hostname verification, setting this to true will skip verification. Be sure you understand the implication of doing so, which is the inability to authenticate the cluster that you are connecting to.

Returns:

This object for method chaining.