Package org.apache.directory.api.ldap.codec.decorators

Class AbandonableResultResponseRequestDecorator<M extends AbandonableResultResponseRequest>

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.AbandonableRequestDecorator<M>

org.apache.directory.api.ldap.codec.decorators.AbandonableResultResponseRequestDecorator<M>

Type Parameters:

M - The message response to decorate

All Implemented Interfaces:

Asn1Object, Decorator<M>, AbandonableRequest, Message, Request, ResultResponseRequest

public abstract class AbandonableResultResponseRequestDecorator<M extends AbandonableResultResponseRequest>
extends AbandonableRequestDecorator<M>
implements ResultResponseRequest

A decorator for the LdapResultResponse message

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
AbandonableResultResponseRequestDecorator(LdapApiService codec, M decoratedMessage)	Makes Request a MessageDecorator.

Method Summary

Modifier and Type	Method	Description
ResultResponse	getResultResponse()	If called for the first time, this method creates a result containing response object for this request.
boolean	hasResponse()	Tests to see if this Request produces one or more response types.

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

abandon, addAbandonListener, getAbandonableRequest, isAbandoned

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

AbandonableResultResponseRequestDecorator

public AbandonableResultResponseRequestDecorator(LdapApiService codec,
                                                 M decoratedMessage)

Makes Request a MessageDecorator.

Parameters:

codec - The LDAP service instance

decoratedMessage - the decorated message

Method Detail

hasResponse

public boolean hasResponse()

Tests to see if this Request produces one or more response types.

Specified by:

hasResponse in interface Request

Overrides:

hasResponse in class ResultResponseRequestDecorator<M extends AbandonableResultResponseRequest>

Returns:

true if a response can be expected, false otherwise.

getResultResponse

public ResultResponse 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<M extends AbandonableResultResponseRequest>

Returns:

a result containing response with defaults and the messageId set in response to this specific request