ResponseDecorator (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.ResponseDecorator<M>

Type Parameters:

M - The response to be decorated

All Implemented Interfaces:

Asn1Object, Decorator<M>, Message, Response, ResultResponse

Direct Known Subclasses:

AddResponseDecorator, BindResponseDecorator, CompareResponseDecorator, DeleteResponseDecorator, ExtendedResponseDecorator, IntermediateResponseDecorator, ModifyDnResponseDecorator, ModifyResponseDecorator, SearchResultDoneDecorator
```
public abstract class ResponseDecorator<M extends ResultResponse>
extends MessageDecorator<M>
implements ResultResponse
```
A decorator for the Response message. It will store the LdapResult.

Author:

Apache Directory Project

Constructor Summary

Constructors
Constructor Description

ResponseDecorator(LdapApiService codec, M decoratedMessage)
Makes a AddRequest encodable.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LdapResult`	`getLdapResult()`	Gets the LdapResult components of this Response.
`void`	`setLdapResult(LdapResultDecorator ldapResultDecorator)`

Methods inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator
addAllControls, addControl, get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, removeControl, setControlsLength, setMessageId, 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.asn1.Asn1Object
computeLength, encode

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

- Constructor Detail
  - ResponseDecorator
```
public ResponseDecorator(LdapApiService codec,
                         M decoratedMessage)
```
    Makes a AddRequest encodable.
    
    Parameters:
    
    codec - The LDAP service instance
    
    decoratedMessage - the decorated AddRequest
- Method Detail
  - getLdapResult
```
public LdapResult getLdapResult()
```
    Description copied from interface: ResultResponse
    
    Gets the LdapResult components of this Response.
    
    Specified by:
    
    getLdapResult in interface ResultResponse
    
    Returns:
    
    the ldapResultDecorator
  - setLdapResult
```
public void setLdapResult(LdapResultDecorator ldapResultDecorator)
```
    Parameters:
    
    ldapResultDecorator - the ldapResultDecorator to set