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
,ExtendedResponse
,Message
,Response
,ResultResponse
public class EndTransactionResponseImpl extends 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 inherited from interface org.apache.directory.api.ldap.extras.extended.endTransaction.EndTransactionResponse
EXTENSION_OID
-
-
Constructor Summary
Constructors Constructor Description EndTransactionResponseImpl()
Create a new StartTransactionResponseImpl instanceEndTransactionResponseImpl(int messageId)
Create a new EndTransactionResponseImpl instanceEndTransactionResponseImpl(int failedMessageId, ResultCodeEnum resultCode)
Create a new EndTransactionResponseImpl object
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Checks to see if an object equals this ExtendedRequest.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 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
-
EndTransactionResponseImpl
public EndTransactionResponseImpl(int failedMessageId, ResultCodeEnum resultCode)
Create a new EndTransactionResponseImpl object- Parameters:
failedMessageId
- The faulty messageIdresultCode
- 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 interfaceEndTransactionResponse
- Returns:
- The Message ID if failure
-
setFailedMessageId
public void setFailedMessageId(int failedMessageId)
- Specified by:
setFailedMessageId
in interfaceEndTransactionResponse
- Parameters:
failedMessageId
- The messageId that causes the failure
-
getUpdateControls
public List<UpdateControls> getUpdateControls()
- Specified by:
getUpdateControls
in interfaceEndTransactionResponse
- Returns:
- the updateControls
-
setUpdateControls
public void setUpdateControls(List<UpdateControls> updateControls)
- Parameters:
updateControls
- the updateControls to set
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractExtendedResponse
- 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 classAbstractExtendedResponse
- Parameters:
obj
- the object to be checked for equality- Returns:
- true if the obj equals this ExtendedRequest, false otherwise
- See Also:
Object.equals(Object)
-
-