org.jets3t.service.acl
Class GroupGrantee

java.lang.Object
  extended by org.jets3t.service.acl.GroupGrantee
All Implemented Interfaces:
GranteeInterface
Direct Known Subclasses:
AllAuthenticatedUsersGrantee, AllUsersGrantee, GroupByDomainGrantee, GroupByEmailAddressGrantee, GroupByIdGrantee

public class GroupGrantee
extends java.lang.Object
implements GranteeInterface

Represents a Group grantee.

Only three groups are available in S3:
ALL_USERS: The general public
AUTHENTICATED_USERS: Authenticated Amazon S3 users
LOG_DELIVERY: Amazon's S3 Log Delivery group, who deliver bucket log files

Author:
James Murty

Field Summary
static GroupGrantee ALL_USERS
          The group of all users, represented in S3 by the URI: http://acs.amazonaws.com/groups/global/AllUsers
static GroupGrantee AUTHENTICATED_USERS
          The group of authenticated users, represented in S3 by the URI: http://acs.amazonaws.com/groups/global/AuthenticatedUsers
static GroupGrantee LOG_DELIVERY
          The group of Bucket Log delivery users, represented in S3 by the URI: http://acs.amazonaws.com/groups/s3/LogDelivery
 
Constructor Summary
GroupGrantee()
           
GroupGrantee(java.lang.String groupUri)
          Constructs a group grantee object using the given group URI as an identifier.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getIdentifier()
          Returns the group grantee's URI.
 int hashCode()
           
 void setIdentifier(java.lang.String uri)
          Set the group grantee's URI.
 java.lang.String toString()
           
 java.lang.String toXml()
           
 com.jamesmurty.utils.XMLBuilder toXMLBuilder()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ALL_USERS

public static final GroupGrantee ALL_USERS
The group of all users, represented in S3 by the URI: http://acs.amazonaws.com/groups/global/AllUsers


AUTHENTICATED_USERS

public static final GroupGrantee AUTHENTICATED_USERS
The group of authenticated users, represented in S3 by the URI: http://acs.amazonaws.com/groups/global/AuthenticatedUsers


LOG_DELIVERY

public static final GroupGrantee LOG_DELIVERY
The group of Bucket Log delivery users, represented in S3 by the URI: http://acs.amazonaws.com/groups/s3/LogDelivery

Constructor Detail

GroupGrantee

public GroupGrantee()

GroupGrantee

public GroupGrantee(java.lang.String groupUri)
Constructs a group grantee object using the given group URI as an identifier.

Note: All possible group types are available as public static variables from this class, so this constructor should rarely be necessary.

Parameters:
groupUri -
Method Detail

toXml

public java.lang.String toXml()
                       throws javax.xml.transform.TransformerException,
                              javax.xml.parsers.ParserConfigurationException,
                              javax.xml.parsers.FactoryConfigurationError
Specified by:
toXml in interface GranteeInterface
Returns:
the grantee represented in an XML fragment compatible with the S3 REST interface.
Throws:
javax.xml.transform.TransformerException
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError

toXMLBuilder

public com.jamesmurty.utils.XMLBuilder toXMLBuilder()
                                             throws javax.xml.transform.TransformerException,
                                                    javax.xml.parsers.ParserConfigurationException,
                                                    javax.xml.parsers.FactoryConfigurationError
Specified by:
toXMLBuilder in interface GranteeInterface
Throws:
javax.xml.transform.TransformerException
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError

setIdentifier

public void setIdentifier(java.lang.String uri)
Set the group grantee's URI.

Specified by:
setIdentifier in interface GranteeInterface

getIdentifier

public java.lang.String getIdentifier()
Returns the group grantee's URI.

Specified by:
getIdentifier in interface GranteeInterface

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object