Stay organized with collections
Save and categorize content based on your preferences.
UserPrincipal
interface UserPrincipal : Principal
Known Direct Subclasses
| GroupPrincipal |
A UserPrincipal representing a group identity, used to determine access rights to objects in a file system.
|
|
A Principal representing an identity used to determine access rights to objects in a file system.
On many platforms and file systems an entity requires appropriate access rights or permissions in order to access objects in a file system. The access rights are generally performed by checking the identity of the entity. For example, on implementations that use Access Control Lists (ACLs) to enforce privilege separation then a file in the file system may have an associated ACL that determines the access rights of identities specified in the ACL.
A UserPrincipal object is an abstract representation of an identity. It has a name that is typically the username or account name that it represents. User principal objects may be obtained using a UserPrincipalLookupService, or returned by FileAttributeView implementations that provide access to identity related attributes. For example, the AclFileAttributeView and PosixFileAttributeView provide access to a file's owner.
Summary
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# UserPrincipal\n\nAdded in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nUserPrincipal\n=============\n\n```\ninterface UserPrincipal : Principal\n```\n\n|--------------------------------------------|\n| [java.nio.file.attribute.UserPrincipal](#) |\n\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Known Direct Subclasses [GroupPrincipal](/reference/kotlin/java/nio/file/attribute/GroupPrincipal) |----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| | [GroupPrincipal](/reference/kotlin/java/nio/file/attribute/GroupPrincipal) | A `UserPrincipal` representing a *group identity*, used to determine access rights to objects in a file system. | |\n\nA `Principal` representing an identity used to determine access rights to objects in a file system.\n\nOn many platforms and file systems an entity requires appropriate access rights or permissions in order to access objects in a file system. The access rights are generally performed by checking the identity of the entity. For example, on implementations that use Access Control Lists (ACLs) to enforce privilege separation then a file in the file system may have an associated ACL that determines the access rights of identities specified in the ACL.\n\nA `UserPrincipal` object is an abstract representation of an identity. It has a [name](../../../security/Principal.html#getName()) that is typically the username or account name that it represents. User principal objects may be obtained using a [UserPrincipalLookupService](/reference/kotlin/java/nio/file/attribute/UserPrincipalLookupService), or returned by [FileAttributeView](/reference/kotlin/java/nio/file/attribute/FileAttributeView) implementations that provide access to identity related attributes. For example, the [AclFileAttributeView](/reference/kotlin/java/nio/file/attribute/AclFileAttributeView) and [PosixFileAttributeView](/reference/kotlin/java/nio/file/attribute/PosixFileAttributeView) provide access to a file's [owner](/reference/kotlin/java/nio/file/attribute/PosixFileAttributes#owner()).\n\nSummary\n-------\n\n| Inherited functions ||\n|---|---|\n| From class [Principal](../../../security/Principal.html#) |------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getName](../../../security/Principal.html#getName())`()` Returns the name of this principal. \u003cbr /\u003e | | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [implies](../../../security/Principal.html#implies(javax.security.auth.Subject))`(`subject:` `[Subject](../../../../javax/security/auth/Subject.html#)!`)` Returns true if the specified subject is implied by this principal. \u003cbr /\u003e | ||"]]
