1 /*
2 * Copyright (c) 1999, 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 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 public 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</code> with a Windows NT SID.
61 *
62 * <p>
63 *
64 * @param stringSid the Windows NT SID. <p>
65 *
66 * @exception NullPointerException if the <code>String</code>
67 * is <code>null</code>.
68 *
69 * @exception IllegalArgumentException if the <code>String</code>
70 * has zero length.
71 */
72 public NTSid (String stringSid) {
73 if (stringSid == null) {
74 java.text.MessageFormat form = new java.text.MessageFormat
75 (sun.security.util.ResourcesMgr.getString
76 ("invalid null input: value",
77 "sun.security.util.AuthResources"));
78 Object[] source = {"stringSid"};
79 throw new NullPointerException(form.format(source));
80 }
81 if (stringSid.length() == 0) {
82 throw new IllegalArgumentException
83 (sun.security.util.ResourcesMgr.getString
84 ("Invalid NTSid value",
85 "sun.security.util.AuthResources"));
86 }
87 sid = new String(stringSid);
88 }
89
90 /**
91 * Return a string version of this <code>NTSid</code>.
92 *
93 * <p>
94 *
95 * @return a string version of this <code>NTSid</code>
96 */
97 public String getName() {
98 return sid;
99 }
100
101 /**
102 * Return a string representation of this <code>NTSid</code>.
103 *
104 * <p>
105 *
106 * @return a string representation of this <code>NTSid</code>.
107 */
108 public String toString() {
109 java.text.MessageFormat form = new java.text.MessageFormat
110 (sun.security.util.ResourcesMgr.getString
111 ("NTSid: name",
112 "sun.security.util.AuthResources"));
113 Object[] source = {sid};
114 return form.format(source);
115 }
116
117 /**
118 * Compares the specified Object with this <code>NTSid</code>
119 * for equality. Returns true if the given object is also a
120 * <code>NTSid</code> and the two NTSids have the same String
121 * representation.
122 *
123 * <p>
124 *
125 * @param o Object to be compared for equality with this
126 * <code>NTSid</code>.
127 *
128 * @return true if the specified Object is equal to this
129 * <code>NTSid</code>.
130 */
131 public boolean equals(Object o) {
132 if (o == null)
133 return false;
134
135 if (this == o)
136 return true;
137
138 if (!(o instanceof NTSid))
139 return false;
140 NTSid that = (NTSid)o;
141
142 if (sid.equals(that.sid)) {
143 return true;
144 }
145 return false;
146 }
147
148 /**
149 * Return a hash code for this <code>NTSid</code>.
150 *
151 * <p>
152 *
153 * @return a hash code for this <code>NTSid</code>.
154 */
155 public int hashCode() {
156 return sid.hashCode();
157 }
158 }