BaseS3Client (api 9.0.0 API)

java.lang.Object
- io.minio.BaseS3Client

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

MinioAsyncClient
```
public abstract class BaseS3Client
extends Object
implements AutoCloseable
```
Core S3 API client.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Http.BaseUrl`	`baseUrl`
`protected boolean`	`closeHttpClient`
`protected okhttp3.OkHttpClient`	`httpClient`
`protected static int`	`MAX_BUCKET_POLICY_SIZE`
`protected static String`	`NO_SUCH_BUCKET`
`protected static String`	`NO_SUCH_BUCKET_MESSAGE`
`protected static String`	`NO_SUCH_BUCKET_POLICY`
`protected static String`	`NO_SUCH_OBJECT_LOCK_CONFIGURATION`
`protected static com.fasterxml.jackson.databind.ObjectMapper`	`OBJECT_MAPPER`
`protected Provider`	`provider`
`protected static Random`	`RANDOM`
`protected Map<String,String>`	`regionCache`
`protected static String`	`SERVER_SIDE_ENCRYPTION_CONFIGURATION_NOT_FOUND_ERROR`
`protected String`	`userAgent`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseS3Client(BaseS3Client client)`
`protected`	`BaseS3Client(Http.BaseUrl baseUrl, Provider provider, okhttp3.OkHttpClient httpClient, boolean closeHttpClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<AbortMultipartUploadResponse>`	`abortMultipartUpload(AbortMultipartUploadArgs args)` Do AbortMultipartUpload S3 API asynchronously.
`protected void`	`checkArgs(BaseArgs args)` Check whether argument is valid or not.
`void`	`close()` Closes underneath HTTP client.
`CompletableFuture<ObjectWriteResponse>`	`completeMultipartUpload(CompleteMultipartUploadArgs args)` Do CompleteMultipartUpload S3 API asynchronously.
`CompletableFuture<ObjectWriteResponse>`	`copyObject(CopyObjectArgs args)` Do CopyObject S3 API asynchronously.
`CompletableFuture<GenericResponse>`	`createBucket(CreateBucketArgs args)` Do CreateBucket S3 API asynchronously.
`CompletableFuture<CreateMultipartUploadResponse>`	`createMultipartUpload(CreateMultipartUploadArgs args)` Do CreateMultipartUpload S3 API asynchronously.
`CompletableFuture<DeleteObjectsResponse>`	`deleteObjects(DeleteObjectsArgs args)` Do DeleteObjects S3 API asynchronously.
`void`	`disableDualStackEndpoint()` Disables dual-stack endpoint for Amazon S3 endpoint.
`void`	`disableVirtualStyleEndpoint()` Disables virtual-style endpoint.
`void`	`enableDualStackEndpoint()` Enables dual-stack endpoint for Amazon S3 endpoint.
`void`	`enableVirtualStyleEndpoint()` Enables virtual-style endpoint.
`protected CompletableFuture<okhttp3.Response>`	`executeAsync(Http.S3Request s3request)` Execute HTTP request asynchronously for given args and parameters.
`protected CompletableFuture<okhttp3.Response>`	`executeAsync(Http.S3Request s3request, String region)` Execute HTTP request asynchronously for given parameters.
`protected CompletableFuture<okhttp3.Response>`	`executeDeleteAsync(BaseArgs args, Http.Headers headers, Http.QueryParameters queryParams)` Execute asynchronously DELETE HTTP request for given parameters.
`protected CompletableFuture<okhttp3.Response>`	`executeGetAsync(BaseArgs args, Http.Headers headers, Http.QueryParameters queryParams)` Execute asynchronously GET HTTP request for given parameters.
`protected CompletableFuture<okhttp3.Response>`	`executeHeadAsync(BaseArgs args, Http.Headers headers, Http.QueryParameters queryParams)` Execute asynchronously HEAD HTTP request for given parameters.
`protected CompletableFuture<okhttp3.Response>`	`executePostAsync(BaseArgs args, Http.Headers headers, Http.QueryParameters queryParams, Http.Body body)` Execute asynchronously POST HTTP request for given parameters.
`protected CompletableFuture<okhttp3.Response>`	`executePutAsync(BaseArgs args, Http.Headers headers, Http.QueryParameters queryParams, Http.Body body)` Execute asynchronously PUT HTTP request for given parameters.
`CompletableFuture<String>`	`getBucketLocation(GetBucketLocationArgs args)` Do GetBucketLocation S3 API asynchronously.
`protected CompletableFuture<String>`	`getRegion(String bucket, String region)` Returns region of given bucket either from region cache or set in constructor.
`CompletableFuture<HeadBucketResponse>`	`headBucket(HeadBucketArgs args)` Do HeadBucket S3 API asynchronously.
`CompletableFuture<HeadObjectResponse>`	`headObject(HeadObjectArgs args)` Do HeadObject S3 API asynchronously.
`void`	`ignoreCertCheck()` Ignores check on server certificate for HTTPS connection.
`CompletableFuture<ListBucketsResponse>`	`listBucketsAPI(ListBucketsArgs args)` Do ListBuckets S3 API asynchronously.
`CompletableFuture<ListMultipartUploadsResponse>`	`listMultipartUploads(ListMultipartUploadsArgs args)` Do ListMultipartUploads S3 API asynchronously.
`CompletableFuture<ListObjectsV1Response>`	`listObjectsV1(ListObjectsV1Args args)` Do ListObjects version 1 S3 API asynchronously.
`CompletableFuture<ListObjectsV2Response>`	`listObjectsV2(ListObjectsV2Args args)` Do ListObjects version 2 S3 API asynchronously.
`CompletableFuture<ListObjectVersionsResponse>`	`listObjectVersions(ListObjectVersionsArgs args)` Do ListObjectVersions API asynchronously.
`CompletableFuture<ListPartsResponse>`	`listParts(ListPartsArgs args)` Do ListParts S3 API asynchronously.
`protected <T> CompletableFuture<T>`	`newCompleteableFuture()`
`CompletableFuture<ObjectWriteResponse>`	`putObject(PutObjectAPIArgs args)` Do PutObject S3 API asynchronously.
`void`	`setAppInfo(String name, String version)` Sets application's name/version to user agent.
`void`	`setAwsS3Prefix(String awsS3Prefix)` Sets AWS S3 domain prefix.
`void`	`setTimeout(long connectTimeout, long writeTimeout, long readTimeout)` Sets HTTP connect, write and read timeouts.
`protected <T> CompletableFuture<T>`	`supplyAsync(Supplier<T> supplier)`
`void`	`traceOff()` Disables HTTP call tracing previously enabled.
`void`	`traceOn(OutputStream traceStream)` Enables HTTP call tracing and written to traceStream.
`CompletableFuture<UploadPartResponse>`	`uploadPart(UploadPartArgs args)` Do UploadPart S3 API asynchronously.
`CompletableFuture<UploadPartCopyResponse>`	`uploadPartCopy(UploadPartCopyArgs args)` Do UploadPartCopy S3 API.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_SUCH_BUCKET_MESSAGE

