UnixPrincipal.java revision 11099:678faa7d1a6a 
1276788Sdelphij/*
2127668Sbms * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
3127668Sbms * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4127668Sbms *
5127668Sbms * This code is free software; you can redistribute it and/or modify it
6127668Sbms * under the terms of the GNU General Public License version 2 only, as
7127668Sbms * published by the Free Software Foundation.  Oracle designates this
8127668Sbms * particular file as subject to the "Classpath" exception as provided
9127668Sbms * by Oracle in the LICENSE file that accompanied this code.
10127668Sbms *
11127668Sbms * This code is distributed in the hope that it will be useful, but WITHOUT
12127668Sbms * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13127668Sbms * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14127668Sbms * version 2 for more details (a copy is included in the LICENSE file that
15127668Sbms * accompanied this code).
16190207Srpaulo *
17190207Srpaulo * You should have received a copy of the GNU General Public License version
18190207Srpaulo * 2 along with this work; if not, write to the Free Software Foundation,
19190207Srpaulo * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20190207Srpaulo *
21190207Srpaulo * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22190207Srpaulo * or visit www.oracle.com if you need additional information or have any
23190207Srpaulo * questions.
24190207Srpaulo */
25214478Srpaulo
26214478Srpaulopackage com.sun.security.auth;
27214478Srpaulo
28214478Srpauloimport java.security.Principal;
29214478Srpaulo
30214478Srpaulo/**
31214478Srpaulo * <p> This class implements the <code>Principal</code> interface
32214478Srpaulo * and represents a Unix user.
33214478Srpaulo *
34 * <p> Principals such as this <code>UnixPrincipal</code>
35 * may be associated with a particular <code>Subject</code>
36 * to augment that <code>Subject</code> with an additional
37 * identity.  Refer to the <code>Subject</code> class for more information
38 * on how to achieve this.  Authorization decisions can then be based upon
39 * the Principals associated with a <code>Subject</code>.
40 *
41 * @see java.security.Principal
42 * @see javax.security.auth.Subject
43 */
44@jdk.Exported
45public class UnixPrincipal implements Principal, java.io.Serializable {
46
47    private static final long serialVersionUID = -2951667807323493631L;
48
49    /**
50     * @serial
51     */
52    private String name;
53
54    /**
55     * Create a UnixPrincipal with a Unix username.
56     *
57     * <p>
58     *
59     * @param name the Unix username for this user.
60     *
61     * @exception NullPointerException if the <code>name</code>
62     *                  is <code>null</code>.
63     */
64    public UnixPrincipal(String name) {
65        if (name == null) {
66            java.text.MessageFormat form = new java.text.MessageFormat
67                (sun.security.util.ResourcesMgr.getString
68                        ("invalid.null.input.value",
69                        "sun.security.util.AuthResources"));
70            Object[] source = {"name"};
71            throw new NullPointerException(form.format(source));
72        }
73
74        this.name = name;
75    }
76
77    /**
78     * Return the Unix username for this <code>UnixPrincipal</code>.
79     *
80     * <p>
81     *
82     * @return the Unix username for this <code>UnixPrincipal</code>
83     */
84    public String getName() {
85        return name;
86    }
87
88    /**
89     * Return a string representation of this <code>UnixPrincipal</code>.
90     *
91     * <p>
92     *
93     * @return a string representation of this <code>UnixPrincipal</code>.
94     */
95    public String toString() {
96        java.text.MessageFormat form = new java.text.MessageFormat
97                (sun.security.util.ResourcesMgr.getString
98                        ("UnixPrincipal.name",
99                        "sun.security.util.AuthResources"));
100        Object[] source = {name};
101        return form.format(source);
102    }
103
104    /**
105     * Compares the specified Object with this <code>UnixPrincipal</code>
106     * for equality.  Returns true if the given object is also a
107     * <code>UnixPrincipal</code> and the two UnixPrincipals
108     * have the same username.
109     *
110     * <p>
111     *
112     * @param o Object to be compared for equality with this
113     *          <code>UnixPrincipal</code>.
114     *
115     * @return true if the specified Object is equal to this
116     *          <code>UnixPrincipal</code>.
117     */
118    public boolean equals(Object o) {
119        if (o == null)
120            return false;
121
122        if (this == o)
123            return true;
124
125        if (!(o instanceof UnixPrincipal))
126            return false;
127        UnixPrincipal that = (UnixPrincipal)o;
128
129        if (this.getName().equals(that.getName()))
130            return true;
131        return false;
132    }
133
134    /**
135     * Return a hash code for this <code>UnixPrincipal</code>.
136     *
137     * <p>
138     *
139     * @return a hash code for this <code>UnixPrincipal</code>.
140     */
141    public int hashCode() {
142        return name.hashCode();
143    }
144}
145