org.apache.directory.api.ldap.extras.extended
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<CancelResponse>
              org.apache.directory.api.ldap.extras.extended.CancelRequestImpl

All Implemented Interfaces:

CancelRequest, org.apache.directory.api.ldap.model.message.ExtendedRequest<CancelResponse>, org.apache.directory.api.ldap.model.message.Message, org.apache.directory.api.ldap.model.message.Request, org.apache.directory.api.ldap.model.message.ResultResponseRequest<CancelResponse>, org.apache.directory.api.ldap.model.message.SingleReplyRequest<CancelResponse>

public class CancelRequestImpl
extends org.apache.directory.api.ldap.model.message.AbstractExtendedRequest<CancelResponse>
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 class org.apache.directory.api.ldap.model.message.AbstractExtendedRequest

response

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

controls

Fields inherited from interface org.apache.directory.api.ldap.extras.extended.CancelRequest

EXTENSION_OID

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

RESP_TYPE, TYPE

Constructor Summary

CancelRequestImpl()
Creates a new instance of CancelRequest.

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

Method Summary

int	getCancelId()
CancelResponse	getResultResponse()
void	setCancelId(int cancelId) Sets the message to cancel by id.

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractExtendedRequest

addAllControls, addControl, equals, getRequestName, getResponseType, hashCode, removeControl, setMessageId, setRequestName, toString

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 class java.lang.Object

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

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.SingleReplyRequest

getResponseType

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

hasResponse

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

get, getControl, getControls, getMessageId, getType, hasControl, put

Constructor Detail

CancelRequestImpl

public CancelRequestImpl(int messageId,
                         int cancelId)

Creates a new instance of CancelRequest.

Parameters:

messageId - the message id

cancelId - 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 interface CancelRequest

Returns:

The id of the Message to cancel.

setCancelId

public void setCancelId(int cancelId)

Description copied from interface: CancelRequest

Sets the message to cancel by id.

Specified by:

setCancelId in interface CancelRequest

Parameters:

cancelId - The id of the message to cancel.

getResultResponse

public CancelResponse getResultResponse()

Specified by:

getResultResponse in interface org.apache.directory.api.ldap.model.message.ResultResponseRequest<CancelResponse>

Overrides:

getResultResponse in class org.apache.directory.api.ldap.model.message.AbstractExtendedRequest<CancelResponse>