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

Class SingleReplyRequestDecorator<M extends SingleReplyRequest>

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

Type Parameters:

M - The request to be decorated

All Implemented Interfaces:

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

Direct Known Subclasses:

AddRequestDecorator, BindRequestDecorator, CompareRequestDecorator, DeleteRequestDecorator, ExtendedRequestDecorator, ModifyDnRequestDecorator, ModifyRequestDecorator

public abstract class SingleReplyRequestDecorator<M extends SingleReplyRequest>
extends ResultResponseRequestDecorator<M>
implements SingleReplyRequest, AbandonableRequest

A decorator for the LdapResultResponse message

Author:

Apache Directory Project

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	abandon()	Abandons this request.
AbandonableRequest	addAbandonListener(AbandonListener listener)	Adds listener to be notified if this request gets abandoned.
MessageTypeEnum	getResponseType()	Gets the protocol response message type for this request which produces at least one response.
boolean	isAbandoned()	Checks to see if this request has been abandoned.

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

getResultResponse, hasResponse

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

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

hasResponse

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

getResultResponse

Constructor Detail

SingleReplyRequestDecorator

public SingleReplyRequestDecorator(LdapApiService codec,
                                   M decoratedMessage)

Makes Request a MessageDecorator.

Parameters:

codec - The LDAP service instance

decoratedMessage - the decorated message

Method Detail

getResponseType

public MessageTypeEnum getResponseType()

Gets the protocol response message type for this request which produces at least one response.

Specified by:

getResponseType in interface SingleReplyRequest

Returns:

the message type of the response.

abandon

public void abandon()

Abandons this request.

Specified by:

abandon in interface AbandonableRequest

isAbandoned

public boolean isAbandoned()

Checks to see if this request has been abandoned.

Specified by:

isAbandoned in interface AbandonableRequest

Returns:

true if the request has been abandoned.

addAbandonListener

public AbandonableRequest addAbandonListener(AbandonListener listener)

Adds listener to be notified if this request gets abandoned.

Specified by:

addAbandonListener in interface AbandonableRequest

Parameters:

listener - to be notified if this request gets abandoned.

Returns:

An AbandonableRequest reference