1 /*
2  * Copyright (c) 2007, 2009, 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 java.nio.file.attribute;
27 
28 import java.security.Principal;
29 
30 /**
31  * A {@code Principal} representing an identity used to determine access rights
32  * to objects in a file system.
33  *
34  * <p> On many platforms and file systems an entity requires appropriate access
35  * rights or permissions in order to access objects in a file system. The
36  * access rights are generally performed by checking the identity of the entity.
37  * For example, on implementations that use Access Control Lists (ACLs) to
38  * enforce privilege separation then a file in the file system may have an
39  * associated ACL that determines the access rights of identities specified in
40  * the ACL.
41  *
42  * <p> A {@code UserPrincipal} object is an abstract representation of an
43  * identity. It has a {@link #getName() name} that is typically the username or
44  * account name that it represents. User principal objects may be obtained using
45  * a {@link UserPrincipalLookupService}, or returned by {@link
46  * FileAttributeView} implementations that provide access to identity related
47  * attributes. For example, the {@link AclFileAttributeView} and {@link
48  * PosixFileAttributeView} provide access to a file's {@link
49  * PosixFileAttributes#owner owner}.
50  *
51  * @since 1.7
52  */
53 
54 public interface UserPrincipal extends Principal { }
55