Package org.apache.directory.api.ldap.model.message

Class AbstractAbandonableRequest

java.lang.Object

org.apache.directory.api.ldap.model.message.AbstractMessage

org.apache.directory.api.ldap.model.message.AbstractRequest

org.apache.directory.api.ldap.model.message.AbstractAbandonableRequest

All Implemented Interfaces:

AbandonableRequest, Message, Request

Direct Known Subclasses:

AddRequestImpl, BindRequestImpl, CompareRequestImpl, DeleteRequestImpl, ModifyDnRequestImpl, ModifyRequestImpl, SearchRequestImpl

public abstract class AbstractAbandonableRequest
extends AbstractRequest
implements AbandonableRequest

The base abandonable request message class. All such requests have a response type.

Author:

Apache Directory Project

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	AbstractAbandonableRequest.RequestObservable

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static long	serialVersionUID

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAbandonableRequest(int id, MessageTypeEnum type)	Subclasses must provide these parameters via a super constructor call.

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.
boolean	isAbandoned()	Checks to see if this request has been abandoned.

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractRequest

equals, hashCode, hasResponse

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

AbstractAbandonableRequest

protected AbstractAbandonableRequest(int id,
                                     MessageTypeEnum type)

Subclasses must provide these parameters via a super constructor call.

Parameters:

id - the sequential message identifier

type - the request type enum

Method Detail

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