org.apache.directory.shared.ldap.extras.extended
Class CancelRequest

java.lang.Object
  org.apache.directory.shared.ldap.model.message.AbstractMessage
      org.apache.directory.shared.ldap.model.message.AbstractRequest
          org.apache.directory.shared.ldap.model.message.ExtendedRequestImpl
              org.apache.directory.shared.ldap.extras.extended.CancelRequest

All Implemented Interfaces:

ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

public class CancelRequest
extends ExtendedRequestImpl

Implement the extended Cancel Request as described in RFC 3909. It's grammar is : cancelRequestValue ::= SEQUENCE { cancelID MessageID -- MessageID is as defined in [RFC2251] }

Author:

Apache Directory Project

Field Summary

static String

EXTENSION_OID The requestName for this extended request

Fields inherited from class org.apache.directory.shared.ldap.model.message.ExtendedRequestImpl

requestValue, response

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

controls

Fields inherited from interface org.apache.directory.shared.ldap.model.message.ExtendedRequest

RESP_TYPE, TYPE

Constructor Summary

CancelRequest(int messageId, int cancelId)
Creates a new instance of CancelRequest.

Method Summary

ExtendedResponse	createExtendedResponse(String id, byte[] berValue, int offset, int length)
byte[]	getRequestValue()
ResultResponse	getResultResponse()
void	setRequestValue(byte[] requestValue) Sets the extended request's requestValue portion of the PDU.

Methods inherited from class org.apache.directory.shared.ldap.model.message.ExtendedRequestImpl

equals, getRequestName, getResponseType, hashCode, setRequestName, toString

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

hasResponse

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

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

Methods inherited from class java.lang.Object

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

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

hasResponse

Methods inherited from interface org.apache.directory.shared.ldap.model.message.Message

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

Field Detail

EXTENSION_OID

public static final String EXTENSION_OID

The requestName for this extended request

See Also:

Constant Field Values

Constructor Detail

CancelRequest

public CancelRequest(int messageId,
                     int cancelId)

Creates a new instance of CancelRequest.

Parameters:

messageId - the message id

cancelId - the message id of the request to cancel

Method Detail

setRequestValue

public void setRequestValue(byte[] requestValue)

Sets the extended request's requestValue portion of the PDU.

Specified by:

setRequestValue in interface ExtendedRequest

Overrides:

setRequestValue in class ExtendedRequestImpl

Parameters:

payload - byte array of data encapsulating ext. req. parameters

createExtendedResponse

public ExtendedResponse createExtendedResponse(String id,
                                               byte[] berValue,
                                               int offset,
                                               int length)
                                        throws NamingException

Overrides:

createExtendedResponse in class ExtendedRequestImpl

Throws:

NamingException

getRequestValue

public byte[] getRequestValue()

Specified by:

getRequestValue in interface ExtendedRequest

Overrides:

getRequestValue in class ExtendedRequestImpl

getResultResponse

public ResultResponse getResultResponse()

Specified by:

getResultResponse in interface ResultResponseRequest

Overrides:

getResultResponse in class ExtendedRequestImpl