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