com.amazonaws.services.s3.AmazonS3ClientBuilder Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.s3;
import com.amazonaws.annotation.NotThreadSafe;
import com.amazonaws.annotation.SdkTestInternalApi;
import com.amazonaws.client.AwsSyncClientParams;
import com.amazonaws.client.builder.AwsClientBuilder;
import com.amazonaws.client.builder.AwsSyncClientBuilder;
import com.amazonaws.internal.SdkFunction;
/**
* Fluent builder for AmazonS3. Capable of building synchronous and asynchronous clients. Use of the
* builder is preferred over using constructors of the client class.
**/
@NotThreadSafe
public final class AmazonS3ClientBuilder extends
AwsSyncClientBuilder {
private static final AmazonS3ClientConfigurationFactory CLIENT_CONFIG_FACTORY = new AmazonS3ClientConfigurationFactory();
private static final SdkFunction DEFAULT_CLIENT_FACTORY = new SdkFunction() {
@Override
public AmazonS3 apply(AmazonS3ClientParamsWrapper params) {
return new AmazonS3Client(params);
}
};
private final SdkFunction clientFactory;
private Boolean pathStyleAccessEnabled;
private Boolean chunkedEncodingDisabled;
private Boolean accelerateModeEnabled;
private Boolean payloadSigningEnabled;
/**
* @return Create new instance of builder with all defaults set.
*/
public static AmazonS3ClientBuilder standard() {
return new AmazonS3ClientBuilder();
}
/**
* @return Default client using the {@link com.amazonaws.auth.DefaultAWSCredentialsProviderChain}
* and {@link com.amazonaws.regions.DefaultAwsRegionProviderChain} chain
*/
public static AmazonS3 defaultClient() {
return standard().build();
}
private AmazonS3ClientBuilder() {
this(DEFAULT_CLIENT_FACTORY);
}
@SdkTestInternalApi
AmazonS3ClientBuilder(SdkFunction clientFactory) {
super(CLIENT_CONFIG_FACTORY);
this.clientFactory = clientFactory;
}
/**
* @return The current setting for path style access configured in the builder.
*/
public Boolean isPathStyleAccessEnabled() {
return pathStyleAccessEnabled;
}
/**
* Configures the client to use path-style access for all requests.
*
* Amazon S3 supports virtual-hosted-style and path-style access in all Regions. The
* path-style syntax, however, requires that you use the region-specific endpoint when
* attempting to access a bucket.
*
* The default behaviour is to detect which access style to use based on the configured
* endpoint (an IP will result in path-style access) and the bucket being accessed (some buckets
* are not valid DNS names). Setting this flag will result in path-style access being used for
* all requests.
*
* @param pathStyleAccessEnabled True to always use path-style access.
*/
public void setPathStyleAccessEnabled(Boolean pathStyleAccessEnabled) {
this.pathStyleAccessEnabled = pathStyleAccessEnabled;
}
/**
* Configures the client to use path-style access for all requests.
*
* Amazon S3 supports virtual-hosted-style and path-style access in all Regions. The
* path-style syntax, however, requires that you use the region-specific endpoint when
* attempting to access a bucket.
*
* The default behaviour is to detect which access style to use based on the configured
* endpoint (an IP will result in path-style access) and the bucket being accessed (some buckets
* are not valid DNS names). Setting this flag will result in path-style access being used for
* all requests.
*
* @param pathStyleAccessEnabled True to always use path-style access.
* @return This object for method chaining.
*/
public AmazonS3ClientBuilder withPathStyleAccessEnabled(Boolean pathStyleAccessEnabled) {
setPathStyleAccessEnabled(pathStyleAccessEnabled);
return this;
}
/**
* Enables path style access for clients built via this builder.
*
* Amazon S3 supports virtual-hosted-style and path-style access in all Regions. The
* path-style syntax, however, requires that you use the region-specific endpoint when
* attempting to access a bucket.
*
* The default behaviour is to detect which access style to use based on the configured
* endpoint (an IP will result in path-style access) and the bucket being accessed (some buckets
* are not valid DNS names). Setting this flag will result in path-style access being used for
* all requests.
*
* @return This object for method chaining.
*/
public AmazonS3ClientBuilder enablePathStyleAccess() {
setPathStyleAccessEnabled(Boolean.TRUE);
return this;
}
/**
* @return The current setting for chunked encoding configured in the builder.
*/
public Boolean isChunkedEncodingDisabled() {
return chunkedEncodingDisabled;
}
/**
* Configures the client to disable chunked encoding for all requests.
*
* The default behavior is to enable chunked encoding automatically for PutObjectRequest and
* UploadPartRequest. Setting this flag will result in disabling chunked encoding for all
* requests.
*
* Note: Enabling this option has performance implications since the checksum for the
* payload will have to be pre-calculated before sending the data. If your payload is large this
* will affect the overall time required to upload an object. Using this option is recommended
* only if your endpoint does not implement chunked uploading.
*
* @param chunkedEncodingDisabled True to disable chunked encoding.
*/
public void setChunkedEncodingDisabled(Boolean chunkedEncodingDisabled) {
this.chunkedEncodingDisabled = chunkedEncodingDisabled;
}
/**
* Configures the client to disable chunked encoding for all requests.
*
* The default behavior is to enable chunked encoding automatically for PutObjectRequest and
* UploadPartRequest. Setting this flag will result in disabling chunked encoding for all
* requests.
*
* Note: Enabling this option has performance implications since the checksum for the
* payload will have to be pre-calculated before sending the data. If your payload is large this
* will affect the overall time required to upload an object. Using this option is recommended
* only if your endpoint does not implement chunked uploading.
*
* @param chunkedEncodingDisabled True to disable chunked encoding.
* @return this Builder instance that can be used for method chaining
*/
public AmazonS3ClientBuilder withChunkedEncodingDisabled(Boolean chunkedEncodingDisabled) {
setChunkedEncodingDisabled(chunkedEncodingDisabled);
return this;
}
/**
* Disables chunked encoding on clients built via the builder.
*
* The default behavior is to enable chunked encoding automatically for PutObjectRequest and
* UploadPartRequest. Setting this flag will result in disabling chunked encoding for all
* requests.
*
* Note: Enabling this option has performance implications since the checksum for the
* payload will have to be pre-calculated before sending the data. If your payload is large this
* will affect the overall time required to upload an object. Using this option is recommended
* only if your endpoint does not implement chunked uploading.
*
* @return this Builder instance that can be used for method chaining
*/
public AmazonS3ClientBuilder disableChunkedEncoding() {
setChunkedEncodingDisabled(Boolean.TRUE);
return this;
}
/**
* @return The current setting for accelerate mode configured in the builder.
*/
public Boolean isAccelerateModeEnabled() {
return accelerateModeEnabled;
}
/**
* Configures the client to use S3 accelerate endpoint for all requests.
*
* A bucket by default cannot be accessed in accelerate mode. If you wish to do so, you need
* to enable the accelerate configuration for the bucket in advance. To enable accelerate mode
* see {@link com.amazonaws.services.s3.AmazonS3Client#setBucketAccelerateConfiguration(com.amazonaws.services.s3.model.SetBucketAccelerateConfigurationRequest)}.
*
*
* @param accelerateModeEnabled True to enable accelerate mode.
* @return This object for method chaining.
*/
public void setAccelerateModeEnabled(Boolean accelerateModeEnabled) {
this.accelerateModeEnabled = accelerateModeEnabled;
}
/**
* Configures the client to use S3 accelerate endpoint for all requests.
*
* A bucket by default cannot be accessed in accelerate mode. If you wish to do so, you need
* to enable the accelerate configuration for the bucket in advance. To enable accelerate mode
* see {@link com.amazonaws.services.s3.AmazonS3Client#setBucketAccelerateConfiguration(com.amazonaws.services.s3.model.SetBucketAccelerateConfigurationRequest)}.
*
*
* @param accelerateModeEnabled True to enable accelerate mode.
* @return This object for method chaining.
*/
public AmazonS3ClientBuilder withAccelerateModeEnabled(Boolean accelerateModeEnabled) {
setAccelerateModeEnabled(accelerateModeEnabled);
return this;
}
/**
* Enables accelerate mode on clients built with the builder.
*
* A bucket by default cannot be accessed in accelerate mode. If you wish to do so, you need
* to enable the accelerate configuration for the bucket in advance. To enable accelerate mode
* see {@link com.amazonaws.services.s3.AmazonS3Client#setBucketAccelerateConfiguration(com.amazonaws.services.s3.model.SetBucketAccelerateConfigurationRequest)}.
*
*
* @return This object for method chaining.
*/
public AmazonS3ClientBuilder enableAccelerateMode() {
setAccelerateModeEnabled(Boolean.TRUE);
return this;
}
/**
* @return The current setting for payload signing configured in the builder.
*/
public Boolean isPayloadSigningEnabled() {
return payloadSigningEnabled;
}
/**
* Configures the client to sign payloads in all situations.
*
* Payload signing is optional when chunked encoding is not used and requests are made
* against an HTTPS endpoint. Under these conditions the client will by default opt to not sign
* payloads to optimize performance. If this flag is set to true the client will instead always
* sign payloads.
*
* Note: Payload signing can be expensive, particularly if transferring large payloads
* in a single chunk. Enabling this option will result in a performance penalty.
*
* @param payloadSigningEnabled True to explicitly enable payload signing in all situations
*/
public void setPayloadSigningEnabled(Boolean payloadSigningEnabled) {
this.payloadSigningEnabled = payloadSigningEnabled;
}
/**
* Configures the client to sign payloads in all situations.
*
* Payload signing is optional when chunked encoding is not used and requests are made
* against an HTTPS endpoint. Under these conditions the client will by default opt to not sign
* payloads to optimize performance. If this flag is set to true the client will instead always
* sign payloads.
*
* Note: Payload signing can be expensive, particularly if transferring large payloads
* in a single chunk. Enabling this option will result in a performance penalty.
*
* @param payloadSigningEnabled True to explicitly enable payload signing in all situations
* @return This object for method chaining.
*/
public AmazonS3ClientBuilder withPayloadSigningEnabled(Boolean payloadSigningEnabled) {
setPayloadSigningEnabled(payloadSigningEnabled);
return this;
}
/**
* Enables payload signing for all situations on clients built via this builder.
*
* Payload signing is optional when chunked encoding is not used and requests are made
* against an HTTPS endpoint. Under these conditions the client will by default opt to not sign
* payloads to optimize performance. If this flag is set to true the client will instead always
* sign payloads.
*
* Note: Payload signing can be expensive, particularly if transferring large payloads
* in a single chunk. Enabling this option will result in a performance penalty.
*
* @return This object for method chaining.
*/
public AmazonS3ClientBuilder enablePayloadSigning() {
setPayloadSigningEnabled(Boolean.TRUE);
return this;
}
/**
* Construct a synchronous implementation of AmazonS3 using the current builder configuration.
*
* @return Fully configured implementation of AmazonS3.
*/
@Override
protected AmazonS3 build(AwsSyncClientParams clientParams) {
return clientFactory
.apply(new AmazonS3ClientParamsWrapper(clientParams, resolveS3ClientOptions()));
}
private S3ClientOptions resolveS3ClientOptions() {
final S3ClientOptions.Builder builder = S3ClientOptions.builder();
if (this.chunkedEncodingDisabled != null && this.chunkedEncodingDisabled) {
builder.disableChunkedEncoding();
}
if (this.payloadSigningEnabled != null) {
builder.setPayloadSigningEnabled(this.payloadSigningEnabled);
}
if (this.accelerateModeEnabled != null) {
builder.setAccelerateModeEnabled(this.accelerateModeEnabled);
}
if (this.pathStyleAccessEnabled != null) {
builder.setPathStyleAccess(this.pathStyleAccessEnabled);
}
return builder.build();
}
}