Package 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>

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

org.apache.directory.api.ldap.codec.decorators.ExtendedRequestDecorator<CancelRequest>

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

All Implemented Interfaces:

Asn1Object, Decorator<CancelRequest>, CancelRequest, AbandonableRequest, ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

public class CancelRequestDecorator
extends ExtendedRequestDecorator<CancelRequest>
implements CancelRequest, Asn1Object

A Decorator for CancelRequests.

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
CancelRequestDecorator(LdapApiService codec, CancelRequest decoratedMessage)	Creates a new instance of CancelRequestDecorator.

Method Summary

Modifier and Type	Method	Description
int	getCancelId()
byte[]	getRequestValue()	Gets the Extended request payload
void	setCancelId(int cancelId)	Sets the message to cancel by id.
void	setRequestValue(byte[] requestValue)	Sets the extended request's requestValue portion of the PDU.

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

addAllControls, addControl, computeLength, encode, getRequestName, removeControl, setMessageId, setRequestName

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.api.asn1.Asn1Object

computeLength, encode

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

getResultResponse

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

getResponseType

Constructor Detail

CancelRequestDecorator

public CancelRequestDecorator(LdapApiService codec,
                              CancelRequest decoratedMessage)

Creates a new instance of CancelRequestDecorator.

Parameters:

codec - The LDAP Service to use

decoratedMessage - The canceled request

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)

Sets the message to cancel by id.

Specified by:

setCancelId in interface CancelRequest

Parameters:

cancelId - The id of the message to cancel.

getRequestValue

public byte[] getRequestValue()

Gets the Extended request payload

Overrides:

getRequestValue in class ExtendedRequestDecorator<CancelRequest>

Returns:

The extended payload

setRequestValue

public void setRequestValue(byte[] requestValue)

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

Overrides:

setRequestValue in class ExtendedRequestDecorator<CancelRequest>

Parameters:

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