1 /* 2 * Copyright (c) 2000, 2003, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.security.auth; 27 28 import java.security.Principal; 29 30 /** 31 * <p> This class implements the <code>Principal</code> interface 32 * and represents a Unix user. 33 * 34 * <p> Principals such as this <code>UnixPrincipal</code> 35 * may be associated with a particular <code>Subject</code> 36 * to augment that <code>Subject</code> with an additional 37 * identity. Refer to the <code>Subject</code> class for more information 38 * on how to achieve this. Authorization decisions can then be based upon 39 * the Principals associated with a <code>Subject</code>. 40 * 41 * @see java.security.Principal 42 * @see javax.security.auth.Subject 43 */ 44 public class UnixPrincipal implements Principal, java.io.Serializable { 45 46 private static final long serialVersionUID = -2951667807323493631L; 47 48 /** 49 * @serial 50 */ 51 private String name; 52 53 /** 54 * Create a UnixPrincipal with a Unix username. 55 * 56 * <p> 57 * 58 * @param name the Unix username for this user. 59 * 60 * @exception NullPointerException if the <code>name</code> 61 * is <code>null</code>. 62 */ 63 public UnixPrincipal(String name) { 64 if (name == null) { 65 java.text.MessageFormat form = new java.text.MessageFormat 66 (sun.security.util.ResourcesMgr.getString 67 ("invalid null input: value", 68 "sun.security.util.AuthResources")); 69 Object[] source = {"name"}; 70 throw new NullPointerException(form.format(source)); 71 } 72 73 this.name = name; 74 } 75 76 /** 77 * Return the Unix username for this <code>UnixPrincipal</code>. 78 * 79 * <p> 80 * 81 * @return the Unix username for this <code>UnixPrincipal</code> 82 */ 83 public String getName() { 84 return name; 85 } 86 87 /** 88 * Return a string representation of this <code>UnixPrincipal</code>. 89 * 90 * <p> 91 * 92 * @return a string representation of this <code>UnixPrincipal</code>. 93 */ 94 public String toString() { 95 java.text.MessageFormat form = new java.text.MessageFormat 96 (sun.security.util.ResourcesMgr.getString 97 ("UnixPrincipal: name", 98 "sun.security.util.AuthResources")); 99 Object[] source = {name}; 100 return form.format(source); 101 } 102 103 /** 104 * Compares the specified Object with this <code>UnixPrincipal</code> 105 * for equality. Returns true if the given object is also a 106 * <code>UnixPrincipal</code> and the two UnixPrincipals 107 * have the same username. 108 * 109 * <p> 110 * 111 * @param o Object to be compared for equality with this 112 * <code>UnixPrincipal</code>. 113 * 114 * @return true if the specified Object is equal equal to this 115 * <code>UnixPrincipal</code>. 116 */ 117 public boolean equals(Object o) { 118 if (o == null) 119 return false; 120 121 if (this == o) 122 return true; 123 124 if (!(o instanceof UnixPrincipal)) 125 return false; 126 UnixPrincipal that = (UnixPrincipal)o; 127 128 if (this.getName().equals(that.getName())) 129 return true; 130 return false; 131 } 132 133 /** 134 * Return a hash code for this <code>UnixPrincipal</code>. 135 * 136 * <p> 137 * 138 * @return a hash code for this <code>UnixPrincipal</code>. 139 */ 140 public int hashCode() { 141 return name.hashCode(); 142 } 143 }