Package org.opencms.db.storage.s3

Class CmsS3ClientConfiguration

java.lang.Object

org.opencms.db.storage.s3.CmsS3ClientConfiguration

public class CmsS3ClientConfiguration
extends Object

Configuration for the S3 client used by the storage backend.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_API_CALL_ATTEMPT_TIMEOUT	Default single API call attempt timeout in milliseconds.
static final int	DEFAULT_API_CALL_TIMEOUT	Default complete API call timeout in milliseconds.
static final int	DEFAULT_CONNECTION_ACQUISITION_TIMEOUT	Default timeout for acquiring a pooled connection in milliseconds.
static final int	DEFAULT_CONNECTION_TIMEOUT	Default connection timeout in milliseconds.
static final int	DEFAULT_MAX_CONNECTIONS	Default maximum number of pooled connections.
static final int	DEFAULT_MAX_RETRIES	Default maximum number of retries.
static final String	DEFAULT_REGION	Default AWS region.
static final int	DEFAULT_SOCKET_TIMEOUT	Default socket timeout in milliseconds.

Constructor Summary

Constructors

Constructor	Description
CmsS3ClientConfiguration(String endpoint, String bucketName, String accessKey, String secretKey, boolean pathStyle, String region, int connectionTimeout, int socketTimeout, int apiCallAttemptTimeout, int apiCallTimeout, int maxRetries)	Creates a new S3 client configuration.
CmsS3ClientConfiguration(String endpoint, String bucketName, String accessKey, String secretKey, boolean pathStyle, String region, int connectionTimeout, int socketTimeout, int apiCallAttemptTimeout, int apiCallTimeout, int maxRetries, int maxConnections, int connectionAcquisitionTimeout)	Creates a new S3 client configuration including connection pool settings.

Method Summary

Modifier and Type	Method	Description
static CmsS3ClientConfiguration	createDefault(String endpoint, String bucketName, String accessKey, String secretKey, boolean pathStyle)	Creates a new S3 client configuration using default client settings.
String	getAccessKey()	Returns the access key.
int	getApiCallAttemptTimeout()	Returns the single API call attempt timeout.
int	getApiCallTimeout()	Returns the complete API call timeout.
String	getBucketName()	Returns the bucket name.
int	getConnectionAcquisitionTimeout()	Returns the timeout for acquiring a pooled connection.
int	getConnectionTimeout()	Returns the connection timeout.
String	getEndpoint()	Returns the endpoint.
int	getMaxConnections()	Returns the maximum number of pooled connections.
int	getMaxRetries()	Returns the maximum number of retries.
String	getRegion()	Returns the configured AWS region.
String	getSecretKey()	Returns the secret key.
int	getSocketTimeout()	Returns the socket timeout.
boolean	isPathStyle()	Returns whether path-style access is configured.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_API_CALL_TIMEOUT

public static final int DEFAULT_API_CALL_TIMEOUT

Default complete API call timeout in milliseconds.

See Also:

• Constant Field Values

DEFAULT_API_CALL_ATTEMPT_TIMEOUT

public static final int DEFAULT_API_CALL_ATTEMPT_TIMEOUT

Default single API call attempt timeout in milliseconds.

See Also:

• Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

Default connection timeout in milliseconds.

See Also:

• Constant Field Values

DEFAULT_CONNECTION_ACQUISITION_TIMEOUT

public static final int DEFAULT_CONNECTION_ACQUISITION_TIMEOUT

Default timeout for acquiring a pooled connection in milliseconds.

See Also:

• Constant Field Values

DEFAULT_MAX_CONNECTIONS

public static final int DEFAULT_MAX_CONNECTIONS

Default maximum number of pooled connections.

See Also:

• Constant Field Values

DEFAULT_MAX_RETRIES

public static final int DEFAULT_MAX_RETRIES

Default maximum number of retries.

See Also:

• Constant Field Values

DEFAULT_REGION

public static final String DEFAULT_REGION

Default AWS region.

DEFAULT_SOCKET_TIMEOUT

