Class CancelRequestImpl
- 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.AbstractExtendedRequest
-
- org.apache.directory.api.ldap.model.message.OpaqueExtendedRequest
-
- org.apache.directory.api.ldap.extras.extended.cancel.CancelRequestImpl
-
- All Implemented Interfaces:
CancelRequest
,ExtendedRequest
,Message
,Request
,ResultResponseRequest
,SingleReplyRequest
public class CancelRequestImpl extends OpaqueExtendedRequest implements CancelRequest
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
-
Fields inherited from interface org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest
EXTENSION_OID
-
-
Constructor Summary
Constructors Constructor Description CancelRequestImpl()
Creates a new instance of CancelRequest.CancelRequestImpl(int messageId, int cancelId)
Creates a new instance of CancelRequest.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getCancelId()
CancelResponse
getResultResponse()
The result containing response for this request.void
setCancelId(int cancelId)
Sets the message to cancel by id.-
Methods inherited from class org.apache.directory.api.ldap.model.message.OpaqueExtendedRequest
addAllControls, addControl, equals, getExtendedResponse, getRequestName, getRequestValue, getResponseType, hashCode, removeControl, setMessageId, setRequestName, setRequestValue, toString
-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractExtendedRequest
getResponse, setResponse
-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractRequest
hasResponse
-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage
get, getControl, getControls, getMessageId, getType, hasControl, put, toString
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.ExtendedRequest
addAllControls, addControl, getRequestName, removeControl, setMessageId, setRequestName
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
get, getControl, getControls, getMessageId, getType, hasControl, put
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Request
hasResponse
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.SingleReplyRequest
getResponseType
-
-
-
-
Constructor Detail
-
CancelRequestImpl
public CancelRequestImpl(int messageId, int cancelId)
Creates a new instance of CancelRequest.- Parameters:
messageId
- the message idcancelId
- the message id of the request to cancel
-
CancelRequestImpl
public CancelRequestImpl()
Creates a new instance of CancelRequest.
-
-
Method Detail
-
getCancelId
public int getCancelId()
- Specified by:
getCancelId
in interfaceCancelRequest
- Returns:
- The id of the Message to cancel.
-
setCancelId
public void setCancelId(int cancelId)
Sets the message to cancel by id.- Specified by:
setCancelId
in interfaceCancelRequest
- Parameters:
cancelId
- The id of the message to cancel.
-
getResultResponse
public CancelResponse getResultResponse()
The result containing response for this request.- Specified by:
getResultResponse
in interfaceResultResponseRequest
- Overrides:
getResultResponse
in classOpaqueExtendedRequest
- Returns:
- the result containing response for this request
-
-