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

Interface EndTransactionResponse

All Superinterfaces:

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

All Known Implementing Classes:

EndTransactionResponseImpl

public interface EndTransactionResponse
extends org.apache.directory.api.ldap.model.message.ExtendedResponse

The interface for End Transaction Extended Response. 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
static String	EXTENSION_OID The OID for the Start Transaction extended operation response.

Method Summary

Modifier and Type	Method and Description
int	getFailedMessageId()
List<UpdateControls>	getUpdateControls()
void	setFailedMessageId(int failedMessageId)

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

EXTENSION_OID

static final String EXTENSION_OID

The OID for the Start Transaction extended operation response.

See Also:

Constant Field Values

Method Detail

getFailedMessageId

int getFailedMessageId()

Returns:

The Message ID if failure

setFailedMessageId

void setFailedMessageId(int failedMessageId)

Parameters:

failedMessageId - The messageId that causes the failure

getUpdateControls

List<UpdateControls> getUpdateControls()

Returns:

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