com.ibm.cloud.objectstorage.services.s3.model

Class CanonicalGrantee

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.model.CanonicalGrantee

All Implemented Interfaces:

Grantee, Serializable

public class CanonicalGrantee
extends Object
implements Grantee, Serializable

Represents a grantee identified by their canonical Amazon ID. The canonical Amazon ID can be thought of as an Amazon-internal ID specific to a user. For example, Amazon can map a grantee identified by an email address to a canonical ID.

Canonical grantees may have an associated display name, which is a human-friendly name that Amazon has linked to the canonical ID (eg. the user's login name).

See Also:

CanonicalGrantee(String), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CanonicalGrantee(String identifier) Constructs a new CanonicalGrantee object with the given canonical ID.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDisplayName() Returns the display name for this grantee.
String	getIdentifier() Returns the unique identifier for this grantee.
String	getTypeIdentifier() Returns the identifier for the type of this grant, to be used when specifying grants in the header of a request.
int	hashCode()
void	setDisplayName(String displayName) Sets the display name for this grantee.
void	setIdentifier(String id) Sets the unique identifier for this grantee.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CanonicalGrantee

public CanonicalGrantee(String identifier)

Constructs a new CanonicalGrantee object with the given canonical ID.

Parameters:

identifier -

Method Detail

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

setIdentifier

public void setIdentifier(String id)

Sets the unique identifier for this grantee.

Specified by:

setIdentifier in interface Grantee

Parameters:

id - The identifier for this grantee.

See Also:

CanonicalGrantee.getIdentifier()

getIdentifier

public String getIdentifier()

Returns the unique identifier for this grantee.

Specified by:

getIdentifier in interface Grantee

Returns:

The identifier for this grantee.

See Also:

CanonicalGrantee.setIdentifier(String)

setDisplayName

public void setDisplayName(String displayName)

Sets the display name for this grantee.

Parameters:

displayName -

See Also:

CanonicalGrantee.getDisplayName()

getDisplayName

public String getDisplayName()

Returns the display name for this grantee.

Returns:

The display name for this grantee.

See Also:

CanonicalGrantee.setDisplayName(String)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object