org.apache.directory.shared.ldap.message
Class AbstractAbandonableRequest

java.lang.Object
  extended by org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage
      extended by org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest
          extended by org.apache.directory.shared.ldap.message.AbstractAbandonableRequest
All Implemented Interfaces:
InternalAbandonableRequest, InternalMessage, InternalRequest
Direct Known Subclasses:
AddRequestImpl, BindRequestImpl, CompareRequestImpl, DeleteRequestImpl, ModifyDnRequestImpl, ModifyRequestImpl, SearchRequestImpl

public class AbstractAbandonableRequest
extends InternalAbstractRequest
implements InternalAbandonableRequest

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

Version:
$Rev: 910150 $
Author:
Apache Directory Project

Constructor Summary
protected AbstractAbandonableRequest(int id, MessageTypeEnum type)
          Subclasses must provide these parameters via a super constructor call.
 
Method Summary
 void abandon()
          Abandons this request.
 void 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.shared.ldap.message.internal.InternalAbstractRequest
hashCode, hasResponse
 
Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage
add, addAll, equals, get, getControls, getMessageId, getType, hasControl, put, remove
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalRequest
hasResponse
 
Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalMessage
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove
 

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()
Description copied from interface: InternalAbandonableRequest
Abandons this request.

Specified by:
abandon in interface InternalAbandonableRequest

isAbandoned

public boolean isAbandoned()
Description copied from interface: InternalAbandonableRequest
Checks to see if this request has been abandoned.

Specified by:
isAbandoned in interface InternalAbandonableRequest
Returns:
true if the request has been abandoned.

addAbandonListener

public void addAbandonListener(AbandonListener listener)
Description copied from interface: InternalAbandonableRequest
Adds listener to be notified if this request gets abandoned.

Specified by:
addAbandonListener in interface InternalAbandonableRequest
Parameters:
listener - to be notified if this request gets abandoned.


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.