NTSid.java revision 13430:5e8370fb3ed9 
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.getString
74                        ("invalid.null.input.value",
75                        "sun.security.util.AuthResources"));
76            Object[] source = {"stringSid"};
77            throw new NullPointerException(form.format(source));
78        }
79        if (stringSid.length() == 0) {
80            throw new IllegalArgumentException
81                (sun.security.util.ResourcesMgr.getString
82                        ("Invalid.NTSid.value",
83                        "sun.security.util.AuthResources"));
84        }
85        sid = new String(stringSid);
86    }
87
88    /**
89     * Return a string version of this {@code NTSid}.
90     *
91     * @return a string version of this {@code NTSid}
92     */
93    public String getName() {
94        return sid;
95    }
96
97    /**
98     * Return a string representation of this {@code NTSid}.
99     *
100     * @return a string representation of this {@code NTSid}.
101     */
102    public String toString() {
103        java.text.MessageFormat form = new java.text.MessageFormat
104                (sun.security.util.ResourcesMgr.getString
105                        ("NTSid.name",
106                        "sun.security.util.AuthResources"));
107        Object[] source = {sid};
108        return form.format(source);
109    }
110
111    /**
112     * Compares the specified Object with this {@code NTSid}
113     * for equality.  Returns true if the given object is also a
114     * {@code NTSid} and the two NTSids have the same String
115     * representation.
116     *
117     * @param o Object to be compared for equality with this
118     *          {@code NTSid}.
119     *
120     * @return true if the specified Object is equal to this
121     *          {@code NTSid}.
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 NTSid))
131            return false;
132        NTSid that = (NTSid)o;
133
134        if (sid.equals(that.sid)) {
135            return true;
136        }
137        return false;
138    }
139
140    /**
141     * Return a hash code for this {@code NTSid}.
142     *
143     * @return a hash code for this {@code NTSid}.
144     */
145    public int hashCode() {
146        return sid.hashCode();
147    }
148}
149