public abstract class UserPrincipalLookupService extends Object
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.FileSystem.getUserPrincipalLookupService()| Modifier | Constructor and Description |
|---|---|
protected |
UserPrincipalLookupService()
Initializes a new instance of this class.
|
| Modifier and Type | Method and Description |
|---|---|
abstract GroupPrincipal |
lookupPrincipalByGroupName(String group)
Lookup a group principal by group name.
|
abstract UserPrincipal |
lookupPrincipalByName(String name)
Lookup a user principal by name.
|
protected UserPrincipalLookupService()
public abstract UserPrincipal lookupPrincipalByName(String name) throws IOException
name - the string representation of the user principal to lookupUserPrincipalNotFoundException - 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 checks RuntimePermission("lookupUserInformation")public abstract GroupPrincipal lookupPrincipalByGroupName(String group) throws IOException
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.
group - the string representation of the group to lookupUserPrincipalNotFoundException - 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 checks RuntimePermission("lookupUserInformation") Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138