Skip to content

HDDS-5287. Document S3 ACL classes #8501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ivandika3 merged 2 commits into from
May 23, 2025
+18 −5
Merged

HDDS-5287. Document S3 ACL classes #8501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9f1419
docs: add javadoc on S3ACl, S3BucketACl and S3Owner
YutaLin May 22, 2025
817ce4b
Merge branch 'master' into HDDS-5287
YutaLin May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Acl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
import org.slf4j.LoggerFactory;

/**
* TODO: javadoc.
* Represents an S3 Access Control List (ACL) that defines permissions for S3 buckets and objects.
*/
public final class S3Acl {
private static final Logger LOG = LoggerFactory.getLogger(S3Acl.class);
Expand Down Expand Up @@ -90,7 +90,7 @@ public static ACLType getType(String typeStr) {
}

/**
* TODO: javadoc.
* Represents the different types of identities that can be granted permissions in an S3 ACL.
*/
enum ACLIdentityType {
USER("CanonicalUser", true, "id"),
Expand Down
13 changes: 11 additions & 2 deletions hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3BucketAcl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,11 @@ public String toString() {
}

/**
* TODO: javadoc.
* Represents an S3 Access Control List containing a collection of permission grants.
*
* This class models the AccessControlList XML element in S3 ACL responses and requests.
* It contains a list of Grant objects that define specific permissions granted to
* particular grantees (users, groups, etc.).
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "AccessControlList")
Expand Down Expand Up @@ -100,7 +104,12 @@ public String toString() {
}

/**
* TODO: javadoc.
* Represents a single permission grant within an S3 Access Control List.
*
* This class models the Grant XML element in S3 ACL responses and requests,
* associating a specific permission with a grantee (the recipient of the permission).
* Each Grant consists of a Grantee (which identifies a user, group, or other entity)
* and a Permission string that specifies what access level is being granted.
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "Grant")
Expand Down
6 changes: 5 additions & 1 deletion hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Owner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,11 @@
import javax.xml.bind.annotation.XmlRootElement;

/**
* TODO: javadoc.
* Represents an owner of S3 resources in the Ozone S3 compatibility layer.
*
* This class models the Owner XML element in S3 responses, containing both a unique ID
* and a display name for the owner of buckets and objects.
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "Owner")
Expand Down