com.amazonaws.services.s3.S3AccessPointResource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-s3 Show documentation
Show all versions of aws-java-sdk-s3 Show documentation
The AWS Java SDK for Amazon S3 module holds the client classes that are used for communicating with Amazon Simple Storage Service
/*
* Copyright 2010-2024 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 static com.amazonaws.util.ValidationUtils.assertAllAreNull;
import com.amazonaws.annotation.SdkInternalApi;
import com.amazonaws.services.s3.internal.S3OutpostResource;
import com.amazonaws.util.ValidationUtils;
/**
* An {@link S3Resource} that represents an S3 access point.
*/
@SdkInternalApi
public final class S3AccessPointResource implements S3Resource {
private static final S3ResourceType S3_RESOURCE_TYPE = S3ResourceType.ACCESS_POINT;
private final String partition;
private final String region;
private final String accountId;
private final String accessPointName;
private final S3Resource parentS3Resource;
private S3AccessPointResource(Builder b) {
this.accessPointName = ValidationUtils.assertStringNotEmpty(b.accessPointName, "accessPointName");
if (b.parentS3Resource == null) {
this.parentS3Resource = null;
this.partition = ValidationUtils.assertStringNotEmpty(b.partition, "partition");
this.region = ValidationUtils.assertStringNotEmpty(b.region, "region");
this.accountId = ValidationUtils.assertStringNotEmpty(b.accountId, "accountId");
} else {
this.parentS3Resource = validateParentS3Resource(b.parentS3Resource);
assertAllAreNull("partition cannot be set on builder if it has parent resource", b.partition);
assertAllAreNull("region cannot be set on builder if it has parent resource", b.region);
assertAllAreNull("accountId cannot be set on builder if it has parent resource", b.accountId);
this.partition = parentS3Resource.getPartition();
this.region = parentS3Resource.getRegion();
this.accountId = parentS3Resource.getAccountId();
}
}
private S3Resource validateParentS3Resource(S3Resource parentS3Resource) {
String parentResourceType = parentS3Resource.getType();
if (!S3ResourceType.OUTPOST.toString().equals(parentResourceType)
&& !S3ResourceType.OBJECT_LAMBDAS.toString().equals(parentResourceType)) {
throw new IllegalArgumentException("Invalid 'parentS3Resource' type. An S3 access point resource must be " +
"associated with an outpost or object lambdas parent resource.");
}
return parentS3Resource;
}
/**
* Get a new builder for this class.
* @return A newly initialized instance of a builder.
*/
public static Builder builder() {
return new Builder();
}
/**
* Gets the resource type for this access point.
* @return This will always return "accesspoint".
*/
@Override
public String getType() {
return S3_RESOURCE_TYPE.toString();
}
/**
* Gets the Amazon Web Services partition name associated with this access point (e.g.: 'aws').
* @return the name of the partition.
*/
@Override
public String getPartition() {
return this.partition;
}
/**
* Gets the Amazon Web Services region name associated with this bucket (e.g.: 'us-east-1').
* @return the name of the region.
*/
@Override
public String getRegion() {
return this.region;
}
/**
* Gets the Amazon Web Services account ID associated with this bucket.
* @return the Amazon Web Services account ID.
*/
@Override
public String getAccountId() {
return this.accountId;
}
/**
* Gets the name of the access point.
* @return the name of the access point.
*/
public String getAccessPointName() {
return this.accessPointName;
}
/**
* Gets the optional parent s3 resource
* @return the parent s3 resource if exists, otherwise null
*/
public S3Resource getParentS3Resource() {
return this.parentS3Resource;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
S3AccessPointResource that = (S3AccessPointResource) o;
if (partition != null ? ! partition.equals(that.partition) : that.partition != null) return false;
if (region != null ? ! region.equals(that.region) : that.region != null) return false;
if (accountId != null ? ! accountId.equals(that.accountId) : that.accountId != null) return false;
if (parentS3Resource != null ? ! parentS3Resource.equals(that.parentS3Resource) : that.parentS3Resource != null) return false;
return accessPointName.equals(that.accessPointName);
}
@Override
public int hashCode() {
int result = partition != null ? partition.hashCode() : 0;
result = 31 * result + (region != null ? region.hashCode() : 0);
result = 31 * result + (accountId != null ? accountId.hashCode() : 0);
result = 31 * result + accessPointName.hashCode();
result = 31 * result + (parentS3Resource != null ? parentS3Resource.hashCode() : 0);
return result;
}
/**
* A builder for {@link S3AccessPointResource} objects.
*/
public static final class Builder {
private String partition;
private String region;
private String accountId;
private String accessPointName;
private S3Resource parentS3Resource;
public void setPartition(String partition) {
this.partition = partition;
}
/**
* The Amazon Web Services partition associated with the access point.
*/
public Builder withPartition(String partition) {
setPartition(partition);
return this;
}
public void setRegion(String region) {
this.region = region;
}
/**
* The Amazon Web Services region associated with the access point.
*/
public Builder withRegion(String region) {
setRegion(region);
return this;
}
public void setAccountId(String accountId) {
this.accountId = accountId;
}
/**
* The Amazon Web Services account ID associated with the access point.
*/
public Builder withAccountId(String accountId) {
setAccountId(accountId);
return this;
}
public void setAccessPointName(String accessPointName) {
this.accessPointName = accessPointName;
}
/**
* The name of the S3 access point.
*/
public Builder withAccessPointName(String accessPointName) {
setAccessPointName(accessPointName);
return this;
}
/**
* The S3 resource this access point is associated with (contained within). Only {@link S3OutpostResource}
* is a valid parent resource types.
*/
public Builder withParentS3Resource(S3Resource parentS3Resource) {
this.parentS3Resource = parentS3Resource;
return this;
}
/**
* Builds an instance of {@link S3AccessPointResource}.
*/
public S3AccessPointResource build() {
return new S3AccessPointResource(this);
}
}
}