1 /* 2 * Copyright (c) 1999, 2010, 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 the name of the Windows NT domain into which the 33 * user authenticated. This will be a domain name if the user logged 34 * into a Windows NT domain, a workgroup name if the user logged into 35 * a workgroup, or a machine name if the user logged into a standalone 36 * configuration. 37 * 38 * <p> Principals such as this <code>NTDomainPrincipal</code> 39 * may be associated with a particular <code>Subject</code> 40 * to augment that <code>Subject</code> with an additional 41 * identity. Refer to the <code>Subject</code> class for more information 42 * on how to achieve this. Authorization decisions can then be based upon 43 * the Principals associated with a <code>Subject</code>. 44 * 45 * @see java.security.Principal 46 * @see javax.security.auth.Subject 47 */ 48 @jdk.Supported 49 public class NTDomainPrincipal implements Principal, java.io.Serializable { 50 51 private static final long serialVersionUID = -4408637351440771220L; 52 53 /** 54 * @serial 55 */ 56 private String name; 57 58 /** 59 * Create an <code>NTDomainPrincipal</code> with a Windows NT domain name. 60 * 61 * <p> 62 * 63 * @param name the Windows NT domain name for this user. <p> 64 * 65 * @exception NullPointerException if the <code>name</code> 66 * is <code>null</code>. 67 */ 68 public NTDomainPrincipal(String name) { 69 if (name == null) { 70 java.text.MessageFormat form = new java.text.MessageFormat 71 (sun.security.util.ResourcesMgr.getString 72 ("invalid.null.input.value", 73 "sun.security.util.AuthResources")); 74 Object[] source = {"name"}; 75 throw new NullPointerException(form.format(source)); 76 } 77 this.name = name; 78 } 79 80 /** 81 * Return the Windows NT domain name for this 82 * <code>NTDomainPrincipal</code>. 83 * 84 * <p> 85 * 86 * @return the Windows NT domain name for this 87 * <code>NTDomainPrincipal</code> 88 */ 89 public String getName() { 90 return name; 91 } 92 93 /** 94 * Return a string representation of this <code>NTDomainPrincipal</code>. 95 * 96 * <p> 97 * 98 * @return a string representation of this <code>NTDomainPrincipal</code>. 99 */ 100 public String toString() { 101 java.text.MessageFormat form = new java.text.MessageFormat 102 (sun.security.util.ResourcesMgr.getString 103 ("NTDomainPrincipal.name", 104 "sun.security.util.AuthResources")); 105 Object[] source = {name}; 106 return form.format(source); 107 } 108 109 /** 110 * Compares the specified Object with this <code>NTDomainPrincipal</code> 111 * for equality. Returns true if the given object is also a 112 * <code>NTDomainPrincipal</code> and the two NTDomainPrincipals 113 * have the same name. 114 * 115 * <p> 116 * 117 * @param o Object to be compared for equality with this 118 * <code>NTDomainPrincipal</code>. 119 * 120 * @return true if the specified Object is equal equal to this 121 * <code>NTDomainPrincipal</code>. 122 */ 123 public boolean equals(Object o) { 124 if (o == null) 125 return false; 126 127 if (this == o) 128 return true; 129 130 if (!(o instanceof NTDomainPrincipal)) 131 return false; 132 NTDomainPrincipal that = (NTDomainPrincipal)o; 133 134 if (name.equals(that.getName())) 135 return true; 136 return false; 137 } 138 139 /** 140 * Return a hash code for this <code>NTDomainPrincipal</code>. 141 * 142 * <p> 143 * 144 * @return a hash code for this <code>NTDomainPrincipal</code>. 145 */ 146 public int hashCode() { 147 return this.getName().hashCode(); 148 } 149 }