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

Class EndTransactionRequestImpl

java.lang.Object

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

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

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

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

All Implemented Interfaces:

EndTransactionRequest, org.apache.directory.api.ldap.model.message.ExtendedRequest, org.apache.directory.api.ldap.model.message.Message, org.apache.directory.api.ldap.model.message.Request, org.apache.directory.api.ldap.model.message.ResultResponseRequest, org.apache.directory.api.ldap.model.message.SingleReplyRequest

public class EndTransactionRequestImpl
extends org.apache.directory.api.ldap.model.message.AbstractExtendedRequest
implements EndTransactionRequest

The EndTransactionRequest implementation. 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 and Description
private boolean	commit A flag telling of we should commit or rollback the transaction
private byte[]	transactionId The transaction ID received from the StartTransactionResponse

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.EndTransactionRequest

EXTENSION_OID

Constructor Summary

Constructors

Constructor and Description
EndTransactionRequestImpl() Creates a new instance of EndTransactionRequestImpl.
EndTransactionRequestImpl(int messageId) Creates a new instance of EndTransactionRequestImpl.

Method Summary

Modifier and Type	Method and Description
boolean	getCommit()
EndTransactionResponse	getResultResponse()
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
String	toString()

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

addAllControls, addControl, equals, getRequestName, getResponse, getResponseType, hashCode, removeControl, setMessageId, setRequestName, setResponse

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

hasResponse

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

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

addAllControls, addControl, getRequestName, removeControl, setMessageId, setRequestName

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

getResponseType

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

hasResponse

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

get, getControl, getControls, getMessageId, getType, hasControl, put

Field Detail

transactionId

private byte[] transactionId

The transaction ID received from the StartTransactionResponse

commit

private boolean commit

A flag telling of we should commit or rollback the transaction

Constructor Detail

EndTransactionRequestImpl

public EndTransactionRequestImpl(int messageId)

Creates a new instance of EndTransactionRequestImpl.

Parameters:

messageId - the message id

EndTransactionRequestImpl

public EndTransactionRequestImpl()

Creates a new instance of EndTransactionRequestImpl.

Method Detail

getResultResponse

public EndTransactionResponse getResultResponse()

Specified by:

getResultResponse in interface org.apache.directory.api.ldap.model.message.ResultResponseRequest

Overrides:

getResultResponse in class org.apache.directory.api.ldap.model.message.AbstractExtendedRequest

getCommit

public boolean getCommit()

Specified by:

getCommit in interface EndTransactionRequest

Returns:

true if the operation should be committed, false otherwise

setCommit

public void setCommit(boolean commit)

Set the Commit flag for this transaction.

Specified by:

setCommit in interface EndTransactionRequest

Parameters:

commit - true if the transaction should be committed, false if it should be rollbacked.

getTransactionId

public byte[] getTransactionId()

Specified by:

getTransactionId in interface EndTransactionRequest

Returns:

The transaction ID

setTransactionId

public void setTransactionId(byte[] transactionId)

Set the transaction ID to commit or rollback

Specified by:

setTransactionId in interface EndTransactionRequest

Parameters:

transactionId - The transaction ID we got from the startTransaction response

toString

public String toString()

Overrides:

toString in class org.apache.directory.api.ldap.model.message.AbstractExtendedRequest

See Also:

Object.toString()