protected static final String NO_SUCH_BUCKET_MESSAGE

See Also:: Constant Field Values

NO_SUCH_BUCKET

protected static final String NO_SUCH_BUCKET

See Also:: Constant Field Values

NO_SUCH_BUCKET_POLICY

protected static final String NO_SUCH_BUCKET_POLICY

See Also:: Constant Field Values

NO_SUCH_OBJECT_LOCK_CONFIGURATION

protected static final String NO_SUCH_OBJECT_LOCK_CONFIGURATION

See Also:: Constant Field Values

SERVER_SIDE_ENCRYPTION_CONFIGURATION_NOT_FOUND_ERROR

protected static final String SERVER_SIDE_ENCRYPTION_CONFIGURATION_NOT_FOUND_ERROR

See Also:: Constant Field Values

MAX_BUCKET_POLICY_SIZE
```
protected static final int MAX_BUCKET_POLICY_SIZE
```
See Also:

Constant Field Values

RANDOM
```
protected static final Random RANDOM
```

OBJECT_MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER

regionCache

protected final Map<String,String> regionCache

userAgent
```
protected String userAgent
```

baseUrl
```
protected Http.BaseUrl baseUrl
```

provider
```
protected Provider provider
```

httpClient

protected okhttp3.OkHttpClient httpClient

