WhoAmIRequestDecorator (Apache LDAP API 2.0.0.AM2 API Documentation)

java.lang.Object
- org.apache.directory.api.ldap.codec.api.MessageDecorator<M>
- - org.apache.directory.api.ldap.codec.decorators.RequestDecorator<M>
  - - org.apache.directory.api.ldap.codec.decorators.ResultResponseRequestDecorator<M>
    - - org.apache.directory.api.ldap.codec.decorators.SingleReplyRequestDecorator<Q>
      - org.apache.directory.api.ldap.codec.decorators.ExtendedRequestDecorator<WhoAmIRequest>
        
        org.apache.directory.api.ldap.extras.extended.ads_impl.whoAmI.WhoAmIRequestDecorator

All Implemented Interfaces:

Asn1Object, Decorator<WhoAmIRequest>, WhoAmIRequest, AbandonableRequest, ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest
```
public class WhoAmIRequestDecorator
extends ExtendedRequestDecorator<WhoAmIRequest>
implements WhoAmIRequest
```
A Decorator for WhoAmIRequest extended request.

Author:

Apache Directory Project

Field Summary
- Fields inherited from interface org.apache.directory.api.ldap.extras.extended.whoAmI.WhoAmIRequest
  EXTENSION_OID

Constructor Summary

Constructors
Constructor Description

WhoAmIRequestDecorator(LdapApiService codec, WhoAmIRequest decoratedMessage)
Create a new decorator instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`WhoAmIResponse`	`getResultResponse()`	If called for the first time, this method creates a result containing response object for this request.

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.ExtendedRequestDecorator
addAllControls, addControl, computeLength, encode, getRequestName, getRequestValue, removeControl, setMessageId, setRequestName, setRequestValue

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.SingleReplyRequestDecorator
abandon, addAbandonListener, getResponseType, isAbandoned

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.ResultResponseRequestDecorator
hasResponse

Methods inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator
get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, setControlsLength, setMessageLength, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.api.ldap.model.message.ExtendedRequest
addAllControls, addControl, getRequestName, removeControl, setMessageId, setRequestName

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

Methods inherited from interface org.apache.directory.api.ldap.model.message.Request
hasResponse

Methods inherited from interface org.apache.directory.api.ldap.model.message.SingleReplyRequest
getResponseType

- Constructor Detail
  - WhoAmIRequestDecorator
```
public WhoAmIRequestDecorator(LdapApiService codec,
                              WhoAmIRequest decoratedMessage)
```
    Create a new decorator instance
    
    Parameters:
    
    codec - The codec service
    
    decoratedMessage - The decorated WhoAmIRequest
- Method Detail
  - getResultResponse
```
public WhoAmIResponse getResultResponse()
```
    If called for the first time, this method creates a result containing response object for this request.
    
    Specified by:
    
    getResultResponse in interface ResultResponseRequest
    
    Overrides:
    
    getResultResponse in class ResultResponseRequestDecorator<WhoAmIRequest>
    
    Returns:
    
    a result containing response with defaults and the messageId set in response to this specific request