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

Class AbandonableRequestDecorator<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>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbandonableResultResponseRequestDecorator

public abstract class AbandonableRequestDecorator<M extends AbandonableResultResponseRequest>
extends ResultResponseRequestDecorator<M>
implements AbandonableRequest

A decorator for the LdapResultResponse message

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

messageLength

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	abandon() Abandons this request.
AbandonableRequest	addAbandonListener(AbandonListener listener) Adds listener to be notified if this request gets abandoned.
AbandonableRequest	getAbandonableRequest() Gets the decorated AbandonableRequest.
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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

hasResponse

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.codec.api.Decorator

computeLength, encode

Methods inherited from interface org.apache.directory.api.asn1.Asn1Object

computeLength, encode

Constructor Detail

AbandonableRequestDecorator

public AbandonableRequestDecorator(LdapApiService codec,
                           M decoratedMessage)

Makes Request a MessageDecorator.

Parameters:

decoratedMessage - the decorated message

Method Detail

getAbandonableRequest

public AbandonableRequest getAbandonableRequest()

Gets the decorated AbandonableRequest.

Returns:

The decorated AbandonableRequest

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