APIdia Launch Partner
Top Description Constructors Methods
java.nio.file.attribute

public abstract Class UserPrincipalLookupService

extends Object
Class Inheritance
Imports
java.io.IOException

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
java.nio.file.FileSystem#getUserPrincipalLookupService

Constructor Summary

AccessConstructor and Description
protected
UserPrincipalLookupService()

Initializes a new instance of this class.

Method Summary

Modifier and TypeMethod and Description
public abstract GroupPrincipal

Returns:

a group principal
lookupPrincipalByGroupName
(String
the string representation of the group to lookup
group
)

Lookup a group principal by group name.

public abstract UserPrincipal

Returns:

a user principal
lookupPrincipalByName
(String
the string representation of the user principal to lookup
name
)

Lookup a user principal by name.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

UserPrincipalLookupServiceback to summary
protected UserPrincipalLookupService()

Initializes a new instance of this class.

Method Detail

lookupPrincipalByGroupNameback to summary
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:String

the string representation of the group to lookup

Returns:GroupPrincipal

a group principal

Exceptions
IOException:
if an I/O error occurs
UserPrincipalNotFoundException:
the principal does not exist or is not a group
lookupPrincipalByNameback to summary
public abstract UserPrincipal lookupPrincipalByName(String name) throws IOException

Lookup a user principal by name.

Parameters
name:String

the string representation of the user principal to lookup

Returns:UserPrincipal

a user principal

Exceptions
IOException:
if an I/O error occurs
UserPrincipalNotFoundException:
the principal does not exist