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

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

All Implemented Interfaces:

Asn1Object, Decorator<EndTransactionResponse>, EndTransactionResponse, ExtendedResponse, Message, Response, ResultResponse

public class EndTransactionResponseDecorator
extends ExtendedResponseDecorator<EndTransactionResponse>
implements EndTransactionResponse

A Decorator for EndTransaction response.

Author:

Apache Directory Project

Field Summary

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

EXTENSION_OID

Constructor Summary

Constructors

Constructor	Description
EndTransactionResponseDecorator(LdapApiService codec, EndTransactionResponse decoratedMessage)	Creates a new instance of EndTransactionResponseDecorator.

Method Summary

Modifier and Type	Method	Description
UpdateControls	getCurrentUpdateControls()
int	getFailedMessageId()
List<UpdateControls>	getUpdateControls()
void	setCurrentControls(UpdateControls currentUpdateControls)
void	setFailedMessageId(int failedMessageId)
void	setResponseValue(byte[] responseValue)	sets the Extended response payload

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

equals, 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.Message

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

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

getLdapResult

Constructor Detail

EndTransactionResponseDecorator

public EndTransactionResponseDecorator(LdapApiService codec,
                                       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)

sets the Extended response payload

Overrides:

setResponseValue in class ExtendedResponseDecorator<EndTransactionResponse>

Parameters:

responseValue - The extended payload

getFailedMessageId

public int getFailedMessageId()

Specified by:

getFailedMessageId in interface EndTransactionResponse

Returns:

The Message ID if failure

setFailedMessageId

public void setFailedMessageId(int failedMessageId)

Specified by:

setFailedMessageId in interface EndTransactionResponse

Parameters:

failedMessageId - The messageId that causes the failure

getUpdateControls

public List<UpdateControls> getUpdateControls()

Specified by:

getUpdateControls in interface EndTransactionResponse

Returns:

the list of <messageId, Controls> processed within the transaction

getCurrentUpdateControls

public UpdateControls getCurrentUpdateControls()

Returns:

the currentUpdateControls

setCurrentControls

public void setCurrentControls(UpdateControls currentUpdateControls)

Parameters:

currentUpdateControls - the currentUpdateControls to set