org.apache.directory.api.ldap.extras.extended.ads_impl.cancel

Class CancelRequestDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.MessageDecorator<M>

org.apache.directory.api.ldap.codec.decorators.RequestDecorator<M>

org.apache.directory.api.ldap.codec.decorators.ResultResponseRequestDecorator<M,R>

org.apache.directory.api.ldap.codec.decorators.SingleReplyRequestDecorator<Q,P>

org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.CancelRequest,org.apache.directory.api.ldap.extras.extended.CancelResponse>

org.apache.directory.api.ldap.extras.extended.ads_impl.cancel.CancelRequestDecorator

All Implemented Interfaces:

org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.extended.CancelRequest>, org.apache.directory.api.ldap.extras.extended.CancelRequest, org.apache.directory.api.ldap.model.message.AbandonableRequest, org.apache.directory.api.ldap.model.message.ExtendedRequest<org.apache.directory.api.ldap.extras.extended.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<org.apache.directory.api.ldap.extras.extended.CancelResponse>, org.apache.directory.api.ldap.model.message.SingleReplyRequest<org.apache.directory.api.ldap.extras.extended.CancelResponse>

public class CancelRequestDecorator
extends org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.CancelRequest,org.apache.directory.api.ldap.extras.extended.CancelResponse>
implements org.apache.directory.api.ldap.extras.extended.CancelRequest

A Decorator for CancelRequests.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator

requestValue

Fields inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

messageLength

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

Constructors

Constructor and Description
CancelRequestDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.extended.CancelRequest decoratedMessage)

Method Summary

Methods

Modifier and Type	Method and Description
int	getCancelId()
byte[]	getRequestValue()
void	setCancelId(int cancelId)
void	setRequestValue(byte[] requestValue) Sets the extended request's requestValue portion of the PDU.

Methods inherited from class org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator

addAllControls, addControl, computeLength, encode, getExtendedRequestLength, getRequestName, getRequestNameBytes, removeControl, setExtendedRequestLength, setMessageId, setRequestName, setRequestNameBytes

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.SingleReplyRequestDecorator

abandon, addAbandonListener, getResponseType, isAbandoned

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.ResultResponseRequestDecorator

getResultResponse, hasResponse

Methods inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, setControlsLength, setMessageLength, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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.ResultResponseRequest

getResultResponse

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

CancelRequestDecorator

public CancelRequestDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                      org.apache.directory.api.ldap.extras.extended.CancelRequest decoratedMessage)

Method Detail

getCancelId

public int getCancelId()

Specified by:

getCancelId in interface org.apache.directory.api.ldap.extras.extended.CancelRequest

setCancelId

public void setCancelId(int cancelId)

Specified by:

setCancelId in interface org.apache.directory.api.ldap.extras.extended.CancelRequest

getRequestValue

public byte[] getRequestValue()

Overrides:

getRequestValue in class org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.CancelRequest,org.apache.directory.api.ldap.extras.extended.CancelResponse>

setRequestValue

public void setRequestValue(byte[] requestValue)

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

Overrides:

setRequestValue in class org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.CancelRequest,org.apache.directory.api.ldap.extras.extended.CancelResponse>

Parameters:

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