/*
 * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.security.auth;

import java.security.Principal;
import sun.security.x509.X500Name;
import static sun.security.util.ResourcesMgr.getAuthResourceString;

This class represents an X.500 Principal. X500Principals have names such as, "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US" (RFC 1779 style).

Principals such as this X500Principal may be associated with a particular Subject to augment that Subject with an additional identity. Refer to the Subject class for more information on how to achieve this. Authorization decisions can then be based upon the Principals associated with a Subject.

See Also:
Deprecated:A new X500Principal class is available in the Java platform. This X500Principal classs is entirely deprecated and is here to allow for a smooth transition to the new class. This class is subject to removal in a future version of Java SE.
/** * This class represents an X.500 {@code Principal}. * X500Principals have names such as, * "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US" * (RFC 1779 style). * * <p> Principals such as this {@code X500Principal} * may be associated with a particular {@code Subject} * to augment that {@code Subject} with an additional * identity. Refer to the {@code Subject} class for more information * on how to achieve this. Authorization decisions can then be based upon * the Principals associated with a {@code Subject}. * * @see java.security.Principal * @see javax.security.auth.Subject * @deprecated A new X500Principal class is available in the Java platform. * This X500Principal classs is entirely deprecated and * is here to allow for a smooth transition to the new * class. * This class is subject to removal in a future version of Java SE. * @see javax.security.auth.x500.X500Principal */
@Deprecated(since="1.4", forRemoval=true) public class X500Principal implements Principal, java.io.Serializable { private static final long serialVersionUID = -8222422609431628648L;
@serial
/** * @serial */
private String name; transient private X500Name thisX500Name;
Create a X500Principal with an X.500 Name, such as "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US" (RFC 1779 style).
Params:
  • name – the X.500 name
Throws:
/** * Create a X500Principal with an X.500 Name, * such as "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US" * (RFC 1779 style). * * @param name the X.500 name * * @exception NullPointerException if the {@code name} * is {@code null}. * * @exception IllegalArgumentException if the {@code name} * is improperly specified. */
public X500Principal(String name) { if (name == null) throw new NullPointerException(getAuthResourceString("provided.null.name")); try { thisX500Name = new X500Name(name); } catch (Exception e) { throw new IllegalArgumentException(e.toString()); } this.name = name; }
Return the Unix username for this X500Principal.
Returns:the Unix username for this X500Principal
/** * Return the Unix username for this {@code X500Principal}. * * @return the Unix username for this {@code X500Principal} */
public String getName() { return thisX500Name.getName(); }
Return a string representation of this X500Principal.
Returns:a string representation of this X500Principal.
/** * Return a string representation of this {@code X500Principal}. * * @return a string representation of this {@code X500Principal}. */
public String toString() { return thisX500Name.toString(); }
Compares the specified Object with this X500Principal for equality.
Params:
  • o – Object to be compared for equality with this X500Principal.
Returns:true if the specified Object is equal to this X500Principal.
/** * Compares the specified Object with this {@code X500Principal} * for equality. * * @param o Object to be compared for equality with this * {@code X500Principal}. * * @return true if the specified Object is equal to this * {@code X500Principal}. */
public boolean equals(Object o) { if (o == null) return false; if (this == o) return true; if (o instanceof X500Principal) { X500Principal that = (X500Principal)o; try { X500Name thatX500Name = new X500Name(that.getName()); return thisX500Name.equals(thatX500Name); } catch (Exception e) { // any parsing exceptions, return false return false; } } else if (o instanceof Principal) { // this will return 'true' if 'o' is a sun.security.x509.X500Name // and the X500Names are equal return o.equals(thisX500Name); } return false; }
Return a hash code for this X500Principal.
Returns:a hash code for this X500Principal.
/** * Return a hash code for this {@code X500Principal}. * * @return a hash code for this {@code X500Principal}. */
public int hashCode() { return thisX500Name.hashCode(); }
Reads this object from a stream (i.e., deserializes it)
/** * Reads this object from a stream (i.e., deserializes it) */
private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, java.io.NotActiveException, ClassNotFoundException { s.defaultReadObject(); // re-create thisX500Name thisX500Name = new X500Name(name); } }