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

Class EndTransactionResponseImpl

java.lang.Object

org.apache.directory.api.ldap.model.message.AbstractMessage

org.apache.directory.api.ldap.model.message.AbstractResponse

org.apache.directory.api.ldap.model.message.AbstractResultResponse

org.apache.directory.api.ldap.model.message.AbstractExtendedResponse

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

All Implemented Interfaces:

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 EndTransactionResponseImpl
extends org.apache.directory.api.ldap.model.message.AbstractExtendedResponse
implements EndTransactionResponse

The End Transaction Extended Response implementation. It's described in RFC 5805 :

 ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
            COMPONENTS OF LDAPResult,
            responseName     [10] LDAPOID OPTIONAL,
            responseValue    [11] OCTET STRING OPTIONAL }
 

where the responseName is not present, and the responseValue contains a BER encoded value, defined by the following grammar :

 txnEndRes ::= SEQUENCE {
         messageID MessageID OPTIONAL,
              -- msgid associated with non-success resultCode
         updatesControls SEQUENCE OF updateControls SEQUENCE {
              messageID MessageID,
                   -- msgid associated with controls
              controls  Controls
         } OPTIONAL
    }
 

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private int	failedMessageId The faulty Message ID, if any
private List<UpdateControls>	updateControls The list of update controls for the message processed in the transaction

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractExtendedResponse

responseName

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractResultResponse

ldapResult

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

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

EXTENSION_OID

Constructor Summary

Constructors

Constructor and Description
EndTransactionResponseImpl() Create a new StartTransactionResponseImpl instance
EndTransactionResponseImpl(int messageId) Create a new EndTransactionResponseImpl instance
EndTransactionResponseImpl(int failedMessageId, org.apache.directory.api.ldap.model.message.ResultCodeEnum resultCode) Create a new EndTransactionResponseImpl object

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getFailedMessageId()
List<UpdateControls>	getUpdateControls()
int	hashCode()
void	setFailedMessageId(int failedMessageId)
void	setUpdateControls(List<UpdateControls> updateControls)

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractExtendedResponse

getResponseName, setResponseName, toString

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractResultResponse

getLdapResult

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

failedMessageId

private int failedMessageId

The faulty Message ID, if any

updateControls

private List<UpdateControls> updateControls

The list of update controls for the message processed in the transaction

Constructor Detail

EndTransactionResponseImpl

public EndTransactionResponseImpl(int failedMessageId,
                                  org.apache.directory.api.ldap.model.message.ResultCodeEnum resultCode)

Create a new EndTransactionResponseImpl object

Parameters:

failedMessageId - The faulty messageId

resultCode - the result code

EndTransactionResponseImpl

public EndTransactionResponseImpl(int messageId)

Create a new EndTransactionResponseImpl instance

Parameters:

messageId - The request's messageId

EndTransactionResponseImpl

public EndTransactionResponseImpl()

Create a new StartTransactionResponseImpl instance

Method Detail

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 updateControls

setUpdateControls

public void setUpdateControls(List<UpdateControls> updateControls)

Parameters:

updateControls - the updateControls to set

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.directory.api.ldap.model.message.AbstractExtendedResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class org.apache.directory.api.ldap.model.message.AbstractExtendedResponse

See Also:

Object.equals(Object)