modules/windowsdesktopsso/WindowsDesktopSSOPrincipal.java

	WindowsDesktopSSOPrincipal.java revision 2d0a88b18a041738cfe635b45bd1db56af469c91
/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2005 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: WindowsDesktopSSOPrincipal.java,v 1.3 2008/06/25 05:42:03 qcheng Exp $
 *
 */


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

import java.security.Principal;

public class WindowsDesktopSSOPrincipal implements Principal,
    java.io.Serializable {

    private String name;

    /**
     * Constructor
     * @param name Name for the principal.
     */
    public WindowsDesktopSSOPrincipal(String name) {
        this.name = name;
    }

    /**
     * Returns the desktop user name.
     * @return desktop user name
     */
    public String getName() {
        return name;
    }

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

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

        if (this == obj) {
            return true;
        }

        if (! (obj instanceof WindowsDesktopSSOPrincipal)) {
            return false;
        }

        WindowsDesktopSSOPrincipal wtp = (WindowsDesktopSSOPrincipal)obj;
        if (name.equals(wtp.getName())) {
            return true;
        }
        return false;
    }

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