1/* 2 * Copyright (c) 1999, 2013, 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 26package com.sun.security.auth; 27 28import java.security.Principal; 29 30/** 31 * This class implements the {@code Principal} 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} 41 * may be associated with a particular {@code Subject} 42 * to augment that {@code Subject} with an additional 43 * identity. Refer to the {@code Subject} 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}. 46 * 47 * @see java.security.Principal 48 * @see javax.security.auth.Subject 49 */ 50public class NTSid implements Principal, java.io.Serializable { 51 52 private static final long serialVersionUID = 4412290580770249885L; 53 54 /** 55 * @serial 56 */ 57 private String sid; 58 59 /** 60 * Create an {@code NTSid} with a Windows NT SID. 61 * 62 * @param stringSid the Windows NT SID. 63 * 64 * @exception NullPointerException if the {@code String} 65 * is {@code null}. 66 * 67 * @exception IllegalArgumentException if the {@code String} 68 * has zero length. 69 */ 70 public NTSid (String stringSid) { 71 if (stringSid == null) { 72 java.text.MessageFormat form = new java.text.MessageFormat 73 (sun.security.util.ResourcesMgr.getAuthResourceString 74 ("invalid.null.input.value")); 75 Object[] source = {"stringSid"}; 76 throw new NullPointerException(form.format(source)); 77 } 78 if (stringSid.length() == 0) { 79 throw new IllegalArgumentException 80 (sun.security.util.ResourcesMgr.getAuthResourceString 81 ("Invalid.NTSid.value")); 82 } 83 sid = new String(stringSid); 84 } 85 86 /** 87 * Return a string version of this {@code NTSid}. 88 * 89 * @return a string version of this {@code NTSid} 90 */ 91 public String getName() { 92 return sid; 93 } 94 95 /** 96 * Return a string representation of this {@code NTSid}. 97 * 98 * @return a string representation of this {@code NTSid}. 99 */ 100 public String toString() { 101 java.text.MessageFormat form = new java.text.MessageFormat 102 (sun.security.util.ResourcesMgr.getAuthResourceString 103 ("NTSid.name")); 104 Object[] source = {sid}; 105 return form.format(source); 106 } 107 108 /** 109 * Compares the specified Object with this {@code NTSid} 110 * for equality. Returns true if the given object is also a 111 * {@code NTSid} and the two NTSids have the same String 112 * representation. 113 * 114 * @param o Object to be compared for equality with this 115 * {@code NTSid}. 116 * 117 * @return true if the specified Object is equal to this 118 * {@code NTSid}. 119 */ 120 public boolean equals(Object o) { 121 if (o == null) 122 return false; 123 124 if (this == o) 125 return true; 126 127 if (!(o instanceof NTSid)) 128 return false; 129 NTSid that = (NTSid)o; 130 131 if (sid.equals(that.sid)) { 132 return true; 133 } 134 return false; 135 } 136 137 /** 138 * Return a hash code for this {@code NTSid}. 139 * 140 * @return a hash code for this {@code NTSid}. 141 */ 142 public int hashCode() { 143 return sid.hashCode(); 144 } 145} 146