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

Class EndTransactionResponseDecorator

java.lang.Object

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

org.apache.directory.api.ldap.codec.decorators.ResponseDecorator<R>

org.apache.directory.api.ldap.codec.decorators.ExtendedResponseDecorator<org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse>

org.apache.directory.api.ldap.extras.extended.ads_impl.endTransaction.EndTransactionResponseDecorator

All Implemented Interfaces:

org.apache.directory.api.asn1.Asn1Object, org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse>, org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse, org.apache.directory.api.ldap.model.message.ExtendedResponse, org.apache.directory.api.ldap.model.message.Message, org.apache.directory.api.ldap.model.message.Response, org.apache.directory.api.ldap.model.message.ResultResponse

public class EndTransactionResponseDecorator
extends org.apache.directory.api.ldap.codec.decorators.ExtendedResponseDecorator<org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse>
implements org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse

A Decorator for EndTransaction response.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private int[][]	controlLengths The message controls' lengths
private int[]	controlsLengths Stores the Controls global lengths
private org.apache.directory.api.ldap.extras.extended.endTransaction.UpdateControls	currentUpdateControls The current UpdateControls
private org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse	endTransactionResponse The endTransaction response
private int	globalSequenceLength Stores the length of the request
private static org.slf4j.Logger	LOG
private int[]	updateControlsLength Stores the length of updateControls
private int	updateSequenceLength Stores the length of the updateControls part

Fields inherited from class org.apache.directory.api.ldap.codec.decorators.ExtendedResponseDecorator

responseValue

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

messageLength

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

EXTENSION_OID

Constructor Summary

Constructors

Constructor and Description
EndTransactionResponseDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse decoratedMessage) Creates a new instance of EndTransactionResponseDecorator.

Method Summary

Modifier and Type	Method and Description
(package private) int	computeLengthInternal() Compute the EndTransactionResponse extended operation length
(package private) ByteBuffer	encodeInternal() Encodes the EndTransactionResponse extended operation.
org.apache.directory.api.ldap.extras.extended.endTransaction.UpdateControls	getCurrentUpdateControls()
int	getFailedMessageId()
List<org.apache.directory.api.ldap.extras.extended.endTransaction.UpdateControls>	getUpdateControls()
void	setCurrentControls(org.apache.directory.api.ldap.extras.extended.endTransaction.UpdateControls currentUpdateControls)
void	setFailedMessageId(int failedMessageId)
void	setResponseValue(byte[] responseValue)

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

computeLength, encode, getResponseName, getResponseValue, setResponseName

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

getLdapResult, setLdapResult

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

addAllControls, addControl, get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, removeControl, setControlsLength, setMessageId, 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.ExtendedResponse

getResponseName, setResponseName

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

getLdapResult

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

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Field Detail

LOG

private static final org.slf4j.Logger LOG

endTransactionResponse

private org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse endTransactionResponse

The endTransaction response

currentUpdateControls

private org.apache.directory.api.ldap.extras.extended.endTransaction.UpdateControls currentUpdateControls

The current UpdateControls

globalSequenceLength

private int globalSequenceLength

Stores the length of the request

updateSequenceLength

private int updateSequenceLength

Stores the length of the updateControls part

updateControlsLength

private int[] updateControlsLength

Stores the length of updateControls

controlsLengths

private int[] controlsLengths

Stores the Controls global lengths

controlLengths

private int[][] controlLengths

The message controls' lengths

Constructor Detail

EndTransactionResponseDecorator

public EndTransactionResponseDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                                       org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse decoratedMessage)

Creates a new instance of EndTransactionResponseDecorator.

Parameters:

codec - The LDAP service instance

decoratedMessage - The decorated message

Method Detail

setResponseValue

public void setResponseValue(byte[] responseValue)

Overrides:

setResponseValue in class org.apache.directory.api.ldap.codec.decorators.ExtendedResponseDecorator<org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse>

getFailedMessageId

public int getFailedMessageId()

Specified by:

getFailedMessageId in interface org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse

setFailedMessageId

public void setFailedMessageId(int failedMessageId)

Specified by:

setFailedMessageId in interface org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse

getUpdateControls

public List<org.apache.directory.api.ldap.extras.extended.endTransaction.UpdateControls> getUpdateControls()

Specified by:

getUpdateControls in interface org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse

getCurrentUpdateControls

public org.apache.directory.api.ldap.extras.extended.endTransaction.UpdateControls getCurrentUpdateControls()

Returns:

the currentUpdateControls

setCurrentControls

public void setCurrentControls(org.apache.directory.api.ldap.extras.extended.endTransaction.UpdateControls currentUpdateControls)

Parameters:

currentUpdateControls - the currentUpdateControls to set

computeLengthInternal

int computeLengthInternal()

Compute the EndTransactionResponse extended operation length

 0x30 L1 
   | 
  [+-- 0x02 L2 failed message ID] 
  [+-- 0x30 L3 updateControls SEQUENCE OF
         |
         +-- 0x30 L4 updateControls SEQUENCE
               |
               +-- 0x02 L5 messageID
               +-- ]
               
 

encodeInternal

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

Encodes the EndTransactionResponse extended operation.

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

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