modules/membership/MembershipPrincipal.java

2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster/**
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * The contents of this file are subject to the terms
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * of the Common Development and Distribution License
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * (the License). You may not use this file except in
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * compliance with the License.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * You can obtain a copy of the License at
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * opensso/legal/CDDLv1.0.txt
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * See the License for the specific language governing
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * permission and limitations under the License.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * When distributing Covered Code, include this CDDL
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * Header Notice in each file and include the License file
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * at opensso/legal/CDDLv1.0.txt.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * If applicable, add the following below the CDDL Header,
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * with the fields enclosed by brackets [] replaced by
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * your own identifying information:
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * $Id: MembershipPrincipal.java,v 1.2 2008/06/25 05:41:58 qcheng Exp $
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster */
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Fosterpackage com.sun.identity.authentication.modules.membership;
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Fosterimport java.security.Principal;
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster/**
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * This class implements the <code>Principal</code> interface
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * and represents an Membership user.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * <p>
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster Principals such as this <code>MembershipPrincipal</code>
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * may be associated with a particular <code>Subject</code>
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * to augment that <code>Subject</code> with an additional
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * identity.  Refer to the <code>Subject</code> class for more information
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * on how to achieve this.  Authorization decisions can then be based upon
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster * the Principals associated with a <code>Subject</code>.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster */
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Fosterpublic class MembershipPrincipal implements Principal, java.io.Serializable {
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    private String name;
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    /**
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * Creates a <code>MembershipPrincipal</code> with a Membership user name.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * @param name the Membership user name for this user.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * @exception NullPointerException if the <code>name</code> is
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     *            <code>null</code>.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     */
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    public MembershipPrincipal(String name) {
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        if (name == null) {
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster            throw new NullPointerException("illegal null input");
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        }
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        this.name = name;
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    }
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    /**
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * Returns the Membership user name for this
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * <code>MembershipPrincipal</code>.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * @return the Membership user name for this
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     *         <code>MembershipPrincipal</code>
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     */
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    public String getName() {
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        return name;
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    }
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    /**
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * Returns a string representation of this
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * <code>MembershipPrincipal</code>.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * @return a string representation of this
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     *         <code>MembershipPrincipal</code>.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     */
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    public String toString() {
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        return("MembershipPrincipal: " + name);
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    }
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    /**
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * Compares the specified Object with this <code>MembershipPrincipal
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * </code> for equality.  Returns true if the given object is also a
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * <code>MembershipPrincipal</code> and the two
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * <code>MembershipPrincipals</code> have the same user name.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * @param o Object to be compared for equality with this
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     *        <code>MembershipPrincipal</code>.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * @return true if the specified Object is equal equal to this
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     *         <code>MembershipPrincipal</code>.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     */
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    public boolean equals(Object o) {
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        if (o == null) {
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster            return false;
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        }
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        if (this == o) {
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster            return true;
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        }
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        if (!(o instanceof MembershipPrincipal)) {
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster            return false;
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        }
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        MembershipPrincipal that = (MembershipPrincipal)o;
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        return this.getName().equals(that.getName());
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    }
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    /**
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * Returns a hash code for this <code>MembershipPrincipal</code>.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     *
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     * @return a hash code for this <code>MembershipPrincipal</code>.
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster     */
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    public int hashCode() {
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster        return name.hashCode();
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster    }
2d0a88b18a041738cfe635b45bd1db56af469c91Allan Foster}