Skip to content

Commit c9f1419

Browse files
committed
docs: add javadoc on S3ACl, S3BucketACl and S3Owner
1 parent 3bb8858 commit c9f1419

3 files changed

Lines changed: 18 additions & 5 deletions

File tree

hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Acl.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
import org.slf4j.LoggerFactory;
3434

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

9292
/**
93-
* TODO: javadoc.
93+
* Represents the different types of identities that can be granted permissions in an S3 ACL.
9494
*/
9595
enum ACLIdentityType {
9696
USER("CanonicalUser", true, "id"),

hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3BucketAcl.java

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,11 @@ public String toString() {
6666
}
6767

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

102106
/**
103-
* TODO: javadoc.
107+
* Represents a single permission grant within an S3 Access Control List.
108+
*
109+
* This class models the Grant XML element in S3 ACL responses and requests,
110+
* associating a specific permission with a grantee (the recipient of the permission).
111+
* Each Grant consists of a Grantee (which identifies a user, group, or other entity)
112+
* and a Permission string that specifies what access level is being granted.
104113
*/
105114
@XmlAccessorType(XmlAccessType.FIELD)
106115
@XmlRootElement(name = "Grant")

hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Owner.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,11 @@
2323
import javax.xml.bind.annotation.XmlRootElement;
2424

2525
/**
26-
* TODO: javadoc.
26+
* Represents an owner of S3 resources in the Ozone S3 compatibility layer.
27+
*
28+
* This class models the Owner XML element in S3 responses, containing both a unique ID
29+
* and a display name for the owner of buckets and objects.
30+
*
2731
*/
2832
@XmlAccessorType(XmlAccessType.FIELD)
2933
@XmlRootElement(name = "Owner")

0 commit comments

Comments
 (0)