com.ibm.cloud.objectstorage.services.s3.internal

Class Constants

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.internal.Constants

public class Constants
extends Object

Constants used by the Amazon Web Services S3 Java client.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUCKET_ACCESS_FORBIDDEN_STATUS_CODE
static int	BUCKET_REDIRECT_STATUS_CODE
static String	DEFAULT_ENCODING Default encoding used for text data
static int	DEFAULT_STREAM_BUFFER_SIZE The default size of the buffer when uploading data from a stream.
static int	FAILED_PRECONDITION_STATUS_CODE HTTP status code indicating that preconditions failed and thus the request failed.
static long	GB Gigabytes
static String	HMAC_SHA1_ALGORITHM HMAC/SHA1 Algorithm per RFC 2104, used when signing S3 requests
static int	KB Kilobytes
static int	MAXIMUM_UPLOAD_PARTS The maximum allowed parts in a multipart upload.
static int	MB Megabytes
static int	NO_SUCH_BUCKET_STATUS_CODE
static String	NULL_VERSION_ID Represents a null S3 version ID
static String	REQUESTER_PAYS
static String	S3_ACCELERATE_DUALSTACK_HOSTNAME
static String	S3_ACCELERATE_HOSTNAME Service hostname for accessing accelerated S3 buckets
static String	S3_DUALSTACK_QUALIFIER Dualstack qualifier for S3
static String	S3_EXTERNAL_1_HOSTNAME Hostname for the s3-external-1 service endpoint
static String	S3_HOSTNAME Default hostname for the S3 service endpoint
static String	S3_SERVICE_DISPLAY_NAME Service display name for Amazon S3 (not to be used in SigV4 signing)
static String	URL_ENCODING URL encoding for s3 object keys
static String	XML_NAMESPACE XML namespace URL used when sending S3 requests containing XML

Constructor Summary

Constructors

Constructor and Description
Constants()

Method Summary

Modifier and Type	Method and Description
static Integer	getS3StreamBufferSize() Returns the value of the system property SDKGlobalConfiguration.DEFAULT_S3_STREAM_BUFFER_SIZE as an Integer; or null if not set.
static int	getStreamBufferSize() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

S3_HOSTNAME

public static final String S3_HOSTNAME

Default hostname for the S3 service endpoint

See Also:

Constant Field Values

S3_EXTERNAL_1_HOSTNAME

public static final String S3_EXTERNAL_1_HOSTNAME

Hostname for the s3-external-1 service endpoint

See Also:

Constant Field Values

S3_ACCELERATE_HOSTNAME

public static final String S3_ACCELERATE_HOSTNAME

Service hostname for accessing accelerated S3 buckets

See Also:

Constant Field Values

S3_ACCELERATE_DUALSTACK_HOSTNAME

public static final String S3_ACCELERATE_DUALSTACK_HOSTNAME

See Also:

Constant Field Values

S3_DUALSTACK_QUALIFIER

public static final String S3_DUALSTACK_QUALIFIER

Dualstack qualifier for S3

See Also:

Constant Field Values

S3_SERVICE_DISPLAY_NAME

public static final String S3_SERVICE_DISPLAY_NAME

Service display name for Amazon S3 (not to be used in SigV4 signing)

See Also:

Constant Field Values

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

Default encoding used for text data

See Also:

Constant Field Values

URL_ENCODING

public static final String URL_ENCODING

URL encoding for s3 object keys

See Also:

Constant Field Values

HMAC_SHA1_ALGORITHM

public static final String HMAC_SHA1_ALGORITHM

HMAC/SHA1 Algorithm per RFC 2104, used when signing S3 requests

See Also:

Constant Field Values

XML_NAMESPACE

public static final String XML_NAMESPACE

XML namespace URL used when sending S3 requests containing XML

See Also:

Constant Field Values

NULL_VERSION_ID

public static final String NULL_VERSION_ID

Represents a null S3 version ID

See Also:

Constant Field Values

FAILED_PRECONDITION_STATUS_CODE

public static final int FAILED_PRECONDITION_STATUS_CODE

HTTP status code indicating that preconditions failed and thus the request failed.

See Also:

Constant Field Values

KB

public static final int KB

Kilobytes

See Also:

Constant Field Values

MB

public static final int MB

Megabytes

See Also:

Constant Field Values

GB

public static final long GB

Gigabytes

See Also:

Constant Field Values

MAXIMUM_UPLOAD_PARTS

public static final int MAXIMUM_UPLOAD_PARTS

The maximum allowed parts in a multipart upload.

See Also:

Constant Field Values

DEFAULT_STREAM_BUFFER_SIZE

public static final int DEFAULT_STREAM_BUFFER_SIZE

The default size of the buffer when uploading data from a stream. A buffer of this size will be created and filled with the first bytes from a stream being uploaded so that any transmit errors that occur in that section of the data can be automatically retried without the caller's intervention. Add 1 to get around an implementation quirk when used against BufferedInputStream.

See Also:

Constant Field Values

NO_SUCH_BUCKET_STATUS_CODE

public static final int NO_SUCH_BUCKET_STATUS_CODE

See Also:

Constant Field Values

BUCKET_ACCESS_FORBIDDEN_STATUS_CODE

public static final int BUCKET_ACCESS_FORBIDDEN_STATUS_CODE

See Also:

Constant Field Values

BUCKET_REDIRECT_STATUS_CODE

public static final int BUCKET_REDIRECT_STATUS_CODE

See Also:

Constant Field Values

REQUESTER_PAYS

public static final String REQUESTER_PAYS

See Also:

Constant Field Values

Constructor Detail

Constants

public Constants()

Method Detail

getStreamBufferSize

@Deprecated
public static int getStreamBufferSize()

Deprecated.

Returns the buffer size override if it is specified in the system property, otherwise returns the default value.

getS3StreamBufferSize

public static Integer getS3StreamBufferSize()

Returns the value of the system property SDKGlobalConfiguration.DEFAULT_S3_STREAM_BUFFER_SIZE as an Integer; or null if not set. This method exists for backward compatibility reasons.