Package org.apache.directory.api.ldap.extras.extended.startTransaction

Class StartTransactionResponseImpl

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.startTransaction.StartTransactionResponseImpl

All Implemented Interfaces:

StartTransactionResponse, ExtendedResponse, Message, Response, ResultResponse

public class StartTransactionResponseImpl
extends AbstractExtendedResponse
implements StartTransactionResponse

The interface for Start Transaction Extended Response. It's described in RFC 5805 :

 StartTransactionResponse ::= [APPLICATION 24] SEQUENCE {
            COMPONENTS OF LDAPResult,
            responseValue    [11] OCTET STRING OPTIONAL }
 

where the responseName is not present, and the responseValue contain a transaction identifier when the result is SUCCESS.

Author:

Apache Directory Project

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
StartTransactionResponseImpl()	Create a new StartTransactionResponseImpl instance
StartTransactionResponseImpl(byte[] transactionId)	Create a new StartTransactionResponseImpl instance
StartTransactionResponseImpl(int messageId, byte[] transactionId)	Create a new StartTransactionResponseImpl instance
StartTransactionResponseImpl(int messageId, ResultCodeEnum resultCode, byte[] transactionId)	Create a new StartTransactionResponseImpl object

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Checks to see if an object equals this ExtendedRequest.
byte[]	getTransactionId()
int	hashCode()
void	setTransactionId(byte[] transactionId)
String	toString()	Get a String representation of an ExtendedResponse

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

getResponseName, setResponseName

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

StartTransactionResponseImpl

public StartTransactionResponseImpl(int messageId,
                                    ResultCodeEnum resultCode,
                                    byte[] transactionId)

Create a new StartTransactionResponseImpl object

Parameters:

messageId - The messageId

resultCode - the result code

transactionId - The transaction ID

StartTransactionResponseImpl

public StartTransactionResponseImpl(int messageId,
                                    byte[] transactionId)

Create a new StartTransactionResponseImpl instance

Parameters:

messageId - The request's messageId

transactionId - The transaction ID

StartTransactionResponseImpl

public StartTransactionResponseImpl(byte[] transactionId)

Create a new StartTransactionResponseImpl instance

Parameters:

transactionId - The transaction ID

StartTransactionResponseImpl

public StartTransactionResponseImpl()

Create a new StartTransactionResponseImpl instance

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractExtendedResponse

Returns:

the instance's hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Description copied from class: AbstractExtendedResponse

Checks to see if an object equals this ExtendedRequest.

Overrides:

equals in class AbstractExtendedResponse

Parameters:

obj - the object to be checked for equality

Returns:

true if the obj equals this ExtendedRequest, false otherwise

See Also:

Object.equals(Object)

getTransactionId

public byte[] getTransactionId()

Specified by:

getTransactionId in interface StartTransactionResponse

Returns:

The transaction ID if success

setTransactionId

public void setTransactionId(byte[] transactionId)

toString

public String toString()

Description copied from class: AbstractExtendedResponse

Get a String representation of an ExtendedResponse

Overrides:

toString in class AbstractExtendedResponse

Returns:

An ExtendedResponse String

See Also:

Object.toString()