UserPrincipalLookupService (xmldb-api unspecified)

All Superinterfaces:

Configurable, Service
```
public interface UserPrincipalLookupService
extends Service
```
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 the XMLDB. 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:

2.0

See Also:

ServiceProvider.getService(java.lang.Class<S>)

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String SERVICE_NAME

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`GroupPrincipal`	`lookupPrincipalByGroupName(java.lang.String group)`	Lookup a group principal by group name.
`UserPrincipal`	`lookupPrincipalByName(java.lang.String name)`	Lookup a user principal by name.

Methods inherited from interface org.xmldb.api.base.Configurable
getProperty, getProperty, setProperty

Methods inherited from interface org.xmldb.api.base.Service
getName, getVersion, setCollection

- Field Detail
  - SERVICE_NAME
```
static final java.lang.String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - lookupPrincipalByName
```
UserPrincipal lookupPrincipalByName(java.lang.String name)
                             throws XMLDBException
```
    Lookup a user principal by name.
    
    Parameters:
    
    name - the string representation of the user principal to lookup
    
    Returns:
    
    a user principal
    
    Throws:
    
    XMLDBException - the principal does not exist
  - lookupPrincipalByGroupName
```
GroupPrincipal lookupPrincipalByGroupName(java.lang.String group)
                                   throws XMLDBException
```
    Lookup a group principal by group name.
    Where an implementation does not support any notion of group then this method always throws XMLDBException. 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:
    
    XMLDBException - the principal does not exist or is not a group