modules/federation/FederationPrincipal.java

	FederationPrincipal.java revision 4a2f0f0be43dfd4c1b490cbf3cc48b6ba6084b1c
/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: FederationPrincipal.java,v 1.2 2008/06/25 05:49:31 qcheng Exp $
 *
 */

package com.sun.identity.authentication.modules.federation;

import java.io.Serializable;
import java.security.Principal;

public class FederationPrincipal implements Principal, Serializable {

    /**
     * @serial
     */
    private String name;


    public FederationPrincipal(String name) {
        if (name == null) {
            throw new NullPointerException("illegal null input");
    }
        this.name = name;
    }

    /**
     * Return the LDAP username for this <code>FederationPrincipal</code>.
     *
     * <p>
     *
     * @return the LDAP username for this <code>FederationPrincipal</code>
     */
    public String getName() {
        return name;
    }

    /**
     * Return a string representation of this <code>FederationPrincipal</code>.
     *
     * <p>
     *
     * @return a string representation of this <code>FederationPrincipal</code>.
     */
    public String toString() {
        return("FederationPrincipal:  " + name);
    }

    /**
     * Compares the specified Object with this <code>FederationPrincipal</code>
     * for equality.  Returns true if the given object is also a
     * <code>FederationPrincipal</code> and the two FederationPrincipals
     * have the same username.
     *
     * <p>
     *
     * @param o Object to be compared for equality with this
     *                <code>FederationPrincipal</code>.
     *
     * @return true if the specified Object is equal equal to this
     *                <code>FederationPrincipal</code>.
     */
    public boolean equals(Object o) {
        if (o == null) {
            return false;
    }
        if (this == o) {
            return true;
    }
        if (!(o instanceof FederationPrincipal)) {
            return false;
    }
    FederationPrincipal that = (FederationPrincipal)o;

        if (this.getName().equals(that.getName())) {
            return true;
    }
    return false;
    }

    /**
     * Return a hash code for this <code>FederationPrincipal</code>.
     *
     * <p>
     *
     * @return a hash code for this <code>FederationPrincipal</code>.
     */
    public int hashCode() {
        return name.hashCode();
    }
}