closeHttpClient
```
protected boolean closeHttpClient
```

Constructor Detail

BaseS3Client

protected BaseS3Client(Http.BaseUrl baseUrl,
                       Provider provider,
                       okhttp3.OkHttpClient httpClient,
                       boolean closeHttpClient)

BaseS3Client

protected BaseS3Client(BaseS3Client client)

Method Detail

close
```
public void close()
           throws Exception
```
Closes underneath HTTP client.

Specified by:

close in interface AutoCloseable

Throws:

Exception

setTimeout
```
public void setTimeout(long connectTimeout,
                       long writeTimeout,
                       long readTimeout)
```
Sets HTTP connect, write and read timeouts. A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE when converted to milliseconds.
```
Example:
 minioClient.setTimeout(TimeUnit.SECONDS.toMillis(10), TimeUnit.SECONDS.toMillis(10),
     TimeUnit.SECONDS.toMillis(30));
 
```
Parameters:

connectTimeout - HTTP connect timeout in milliseconds.

writeTimeout - HTTP write timeout in milliseconds.

readTimeout - HTTP read timeout in milliseconds.

ignoreCertCheck
```
public void ignoreCertCheck()
                     throws MinioException
```
Ignores check on server certificate for HTTPS connection.
```
Example:
 minioClient.ignoreCertCheck();
 
```
Throws:

MinioException - thrown to indicate SDK exception.

setAppInfo
```
public void setAppInfo(String name,
                       String version)
```
Sets application's name/version to user agent. For more information about user agent refer #rfc2616.

Parameters:

name - Your application name.

version - Your application version.

traceOn
```
public void traceOn(OutputStream traceStream)
```
Enables HTTP call tracing and written to traceStream.

Parameters:

traceStream - OutputStream for writing HTTP call tracing.

See Also:

traceOff()

traceOff
```
public void traceOff()
```
Disables HTTP call tracing previously enabled.

See Also:

traceOn(java.io.OutputStream)

enableDualStackEndpoint
```
public void enableDualStackEndpoint()
```
Enables dual-stack endpoint for Amazon S3 endpoint.

disableDualStackEndpoint
```
public void disableDualStackEndpoint()
```
Disables dual-stack endpoint for Amazon S3 endpoint.

enableVirtualStyleEndpoint
```
public void enableVirtualStyleEndpoint()
```
Enables virtual-style endpoint.

disableVirtualStyleEndpoint
```
public void disableVirtualStyleEndpoint()
```
Disables virtual-style endpoint.

setAwsS3Prefix

public void setAwsS3Prefix(@Nonnull
                           String awsS3Prefix)

Sets AWS S3 domain prefix.

supplyAsync

protected <T> CompletableFuture<T> supplyAsync(Supplier<T> supplier)

newCompleteableFuture

protected <T> CompletableFuture<T> newCompleteableFuture()

executeAsync

protected CompletableFuture<okhttp3.Response> executeAsync(Http.S3Request s3request,
                                                           String region)

Execute HTTP request asynchronously for given parameters.

executeAsync

protected CompletableFuture<okhttp3.Response> executeAsync(Http.S3Request s3request)

Execute HTTP request asynchronously for given args and parameters.

executeGetAsync

protected CompletableFuture<okhttp3.Response> executeGetAsync(BaseArgs args,
                                                              Http.Headers headers,
                                                              Http.QueryParameters queryParams)

Execute asynchronously GET HTTP request for given parameters.

executeHeadAsync

protected CompletableFuture<okhttp3.Response> executeHeadAsync(BaseArgs args,
                                                               Http.Headers headers,
                                                               Http.QueryParameters queryParams)

