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 /** 29 * <p> This class extends <code>NTSid</code> 30 * and represents a Windows NT user's domain SID. 31 * 32 * <p> An NT user only has a domain SID if in fact they are logged 33 * into an NT domain. If the user is logged into a workgroup or 34 * just a standalone configuration, they will NOT have a domain SID. 35 * 36 * <p> Principals such as this <code>NTSidDomainPrincipal</code> 37 * may be associated with a particular <code>Subject</code> 38 * to augment that <code>Subject</code> with an additional 39 * identity. Refer to the <code>Subject</code> class for more information 40 * on how to achieve this. Authorization decisions can then be based upon 41 * the Principals associated with a <code>Subject</code>. 42 * 43 * @see java.security.Principal 44 * @see javax.security.auth.Subject 45 */ 46 @jdk.Supported 47 public class NTSidDomainPrincipal extends NTSid { 48 49 private static final long serialVersionUID = 5247810785821650912L; 50 51 /** 52 * Create an <code>NTSidDomainPrincipal</code> with a Windows NT SID. 53 * 54 * <p> 55 * 56 * @param name a string version of the Windows NT SID for this 57 * user's domain.<p> 58 * 59 * @exception NullPointerException if the <code>name</code> 60 * is <code>null</code>. 61 */ 62 public NTSidDomainPrincipal(String name) { 63 super(name); 64 } 65 66 /** 67 * Return a string representation of this <code>NTSidDomainPrincipal</code>. 68 * 69 * <p> 70 * 71 * @return a string representation of this 72 * <code>NTSidDomainPrincipal</code>. 73 */ 74 public String toString() { 75 java.text.MessageFormat form = new java.text.MessageFormat 76 (sun.security.util.ResourcesMgr.getString 77 ("NTSidDomainPrincipal.name", 78 "sun.security.util.AuthResources")); 79 Object[] source = {getName()}; 80 return form.format(source); 81 } 82 83 /** 84 * Compares the specified Object with this <code>NTSidDomainPrincipal</code> 85 * for equality. Returns true if the given object is also a 86 * <code>NTSidDomainPrincipal</code> and the two NTSidDomainPrincipals 87 * have the same SID. 88 * 89 * <p> 90 * 91 * @param o Object to be compared for equality with this 92 * <code>NTSidDomainPrincipal</code>. 93 * 94 * @return true if the specified Object is equal equal to this 95 * <code>NTSidDomainPrincipal</code>. 96 */ 97 public boolean equals(Object o) { 98 if (o == null) 99 return false; 100 101 if (this == o) 102 return true; 103 104 if (!(o instanceof NTSidDomainPrincipal)) 105 return false; 106 107 return super.equals(o); 108 } 109 }