WhoAmIResponse (Apache LDAP API 2.1.1 API Documentation)

All Superinterfaces:

ExtendedResponse, Message, Response, ResultResponse

All Known Implementing Classes:

WhoAmIResponseImpl
```
public interface WhoAmIResponse
extends ExtendedResponse
```
The RFC 4532 WhoAmI response :
```
 authzid ::= OCTET STRING OPTIONAL
 
```
Author:

Apache Directory Project

Field Summary

Fields
Modifier and Type Field Description

static String EXTENSION_OID
The OID for the WhoAmI extended operation response.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`byte[]`	`getAuthzId()`	Get the authzid as a byte[]
`String`	`getAuthzIdString()`	Get the authzid as String.
`Dn`	`getDn()`	Get the DN authzid.
`String`	`getUserId()`	Get the UserId
`boolean`	`isDnAuthzId()`
`boolean`	`isUserAuthzId()`

Methods inherited from interface org.apache.directory.api.ldap.model.message.ExtendedResponse
getResponseName, setResponseName

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponse
getLdapResult

- Field Detail
  - EXTENSION_OID
```
static final String EXTENSION_OID
```
    The OID for the WhoAmI extended operation response.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isDnAuthzId
```
boolean isDnAuthzId()
```
    Returns:
    
    true if the response contains a DN authz (dn:XXX)
  - isUserAuthzId
```
boolean isUserAuthzId()
```
    Returns:
    
    true if the response contains a userID authz (u:XXX)
  - getAuthzId
```
byte[] getAuthzId()
```
    Get the authzid as a byte[]
    
    Returns:
    
    The authzid or null
  - getAuthzIdString
```
String getAuthzIdString()
```
    Get the authzid as String. We will strip out the 'dn:' or 'u:' part.
    
    Returns:
    
    The authzid or null
  - getUserId
```
String getUserId()
```
    Get the UserId
    
    Returns:
    
    The userId or null
  - getDn
```
Dn getDn()
```
    Get the DN authzid.
    
    Returns:
    
    The DN or null