Execute asynchronously HEAD HTTP request for given parameters.

executeDeleteAsync

protected CompletableFuture<okhttp3.Response> executeDeleteAsync(BaseArgs args,
                                                                 Http.Headers headers,
                                                                 Http.QueryParameters queryParams)

Execute asynchronously DELETE HTTP request for given parameters.

executePostAsync

protected CompletableFuture<okhttp3.Response> executePostAsync(BaseArgs args,
                                                               Http.Headers headers,
                                                               Http.QueryParameters queryParams,
                                                               Http.Body body)

Execute asynchronously POST HTTP request for given parameters.

executePutAsync

protected CompletableFuture<okhttp3.Response> executePutAsync(BaseArgs args,
                                                              Http.Headers headers,
                                                              Http.QueryParameters queryParams,
                                                              Http.Body body)

Execute asynchronously PUT HTTP request for given parameters.

getRegion

protected CompletableFuture<String> getRegion(String bucket,
                                              String region)

Returns region of given bucket either from region cache or set in constructor.

checkArgs
```
protected void checkArgs(BaseArgs args)
```
Check whether argument is valid or not.

abortMultipartUpload
```
public CompletableFuture<AbortMultipartUploadResponse> abortMultipartUpload(AbortMultipartUploadArgs args)
```
Do AbortMultipartUpload S3 API asynchronously.

Parameters:

args - AbortMultipartUploadArgs object.

Returns:

CompletableFuture<AbortMultipartUploadResponse> object.

completeMultipartUpload
```
public CompletableFuture<ObjectWriteResponse> completeMultipartUpload(CompleteMultipartUploadArgs args)
```
Do CompleteMultipartUpload S3 API asynchronously.

Parameters:

args - CompleteMultipartUploadArgs object.

Returns:

CompletableFuture<ObjectWriteResponse> object.

copyObject
```
public CompletableFuture<ObjectWriteResponse> copyObject(CopyObjectArgs args)
```
Do CopyObject S3 API asynchronously.

Parameters:

args - CopyObjectArgs object.

Returns:

CompletableFuture<ObjectWriteResponse> object.

createBucket
```
public CompletableFuture<GenericResponse> createBucket(CreateBucketArgs args)
```
Do CreateBucket S3 API asynchronously.

Parameters:

args - CreateBucketArgs object.

Returns:

CompletableFuture<GenericResponse> object.

createMultipartUpload
```
public CompletableFuture<CreateMultipartUploadResponse> createMultipartUpload(CreateMultipartUploadArgs args)
```
Do CreateMultipartUpload S3 API asynchronously.

Parameters:

args - CreateMultipartUploadArgs object.

Returns:

CompletableFuture<CreateMultipartUploadResponse> object.

deleteObjects
```
public CompletableFuture<DeleteObjectsResponse> deleteObjects(DeleteObjectsArgs args)
```
Do DeleteObjects S3 API asynchronously.

Parameters:

args - DeleteObjectsArgs object.

Returns:

CompletableFuture<DeleteObjectsResponse> object.

getBucketLocation
```
public CompletableFuture<String> getBucketLocation(GetBucketLocationArgs args)
```
Do GetBucketLocation S3 API asynchronously.

Parameters:

args - GetBucketLocationArgs object.

Returns:

CompletableFuture<String> object.

headBucket
```
public CompletableFuture<HeadBucketResponse> headBucket(HeadBucketArgs args)
```
Do HeadBucket S3 API asynchronously.

Parameters:

args - HeadBucketArgs object.

Returns:

CompletableFuture<HeadBucketResponse> object.

headObject
```
public CompletableFuture<HeadObjectResponse> headObject(HeadObjectArgs args)
```
Do HeadObject S3 API asynchronously.

Parameters:

args - HeadObjectArgs object.

Returns:

CompletableFuture<HeadObjectResponse> object.