public static final int DEFAULT_SOCKET_TIMEOUT

Default socket timeout in milliseconds.

See Also:

• Constant Field Values

Constructor Details

CmsS3ClientConfiguration

public CmsS3ClientConfiguration(String endpoint,
 String bucketName,
 String accessKey,
 String secretKey,
 boolean pathStyle,
 String region,
 int connectionTimeout,
 int socketTimeout,
 int apiCallAttemptTimeout,
 int apiCallTimeout,
 int maxRetries)

Creates a new S3 client configuration.

Parameters:

endpoint - the S3 endpoint

bucketName - the bucket name

accessKey - the access key

secretKey - the secret key

pathStyle - whether path-style access should be used

region - the AWS region

connectionTimeout - the connection timeout in milliseconds

socketTimeout - the socket timeout in milliseconds

apiCallAttemptTimeout - the timeout for a single API call attempt in milliseconds

apiCallTimeout - the timeout for the complete API call in milliseconds

maxRetries - the maximum number of retries

CmsS3ClientConfiguration

public CmsS3ClientConfiguration(String endpoint,
 String bucketName,
 String accessKey,
 String secretKey,
 boolean pathStyle,
 String region,
 int connectionTimeout,
 int socketTimeout,
 int apiCallAttemptTimeout,
 int apiCallTimeout,
 int maxRetries,
 int maxConnections,
 int connectionAcquisitionTimeout)

Creates a new S3 client configuration including connection pool settings.

Parameters:

endpoint - the S3 endpoint

bucketName - the bucket name

accessKey - the S3 access key

secretKey - the S3 secret key

pathStyle - whether path-style access should be used

region - the AWS region

connectionTimeout - the connection timeout in milliseconds

socketTimeout - the socket timeout in milliseconds

apiCallAttemptTimeout - the timeout for a single API call attempt in milliseconds

apiCallTimeout - the timeout for the complete API call in milliseconds

maxRetries - the maximum number of retries

maxConnections - the maximum number of pooled connections

connectionAcquisitionTimeout - the timeout for acquiring a pooled connection in milliseconds

Method Details

createDefault

public static CmsS3ClientConfiguration createDefault(String endpoint,
 String bucketName,
 String accessKey,
 String secretKey,
 boolean pathStyle)

Creates a new S3 client configuration using default client settings.

Parameters:

endpoint - the S3 endpoint

bucketName - the bucket name

accessKey - the access key

secretKey - the secret key

pathStyle - whether path-style access should be used

Returns:

the configuration

getAccessKey

public String getAccessKey()

Returns the access key.

Returns:

the access key

getApiCallAttemptTimeout

public int getApiCallAttemptTimeout()

Returns the single API call attempt timeout.

Returns:

the timeout in milliseconds

getApiCallTimeout

public int getApiCallTimeout()

Returns the complete API call timeout.

Returns:

the timeout in milliseconds

getBucketName

public String getBucketName()

Returns the bucket name.

Returns:

the bucket name

getConnectionAcquisitionTimeout

public int getConnectionAcquisitionTimeout()

Returns the timeout for acquiring a pooled connection.

Returns:

the timeout in milliseconds

getConnectionTimeout

public int getConnectionTimeout()

Returns the connection timeout.

Returns:

the timeout in milliseconds

getEndpoint

public String getEndpoint()

Returns the endpoint.

Returns:

the endpoint

getMaxConnections

public int getMaxConnections()

Returns the maximum number of pooled connections.

Returns:

the maximum number of pooled connections

getMaxRetries

public int getMaxRetries()

Returns the maximum number of retries.

Returns:

the maximum number of retries

getRegion

public String getRegion()

Returns the configured AWS region.

Returns:

the AWS region

getSecretKey

public String getSecretKey()

Returns the secret key.

Returns:

the secret key

getSocketTimeout

public int getSocketTimeout()

Returns the socket timeout.

Returns:

the timeout in milliseconds

isPathStyle

public boolean isPathStyle()

Returns whether path-style access is configured.

Returns:

true if path-style access is configured