Package org.craftercms.deployer.utils.aws

Class AwsClientBuilderConfigurer<ClientBuilderSubclass extends com.amazonaws.client.builder.AwsClientBuilder>

java.lang.Object

org.craftercms.deployer.utils.aws.AwsClientBuilderConfigurer<ClientBuilderSubclass>

Direct Known Subclasses:

AwsS3ClientBuilderConfigurer

public class AwsClientBuilderConfigurer<ClientBuilderSubclass extends com.amazonaws.client.builder.AwsClientBuilder>
extends Object

Helper class the configures a AwsClientBuilder with properties like region and credentials.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected String	accessKey	AWS Access Key
static final String	CONFIG_KEY_ACCESS_KEY
static final String	CONFIG_KEY_ENDPOINT
static final String	CONFIG_KEY_REGION
static final String	CONFIG_KEY_SECRET_KEY
protected String	endpoint
protected String	region	AWS Region
protected String	secretKey	AWS Secret Key

Constructor Summary

Constructors

Constructor	Description
AwsClientBuilderConfigurer(org.apache.commons.configuration2.Configuration config)	Main constructor Extracts the region and credentials from the config.

Method Summary

Modifier and Type	Method	Description
void	configureClientBuilder(ClientBuilderSubclass builder)	Configures the specified builder, with any credentials and other properties provided in the configuration.

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_KEY_REGION

public static final String CONFIG_KEY_REGION

See Also:

• Constant Field Values

CONFIG_KEY_ENDPOINT

public static final String CONFIG_KEY_ENDPOINT

See Also:

• Constant Field Values

CONFIG_KEY_ACCESS_KEY

public static final String CONFIG_KEY_ACCESS_KEY

See Also:

• Constant Field Values

CONFIG_KEY_SECRET_KEY

public static final String CONFIG_KEY_SECRET_KEY

See Also:

• Constant Field Values

region

protected String region

AWS Region

endpoint

protected String endpoint

accessKey

protected String accessKey

AWS Access Key

secretKey

protected String secretKey

AWS Secret Key

Constructor Details

AwsClientBuilderConfigurer

public AwsClientBuilderConfigurer(org.apache.commons.configuration2.Configuration config)
                           throws org.craftercms.commons.config.ConfigurationException

Main constructor Extracts the region and credentials from the config.

Parameters:

config - the config with the client properties

Throws:

org.craftercms.commons.config.ConfigurationException - if an exception occurs while reading the configuration

Method Details

configureClientBuilder

public void configureClientBuilder(ClientBuilderSubclass builder)

Configures the specified builder, with any credentials and other properties provided in the configuration.

Parameters:

builder - the AWS client builder