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:
- java.io.Serializable, javax.naming.ldap.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 |
static java.lang.String |
EXTENSION_OID
The requestName for this extended request |
Constructor Summary |
CancelRequest(int messageId,
int cancelId)
Creates a new instance of CancelRequest. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
EXTENSION_OID
public static final java.lang.String EXTENSION_OID
- The requestName for this extended request
- See Also:
- Constant Field Values
CancelRequest
public CancelRequest(int messageId,
int cancelId)
- Creates a new instance of CancelRequest.
- Parameters:
messageId
- the message idcancelId
- the message id of the request to cancel
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 javax.naming.ldap.ExtendedResponse createExtendedResponse(java.lang.String id,
byte[] berValue,
int offset,
int length)
throws javax.naming.NamingException
- Specified by:
createExtendedResponse
in interface javax.naming.ldap.ExtendedRequest
- Overrides:
createExtendedResponse
in class ExtendedRequestImpl
- Throws:
javax.naming.NamingException
getEncodedValue
public byte[] getEncodedValue()
- Specified by:
getEncodedValue
in interface javax.naming.ldap.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
Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.