- java.lang.Object
-
- java.nio.file.attribute.UserPrincipalLookupService
-
public abstract class UserPrincipalLookupService extends Object
An object to lookup user and group principals by name. AUserPrincipalrepresents an identity that may be used to determine access rights to objects in a file system. AGroupPrincipalrepresents a group identity. AUserPrincipalLookupServicedefines 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, thelookupPrincipalByNameshould be used to lookup users, andlookupPrincipalByGroupNameshould be used to lookup groups.- Since:
- 1.7
- See Also:
FileSystem.getUserPrincipalLookupService()
-
-
Constructor Summary
Constructors Modifier Constructor and Description protectedUserPrincipalLookupService()Initializes a new instance of this class.
-
Method Summary
Methods Modifier and Type Method and Description abstract GroupPrincipallookupPrincipalByGroupName(String group)Lookup a group principal by group name.abstract UserPrincipallookupPrincipalByName(String name)Lookup a user principal by name.
-
-
-
Constructor Detail
-
UserPrincipalLookupService
protected UserPrincipalLookupService()
Initializes a new instance of this class.
-
-
Method Detail
-
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 existIOException- if an I/O error occursSecurityException- In the case of the default provider, and a security manager is installed, it checksRuntimePermission("lookupUserInformation")
-
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 invokinglookupPrincipalByName.- 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 groupIOException- if an I/O error occursSecurityException- In the case of the default provider, and a security manager is installed, it checksRuntimePermission("lookupUserInformation")
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/nio/file/attribute/userprincipallookupservice.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
