Class UserPrincipalLookupService

java.lang.Object

java.nio.file.attribute.UserPrincipalLookupService

public abstract class UserPrincipalLookupService extends Object

An object to lookup user and group principals by name. A UserPrincipal represents an identity that may be used to determine access rights to objects in a file system. A GroupPrincipal represents a group identity. A UserPrincipalLookupService defines methods to lookup identities by name or group name (which are typically user or account names). Whether names and group names are case sensitive or not depends on the implementation. The exact definition of a group is implementation specific but typically a group represents an identity created for administrative purposes so as to determine the access rights for the members of the group. In particular it is implementation specific if the namespace for names and groups is the same or is distinct. To ensure consistent and correct behavior across platforms it is recommended that this API be used as if the namespaces are distinct. In other words, the lookupPrincipalByName should be used to lookup users, and lookupPrincipalByGroupName should be used to lookup groups.

Since:

1.7

See Also:

Constructor Summary

UserPrincipalLookupService()

Modifier	Constructor	Description
`protected`	Initializes a new instance of this class.

Method Summary

Modifier and Type	Method	Description
`abstract GroupPrincipal`	`lookupPrincipalByGroupName(String group)`	Lookup a group principal by group name.
`abstract UserPrincipal`	`lookupPrincipalByName(String name)`	Lookup a user principal by name.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

UserPrincipalLookupService

protected UserPrincipalLookupService()

Initializes a new instance of this class.

Method Details

lookupPrincipalByName

public abstract UserPrincipal lookupPrincipalByName(String name) throws IOException

Lookup a user principal by name.

Parameters:: name - the string representation of the user principal to lookup
Returns:: a user principal
Throws:: UserPrincipalNotFoundException - the principal does not exist; IOException - if an I/O error occurs

lookupPrincipalByGroupName

public abstract GroupPrincipal lookupPrincipalByGroupName(String group) throws IOException

Lookup a group principal by group name.

Where an implementation does not support any notion of group then this method always throws UserPrincipalNotFoundException. Where the namespace for user accounts and groups is the same, then this method is identical to invoking lookupPrincipalByName.

Parameters:: group - the string representation of the group to lookup
Returns:: a group principal
Throws:: UserPrincipalNotFoundException - the principal does not exist or is not a group; IOException - if an I/O error occurs

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.