1 /*
 2  * Copyright (c) 2020, 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 
26 package jdk.net;
27 
28 import java.nio.file.attribute.UserPrincipal;
29 import java.nio.file.attribute.GroupPrincipal;
30 import java.util.Objects;
31 
32 /**
33  * Represents the credentials of a peer connected to a
34  * <a href="../../../java.base/java/nio/channels/package-summary.html#unixdomain">
35  * Unix domain</a> socket.
36  *
37  * @since 16
38  */
39 
40 public final class UnixDomainPrincipal {
41     private final UserPrincipal user;
42     private final GroupPrincipal group;
43 
44     /**
45      * Creates a UnixDomainPrincipal.
46      *
47      * @param user the user identity
48      *
49      * @param group the group identity
50      *
51      * @throws NullPointerException if {@code user} or {@code group} are {@code null}.
52      */
53     public UnixDomainPrincipal(UserPrincipal user, GroupPrincipal group) {
54         this.user = Objects.requireNonNull(user);
55         this.group = Objects.requireNonNull(group);
56     }
57 
58     /**
59      * Returns true if {@code obj} is a {@code UnixDomainPrincipal}
60      * and its user and group are equal to this user and group.
61      *
62      * @param obj the object to compare with
63      * @return true if this equal to obj
64      */
65     public boolean equals(Object obj) {
66         if (obj instanceof UnixDomainPrincipal) {
67             UnixDomainPrincipal that = (UnixDomainPrincipal) obj;
68             return Objects.equals(this.user, that.user)
69                     && Objects.equals(this.group, that.group);
70         }
71         return false;
72     }
73 
74     /**
75      * Returns a hashcode calculated from the user and group
76      */
77     public int hashCode() {
78         return Objects.hash(user, group);
79     }
80 
81     /**
82      * Returns this object's {@link UserPrincipal}
83      *
84      * @return this object's user
85      */
86     public UserPrincipal user() {
87         return user;
88     }
89 
90     /**
91      * Returns this object's {@link GroupPrincipal}
92      *
93      * @return this object's user
94      */
95     public GroupPrincipal group() {
96         return group;
97     }
98 }