NTDomainPrincipal.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 the name of the Windows NT domain into which the
33 * user authenticated.  This will be a domain name if the user logged
34 * into a Windows NT domain, a workgroup name if the user logged into
35 * a workgroup, or a machine name if the user logged into a standalone
36 * configuration.
37 *
38 * <p> Principals such as this {@code NTDomainPrincipal}
39 * may be associated with a particular {@code Subject}
40 * to augment that {@code Subject} with an additional
41 * identity.  Refer to the {@code Subject} class for more information
42 * on how to achieve this.  Authorization decisions can then be based upon
43 * the Principals associated with a {@code Subject}.
44 *
45 * @see java.security.Principal
46 * @see javax.security.auth.Subject
47 */
48public class NTDomainPrincipal implements Principal, java.io.Serializable {
49
50    private static final long serialVersionUID = -4408637351440771220L;
51
52    /**
53     * @serial
54     */
55    private String name;
56
57    /**
58     * Create an {@code NTDomainPrincipal} with a Windows NT domain name.
59     *
60     * @param name the Windows NT domain name for this user.
61     *
62     * @exception NullPointerException if the {@code name}
63     *                  is {@code null}.
64     */
65    public NTDomainPrincipal(String name) {
66        if (name == null) {
67            java.text.MessageFormat form = new java.text.MessageFormat
68                (sun.security.util.ResourcesMgr.getString
69                        ("invalid.null.input.value",
70                        "sun.security.util.AuthResources"));
71            Object[] source = {"name"};
72            throw new NullPointerException(form.format(source));
73        }
74        this.name = name;
75    }
76
77    /**
78     * Return the Windows NT domain name for this
79     * {@code NTDomainPrincipal}.
80     *
81     * @return the Windows NT domain name for this
82     *                  {@code NTDomainPrincipal}
83     */
84    public String getName() {
85        return name;
86    }
87
88    /**
89     * Return a string representation of this {@code NTDomainPrincipal}.
90     *
91     * @return a string representation of this {@code NTDomainPrincipal}.
92     */
93    public String toString() {
94        java.text.MessageFormat form = new java.text.MessageFormat
95                (sun.security.util.ResourcesMgr.getString
96                        ("NTDomainPrincipal.name",
97                        "sun.security.util.AuthResources"));
98        Object[] source = {name};
99        return form.format(source);
100    }
101
102    /**
103     * Compares the specified Object with this {@code NTDomainPrincipal}
104     * for equality.  Returns true if the given object is also a
105     * {@code NTDomainPrincipal} and the two NTDomainPrincipals
106     * have the same name.
107     *
108     * @param o Object to be compared for equality with this
109     *          {@code NTDomainPrincipal}.
110     *
111     * @return true if the specified Object is equal to this
112     *          {@code NTDomainPrincipal}.
113     */
114    public boolean equals(Object o) {
115        if (o == null)
116                return false;
117
118        if (this == o)
119            return true;
120
121        if (!(o instanceof NTDomainPrincipal))
122            return false;
123        NTDomainPrincipal that = (NTDomainPrincipal)o;
124
125            if (name.equals(that.getName()))
126                return true;
127            return false;
128    }
129
130    /**
131     * Return a hash code for this {@code NTDomainPrincipal}.
132     *
133     * @return a hash code for this {@code NTDomainPrincipal}.
134     */
135    public int hashCode() {
136        return this.getName().hashCode();
137    }
138}
139