org.apache.directory.shared.ldap.message.extended

Class CancelRequest

java.lang.Object

org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest

org.apache.directory.shared.ldap.message.ExtendedRequestImpl

org.apache.directory.shared.ldap.message.extended.CancelRequest

All Implemented Interfaces:

Serializable, ExtendedRequest, InternalExtendedRequest, InternalMessage, InternalRequest, InternalResultResponseRequest, 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] }

Version:

$Rev$, $Date$

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_OID The requestName for this extended request

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

payload, response

Fields inherited from interface org.apache.directory.shared.ldap.message.internal.InternalExtendedRequest

RESP_TYPE, TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ExtendedResponse	createExtendedResponse(String id, byte[] berValue, int offset, int length)
byte[]	getEncodedValue()
byte[]	getPayload() Gets the extended request's requestValue portion of the PDU.
InternalResultResponse	getResultResponse() The result containing response for this request.
void	setPayload(byte[] payload) Sets the extended request's requestValue portion of the PDU.

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

equals, getID, getOid, getResponseType, setOid, toString

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, get, getControls, getMessageId, getType, hasControl, put, remove

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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

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

getPayload

public byte[] getPayload()

Gets the extended request's requestValue portion of the PDU. The form of the data is request specific and is determined by the extended request OID.

Specified by:

getPayload in interface InternalExtendedRequest

Overrides:

getPayload in class ExtendedRequestImpl

Returns:

byte array of data

setPayload

public void setPayload(byte[] payload)

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

Specified by:

setPayload in interface InternalExtendedRequest

Overrides:

setPayload 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

Specified by:

createExtendedResponse in interface ExtendedRequest

Overrides:

createExtendedResponse in class ExtendedRequestImpl

Throws:

NamingException

getEncodedValue

public byte[] getEncodedValue()

Specified by:

getEncodedValue in interface ExtendedRequest

Overrides:

getEncodedValue in class ExtendedRequestImpl

getResultResponse

public InternalResultResponse getResultResponse()

Description copied from class: ExtendedRequestImpl

The result containing response for this request.

Specified by:

getResultResponse in interface InternalResultResponseRequest

Overrides:

getResultResponse in class ExtendedRequestImpl

Returns:

the result containing response for this request