listBucketsAPI
```
public CompletableFuture<ListBucketsResponse> listBucketsAPI(ListBucketsArgs args)
```
Do ListBuckets S3 API asynchronously.

Parameters:

args - ListBucketsArgs object.

Returns:

CompletableFuture<ListBucketsResponse> object.

listMultipartUploads
```
public CompletableFuture<ListMultipartUploadsResponse> listMultipartUploads(ListMultipartUploadsArgs args)
```
Do ListMultipartUploads S3 API asynchronously.

Parameters:

args - ListMultipartUploadsArgs object.

Returns:

CompletableFuture<ListMultipartUploadsResponse> object.

listObjectsV1
```
public CompletableFuture<ListObjectsV1Response> listObjectsV1(ListObjectsV1Args args)
```
Do ListObjects version 1 S3 API asynchronously.

Parameters:

args - ListObjectsV1Args object.

Returns:

CompletableFuture<ListObjectsV1Response> object.

listObjectsV2
```
public CompletableFuture<ListObjectsV2Response> listObjectsV2(ListObjectsV2Args args)
```
Do ListObjects version 2 S3 API asynchronously.

Parameters:

args - ListObjectsV2Args object.

Returns:

CompletableFuture<ListObjectsV2Response> object.

listObjectVersions
```
public CompletableFuture<ListObjectVersionsResponse> listObjectVersions(ListObjectVersionsArgs args)
```
Do ListObjectVersions API asynchronously.

Parameters:

args - ListObjectVersionsArgs object.

Returns:

CompletableFuture<ListObjectVersionsResponse> object.

listParts
```
public CompletableFuture<ListPartsResponse> listParts(ListPartsArgs args)
```
Do ListParts S3 API asynchronously.

Parameters:

args - ListPartsArgs object.

Returns:

CompletableFuture<ListPartsResponse> object.

putObject
```
public CompletableFuture<ObjectWriteResponse> putObject(PutObjectAPIArgs args)
```
Do PutObject S3 API asynchronously.

Parameters:

args - PutObjectAPIArgs object.

Returns:

CompletableFuture<ObjectWriteResponse> object.

uploadPart
```
public CompletableFuture<UploadPartResponse> uploadPart(UploadPartArgs args)
```
Do UploadPart S3 API asynchronously.

Parameters:

args - UploadPartArgs object.

Returns:

CompletableFuture<UploadPartResponse> object.

uploadPartCopy
```
public CompletableFuture<UploadPartCopyResponse> uploadPartCopy(UploadPartCopyArgs args)
```
Do UploadPartCopy S3 API.

Parameters:

args - UploadPartCopyArgs object.

Returns:

CompletableFuture<UploadPartCopyResponse> object.

Class BaseS3Client

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_SUCH_BUCKET_MESSAGE

NO_SUCH_BUCKET

NO_SUCH_BUCKET_POLICY

NO_SUCH_OBJECT_LOCK_CONFIGURATION

SERVER_SIDE_ENCRYPTION_CONFIGURATION_NOT_FOUND_ERROR

MAX_BUCKET_POLICY_SIZE

RANDOM

OBJECT_MAPPER

regionCache

userAgent

baseUrl

provider

httpClient

closeHttpClient

Constructor Detail

BaseS3Client

BaseS3Client

Method Detail

close

setTimeout

ignoreCertCheck

setAppInfo

traceOn

traceOff

enableDualStackEndpoint

disableDualStackEndpoint

enableVirtualStyleEndpoint

disableVirtualStyleEndpoint

setAwsS3Prefix

supplyAsync

newCompleteableFuture

executeAsync

executeAsync

executeGetAsync

executeHeadAsync

executeDeleteAsync

executePostAsync

executePutAsync

getRegion

checkArgs

abortMultipartUpload

completeMultipartUpload

copyObject

createBucket

createMultipartUpload

deleteObjects

getBucketLocation

headBucket

headObject

listBucketsAPI

listMultipartUploads

listObjectsV1

listObjectsV2

listObjectVersions

listParts

putObject

uploadPart

uploadPartCopy