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

Enum BucketNameUtils

java.lang.Object

java.lang.Enum<BucketNameUtils>

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

All Implemented Interfaces:

Serializable, Comparable<BucketNameUtils>

public enum BucketNameUtils
extends Enum<BucketNameUtils>

Utilities for working with Amazon S3 bucket names, such as validation and checked to see if they are compatible with DNS addressing.

Method Summary

Modifier and Type	Method and Description
static boolean	isDNSBucketName(String bucketName) Convience method that allows the DNS rules to be altered for different SDKs.
static boolean	isValidV2BucketName(String bucketName) Returns true if the specified bucket name can be addressed using V2, virtual host style, addressing.
static void	validateBucketName(String bucketName) Validates that the specified bucket name is valid for Amazon S3 V2 naming (i.e.
static BucketNameUtils	valueOf(String name) Returns the enum constant of this type with the specified name.
static BucketNameUtils[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static BucketNameUtils[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BucketNameUtils c : BucketNameUtils.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BucketNameUtils valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

validateBucketName

public static void validateBucketName(String bucketName)

Validates that the specified bucket name is valid for Amazon S3 V2 naming (i.e. DNS addressable in virtual host style). Throws an IllegalArgumentException if the bucket name is not valid.

S3 bucket naming guidelines are specified in http://docs.amazonwebservices.com/AmazonS3/latest/dev/index.html? BucketRestrictions.html

Parameters:

bucketName - The bucket name to validate.

Throws:

IllegalBucketNameException - If the specified bucket name doesn't follow Amazon S3's guidelines.

isValidV2BucketName

public static boolean isValidV2BucketName(String bucketName)

Returns true if the specified bucket name can be addressed using V2, virtual host style, addressing. Otherwise, returns false indicating that the bucket must be addressed using V1, path style, addressing.

Parameters:

bucketName - The name of the bucket to check.

Returns:

True if the specified bucket name can be addressed in V2, virtual host style, addressing otherwise false if V1, path style, addressing is required.

isDNSBucketName

public static boolean isDNSBucketName(String bucketName)

Convience method that allows the DNS rules to be altered for different SDKs.