src.org.jets3t.service.acl.CanonicalGrantee Maven / Gradle / Ivy

Go to download
/*
 * jets3t : Java Extra-Tasty S3 Toolkit (for Amazon S3 online storage service)
 * This is a java.net project, see https://jets3t.dev.java.net/
 * 
 * Copyright 2006 James Murty
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 org.jets3t.service.acl;

/**
 * Represents a grantee identified by their canonical Amazon ID, which is something along the lines
 * of 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).  
 * 
 * @author James Murty
 *
 */
public class CanonicalGrantee implements GranteeInterface {
	private String id = null;
	private String displayName = null;
	
    /**
     * Default constructor.
     * 
     * Warning! If created with this constructor this class will not
     * represent a valid grantee until the identifier is set. 
     */
	public CanonicalGrantee() {
	}
	
    /**
     * Constructs a grantee with the given canonical ID.
     * @param identifier
     */
	public CanonicalGrantee(String identifier) {
		this.setIdentifier(identifier);
	}

	public String toXml() {
		return "" + id + ""
			+ "";
	}

	public void setIdentifier(String id) {
		this.id = id;
	}	
	
	public String getIdentifier() {
		return id;
	}
	
	public void setDisplayName(String displayName) {
		this.displayName = displayName;
	}
    
    public String getDisplayName() {
        return this.displayName;
    }
	
	public boolean equals(Object obj) {
		if (obj instanceof CanonicalGrantee) {
			CanonicalGrantee canonicalGrantee = (CanonicalGrantee) obj;
			return id.equals(canonicalGrantee.id);
		} 
		return false;
	}
	
	public int hashCode() {		
		return id.hashCode();
	}

}