com.amazonaws.services.s3.model

Enum GroupGrantee

java.lang.Object

java.lang.Enum<GroupGrantee>

com.amazonaws.services.s3.model.GroupGrantee

All Implemented Interfaces:

Grantee, Serializable, Comparable<GroupGrantee>

public enum GroupGrantee
extends Enum<GroupGrantee>
implements Grantee

Specifies constants defining a group of Amazon S3 users who can be granted permissions to Amazon S3 buckets and objects. This enumeration contains all the valid Amazon S3 group grantees.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AllUsers Grants anonymous access to any Amazon S3 object or bucket.
AuthenticatedUsers Grants access to buckets or objects to anyone with an Amazon Web Services account.
LogDelivery Grants access to Amazon S3 log delivery so that an S3 bucket can receive server access logs.

Method Summary

Modifier and Type	Method and Description
String	getIdentifier() Gets the group grantee's URI.
String	getTypeIdentifier() Returns the identifier for the type of this grant, to be used when specifying grants in the header of a request.
static GroupGrantee	parseGroupGrantee(String groupUri) Gets the GroupGrantee enumeration value with the specified Amazon S3 group URI (eg.
void	setIdentifier(String id) For internal use only.
String	toString()
static GroupGrantee	valueOf(String name) Returns the enum constant of this type with the specified name.
static GroupGrantee[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AllUsers

public static final GroupGrantee AllUsers

Grants anonymous access to any Amazon S3 object or bucket. Any user will be able to access the object by omitting the Amazon Web Services Key ID and Signature from a request.

Amazon highly recommends that users do not grant the AllUsers group write access to their buckets. If granted, users will have no control over the objects others can store and their associated charges.

AuthenticatedUsers

public static final GroupGrantee AuthenticatedUsers

Grants access to buckets or objects to anyone with an Amazon Web Services account. Although this is inherently insecure as any Amazon Web Services user who is aware of the bucket or object will be able to access it, users may find this authentication method useful.

LogDelivery

public static final GroupGrantee LogDelivery

Grants access to Amazon S3 log delivery so that an S3 bucket can receive server access logs. Turning on server access logging for an Amazon S3 bucket requires that the bucket receiving the logs is granted permission for the log delivery group to deliver logs.

Method Detail

values

public static GroupGrantee[] 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 (GroupGrantee c : GroupGrantee.values())
    System.out.println(c);

Returns:

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

valueOf

public static GroupGrantee 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

getTypeIdentifier

public String getTypeIdentifier()

Description copied from interface: Grantee

Returns the identifier for the type of this grant, to be used when specifying grants in the header of a request.

Specified by:

getTypeIdentifier in interface Grantee

getIdentifier

public String getIdentifier()

Gets the group grantee's URI.

Specified by:

getIdentifier in interface Grantee

Returns:

The group grantee's URI.

See Also:

Grantee.setIdentifier(String)

setIdentifier

public void setIdentifier(String id)

For internal use only. Group grantees have preset identifiers that cannot be modified.

Specified by:

setIdentifier in interface Grantee

Parameters:

id - The identifier for this grantee.

See Also:

Grantee.getIdentifier()

toString

public String toString()

Overrides:

toString in class Enum<GroupGrantee>

See Also:

Enum.toString()

parseGroupGrantee

public static GroupGrantee parseGroupGrantee(String groupUri)

Gets the GroupGrantee enumeration value with the specified Amazon S3 group URI (eg. http://acs.amazonaws.com/groups/global/AllUsers). Returns null if an invalid Amazon S3 group URI is specified.

Parameters:

groupUri - A string representation of an Amazon S3 group URI (eg. http://acs.amazonaws.com/groups/global/AllUsers)

Returns:

The GroupGrantee object represented by the given Amazon S3 group URI string. Returns null if the string isn't a valid Amazon S3 group URI.