Stay organized with collections
Save and categorize content based on your preferences.
UserPrincipal
public
interface
UserPrincipal
implements
Principal
| java.nio.file.attribute.UserPrincipal
|
Known indirect 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
Inherited methods |
|---|
From interface
java.security.Principal
abstract
boolean
|
equals(Object another)
Compares this principal to the specified object.
|
abstract
String
|
getName()
Returns the name of this principal.
|
abstract
int
|
hashCode()
Returns a hashcode for this principal.
|
default
boolean
|
implies(Subject subject)
Returns true if the specified subject is implied by this principal.
|
abstract
String
|
toString()
Returns a string representation of this principal.
|
|
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.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# UserPrincipal\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Inherited Methods](#inhmethods) \n\nUserPrincipal\n=============\n\n\n`\npublic\n\n\ninterface\nUserPrincipal\n`\n\n\n`\n\n\nimplements\n\n`[Principal](/reference/java/security/Principal)`\n\n\n`\n\n|---------------------------------------|\n| java.nio.file.attribute.UserPrincipal |\n\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Known indirect subclasses [GroupPrincipal](/reference/java/nio/file/attribute/GroupPrincipal) |---------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| | [GroupPrincipal](/reference/java/nio/file/attribute/GroupPrincipal) | A `UserPrincipal` representing a *group identity*, used to determine access rights to objects in a file system. | |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA `Principal` representing an identity used to determine access rights\nto objects in a file system.\n\nOn many platforms and file systems an entity requires appropriate access\nrights or permissions in order to access objects in a file system. The\naccess rights are generally performed by checking the identity of the entity.\nFor example, on implementations that use Access Control Lists (ACLs) to\nenforce privilege separation then a file in the file system may have an\nassociated ACL that determines the access rights of identities specified in\nthe ACL.\n\nA `UserPrincipal` object is an abstract representation of an\nidentity. It has a [name](/reference/java/security/Principal#getName()) that is typically the username or\naccount name that it represents. User principal objects may be obtained using\na [UserPrincipalLookupService](/reference/java/nio/file/attribute/UserPrincipalLookupService), or returned by [FileAttributeView](/reference/java/nio/file/attribute/FileAttributeView) implementations that provide access to identity related\nattributes. For example, the [AclFileAttributeView](/reference/java/nio/file/attribute/AclFileAttributeView) and [PosixFileAttributeView](/reference/java/nio/file/attribute/PosixFileAttributeView) provide access to a file's [owner](/reference/java/nio/file/attribute/PosixFileAttributes#owner()).\n\nSummary\n-------\n\n| ### Inherited methods |\n|-----------------------|---|\n| From interface ` `[java.security.Principal](/reference/java/security/Principal)` ` |---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract boolean` | ` `[equals](/reference/java/security/Principal#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` another) ` Compares this principal to the specified object. | | ` abstract `[String](/reference/java/lang/String) | ` `[getName](/reference/java/security/Principal#getName())`() ` Returns the name of this principal. | | ` abstract int` | ` `[hashCode](/reference/java/security/Principal#hashCode())`() ` Returns a hashcode for this principal. | | ` default boolean` | ` `[implies](/reference/java/security/Principal#implies(javax.security.auth.Subject))`(`[Subject](/reference/javax/security/auth/Subject)` subject) ` Returns true if the specified subject is implied by this principal. | | ` abstract `[String](/reference/java/lang/String) | ` `[toString](/reference/java/security/Principal#toString())`() ` Returns a string representation of this principal. | ||"]]
