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

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

All Implemented Interfaces:

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

public class CancelRequestDecorator
extends org.apache.directory.api.ldap.codec.decorators.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest>
implements org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest, org.apache.directory.api.asn1.Asn1Object

A Decorator for CancelRequests.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest	cancelRequest The Id of the the message to cancel
private int	cancelSequenceLength Length of the sequence
private static org.slf4j.Logger	LOG

Fields inherited from class org.apache.directory.api.ldap.codec.decorators.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.cancel.CancelRequest

EXTENSION_OID

Constructor Summary

Constructors

Constructor and Description
CancelRequestDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest decoratedMessage) Creates a new instance of CancelRequestDecorator.

Method Summary

Modifier and Type	Method and Description
(package private) int	computeLengthInternal() Compute the Cancel length
(package private) ByteBuffer	encodeInternal() Encodes the cancel extended operation.
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.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

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

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

computeLength, encode

Field Detail

LOG

private static final org.slf4j.Logger LOG

cancelRequest

private org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest cancelRequest

The Id of the the message to cancel

cancelSequenceLength

private int cancelSequenceLength

Length of the sequence

Constructor Detail

CancelRequestDecorator

public CancelRequestDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                              org.apache.directory.api.ldap.extras.extended.cancel.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 org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest

setCancelId

public void setCancelId(int cancelId)

Specified by:

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

getRequestValue

public byte[] getRequestValue()

Overrides:

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

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.decorators.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest>

Parameters:

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

computeLengthInternal

int computeLengthInternal()

Compute the Cancel length

 0x30 L1 
   | 
   +--> 0x02 0x0(1-4) [0..2^31-1]
 

encodeInternal

ByteBuffer encodeInternal()
                   throws org.apache.directory.api.asn1.EncoderException

Encodes the cancel extended operation.

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

org.apache.directory.api.asn1.EncoderException - If anything goes wrong.