Package software.amazon.awssdk.services.s3.internal

Class BucketUtils

java.lang.Object

software.amazon.awssdk.services.s3.internal.BucketUtils

public final class BucketUtils
extends Object

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	Description
static boolean	isValidDnsBucketName(String bucketName, boolean throwOnError)	Validates that the specified bucket name is valid for Amazon S3 V2 naming (i.e.
static boolean	isVirtualAddressingCompatibleBucketName(String bucketName, boolean throwOnError)	Validates if the given bucket name follows naming guidelines that are acceptable for using virtual host style addressing.

Methods inherited from class java.lang.Object

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

Method Detail

isValidDnsBucketName

public static boolean isValidDnsBucketName(String bucketName,
                                           boolean throwOnError)

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:

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

isVirtualAddressingCompatibleBucketName

public static boolean isVirtualAddressingCompatibleBucketName(String bucketName,
                                                              boolean throwOnError)

Validates if the given bucket name follows naming guidelines that are acceptable for using virtual host style addressing.

Parameters:

bucketName - The bucket name to validate.

throwOnError - boolean to decide if an error should be thrown if the bucket name doesn't follow the naming convention