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
28/**
29 * This class extends {@code NTSid}
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}
37 * may be associated with a particular {@code Subject}
38 * to augment that {@code Subject} with an additional
39 * identity.  Refer to the {@code Subject} 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}.
42 *
43 * @see java.security.Principal
44 * @see javax.security.auth.Subject
45 */
46public class NTSidDomainPrincipal extends NTSid {
47
48    private static final long serialVersionUID = 5247810785821650912L;
49
50    /**
51     * Create an {@code NTSidDomainPrincipal} with a Windows NT SID.
52     *
53     * @param name a string version of the Windows NT SID for this
54     *                  user's domain.
55     *
56     * @exception NullPointerException if the {@code name}
57     *                  is {@code null}.
58     */
59    public NTSidDomainPrincipal(String name) {
60        super(name);
61    }
62
63    /**
64     * Return a string representation of this {@code NTSidDomainPrincipal}.
65     *
66     * @return a string representation of this
67     *          {@code NTSidDomainPrincipal}.
68     */
69    public String toString() {
70        java.text.MessageFormat form = new java.text.MessageFormat
71                (sun.security.util.ResourcesMgr.getAuthResourceString
72                        ("NTSidDomainPrincipal.name"));
73        Object[] source = {getName()};
74        return form.format(source);
75    }
76
77    /**
78     * Compares the specified Object with this {@code NTSidDomainPrincipal}
79     * for equality.  Returns true if the given object is also a
80     * {@code NTSidDomainPrincipal} and the two NTSidDomainPrincipals
81     * have the same SID.
82     *
83     * @param o Object to be compared for equality with this
84     *          {@code NTSidDomainPrincipal}.
85     *
86     * @return true if the specified Object is equal to this
87     *          {@code NTSidDomainPrincipal}.
88     */
89    public boolean equals(Object o) {
90            if (o == null)
91                return false;
92
93        if (this == o)
94            return true;
95
96        if (!(o instanceof NTSidDomainPrincipal))
97            return false;
98
99        return super.equals(o);
100    }
101}
102