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 information about a Windows NT user, group or realm. 33 * 34 * <p> Windows NT chooses to represent users, groups and realms (or domains) 35 * with not only common names, but also relatively unique numbers. These 36 * numbers are called Security IDentifiers, or SIDs. Windows NT 37 * also provides services that render these SIDs into string forms. 38 * This class represents these string forms. 39 * 40 * <p> Principals such as this <code>NTSid</code> 41 * may be associated with a particular <code>Subject</code> 42 * to augment that <code>Subject</code> with an additional 43 * identity. Refer to the <code>Subject</code> class for more information 44 * on how to achieve this. Authorization decisions can then be based upon 45 * the Principals associated with a <code>Subject</code>. 46 * 47 * @see java.security.Principal 48 * @see javax.security.auth.Subject 49 */ 50 @jdk.Supported 51 public class NTSid implements Principal, java.io.Serializable { 52 53 private static final long serialVersionUID = 4412290580770249885L; 54 55 /** 56 * @serial 57 */ 58 private String sid; 59 60 /** 61 * Create an <code>NTSid</code> with a Windows NT SID. 62 * 63 * <p> 64 * 65 * @param stringSid the Windows NT SID. <p> 66 * 67 * @exception NullPointerException if the <code>String</code> 68 * is <code>null</code>. 69 * 70 * @exception IllegalArgumentException if the <code>String</code> 71 * has zero length. 72 */ 73 public NTSid (String stringSid) { 74 if (stringSid == null) { 75 java.text.MessageFormat form = new java.text.MessageFormat 76 (sun.security.util.ResourcesMgr.getString 77 ("invalid.null.input.value", 78 "sun.security.util.AuthResources")); 79 Object[] source = {"stringSid"}; 80 throw new NullPointerException(form.format(source)); 81 } 82 if (stringSid.length() == 0) { 83 throw new IllegalArgumentException 84 (sun.security.util.ResourcesMgr.getString 85 ("Invalid.NTSid.value", 86 "sun.security.util.AuthResources")); 87 } 88 sid = new String(stringSid); 89 } 90 91 /** 92 * Return a string version of this <code>NTSid</code>. 93 * 94 * <p> 95 * 96 * @return a string version of this <code>NTSid</code> 97 */ 98 public String getName() { 99 return sid; 100 } 101 102 /** 103 * Return a string representation of this <code>NTSid</code>. 104 * 105 * <p> 106 * 107 * @return a string representation of this <code>NTSid</code>. 108 */ 109 public String toString() { 110 java.text.MessageFormat form = new java.text.MessageFormat 111 (sun.security.util.ResourcesMgr.getString 112 ("NTSid.name", 113 "sun.security.util.AuthResources")); 114 Object[] source = {sid}; 115 return form.format(source); 116 } 117 118 /** 119 * Compares the specified Object with this <code>NTSid</code> 120 * for equality. Returns true if the given object is also a 121 * <code>NTSid</code> and the two NTSids have the same String 122 * representation. 123 * 124 * <p> 125 * 126 * @param o Object to be compared for equality with this 127 * <code>NTSid</code>. 128 * 129 * @return true if the specified Object is equal to this 130 * <code>NTSid</code>. 131 */ 132 public boolean equals(Object o) { 133 if (o == null) 134 return false; 135 136 if (this == o) 137 return true; 138 139 if (!(o instanceof NTSid)) 140 return false; 141 NTSid that = (NTSid)o; 142 143 if (sid.equals(that.sid)) { 144 return true; 145 } 146 return false; 147 } 148 149 /** 150 * Return a hash code for this <code>NTSid</code>. 151 * 152 * <p> 153 * 154 * @return a hash code for this <code>NTSid</code>. 155 */ 156 public int hashCode() { 157 return sid.hashCode(); 158 } 159 }