Grantee.java

/*
 * Copyright 2010-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Portions copyright 2006-2009 James Murty. Please see LICENSE.txt
 * for applicable license terms and NOTICE.txt for applicable notices.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.services.s3.model;

/**
 * Represents a grantee (entity) that can be assigned access permissions in an
 * {@link AccessControlList}. All grantees have an ID of some kind, though the
 * format of the ID can differ depending on the kind of grantee.
 */
public interface Grantee {

    /**
     * Returns the identifier for the type of this grant, to be used when
     * specifying grants in the header of a request.
     */
    public String getTypeIdentifier();
    
    /**
     * Sets the identifier for this grantee. The meaning of the identifier is
     * specific to each implementation of the {@link Grantee}.
     *
     * @param id
     *            The identifier for this grantee.
     *            
     * @see Grantee#getIdentifier()        
     */
    public void setIdentifier(String id);

    /**
     * Gets the identifier for this grantee. The meaning of the grantee
     * identifier is specific to each implementation of the {@link Grantee}.
     *
     * @return The identifier for this grantee.
     * 
     * @see Grantee#setIdentifier() 
     */
    public String getIdentifier();

}