EndTransactionRequest (Apache LDAP API 2.1.1 API Documentation)

All Superinterfaces:

ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

All Known Implementing Classes:

EndTransactionRequestImpl
```
public interface EndTransactionRequest
extends ExtendedRequest
```
The EndTransactionRequest interface. This is for the RFC 5805 End Transaction Request, which grammar is :
```
 ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
              requestName      [0] LDAPOID,
              requestValue     [1] OCTET STRING OPTIONAL }
 
```
where 'requestName' is 1.3.6.1.1.21.3 and requestValue is a BER encoded value. The syntax for this value is :
```
 txnEndReq ::= SEQUENCE {
         commit         BOOLEAN DEFAULT TRUE,
         identifier     OCTET STRING }
 
```
Author:

Apache Directory Project

Field Summary

Fields
Modifier and Type Field Description

static String EXTENSION_OID
The OID for the EndTransaction extended operation request.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`getCommit()`
`byte[]`	`getTransactionId()`
`void`	`setCommit(boolean commit)`	Set the Commit flag for this transaction.
`void`	`setTransactionId(byte[] transactionId)`	Set the transaction ID to commit or rollback

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.Message
get, getControl, getControls, getMessageId, getType, hasControl, put

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

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

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

- Field Detail
  - EXTENSION_OID
```
static final String EXTENSION_OID
```
    The OID for the EndTransaction extended operation request.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getCommit
```
boolean getCommit()
```
    Returns:
    
    true if the operation should be committed, false otherwise
  - setCommit
```
void setCommit(boolean commit)
```
    Set the Commit flag for this transaction.
    
    Parameters:
    
    commit - true if the transaction should be committed, false if it should be rollbacked.
  - getTransactionId
```
byte[] getTransactionId()
```
    Returns:
    
    The transaction ID
  - setTransactionId
```
void setTransactionId(byte[] transactionId)
```
    Set the transaction ID to commit or rollback
    
    Parameters:
    
    transactionId - The transaction ID we got from the startTransaction response