|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.extensions.EndTransactionExtendedRequest
@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class EndTransactionExtendedRequest
This class provides an implementation of the end transaction extended
request as defined in
RFC 5805. It may be used
to either commit or abort a transaction that was created using the start
transaction request. See the documentation for the
StartTransactionExtendedRequest
class for an example of processing an
LDAP transaction.
Field Summary | |
---|---|
static java.lang.String |
END_TRANSACTION_REQUEST_OID
The OID (1.3.6.1.1.21.3) for the end transaction extended request. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
EndTransactionExtendedRequest(ASN1OctetString transactionID,
boolean commit,
Control... controls)
Creates a new end transaction extended request with the provided information. |
|
EndTransactionExtendedRequest(ExtendedRequest extendedRequest)
Creates a new end transaction extended request from the provided generic extended request. |
Method Summary | |
---|---|
boolean |
commit()
Indicates whether the transaction should be committed or aborted. |
EndTransactionExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
EndTransactionExtendedRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
java.lang.String |
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. |
ASN1OctetString |
getTransactionID()
Retrieves the transaction ID for the transaction to commit or abort. |
EndTransactionExtendedResult |
process(LDAPConnection connection,
int depth)
Sends this extended request to the directory server over the provided connection and returns the associated response. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, toCode, writeTo |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String END_TRANSACTION_REQUEST_OID
Constructor Detail |
---|
public EndTransactionExtendedRequest(ASN1OctetString transactionID, boolean commit, Control... controls)
transactionID
- The transaction ID for the transaction to commit or
abort. It must not be null
.commit
- true
if the transaction should be committed,
or false
if the transaction should be
aborted.controls
- The set of controls to include in the request.public EndTransactionExtendedRequest(ExtendedRequest extendedRequest) throws LDAPException
extendedRequest
- The generic extended request to use to create this
end transaction extended request.
LDAPException
- If a problem occurs while decoding the request.Method Detail |
---|
public ASN1OctetString getTransactionID()
public boolean commit()
true
if the transaction should be committed, or
false
if it should be aborted.public EndTransactionExtendedResult process(LDAPConnection connection, int depth) throws LDAPException
process
in class ExtendedRequest
connection
- The connection to use to communicate with the directory
server.depth
- The current referral depth for this request. It should
always be one for the initial request, and should only
be incremented when following referrals.
LDAPException
- If a problem occurs while sending the request or
reading the response.public EndTransactionExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public EndTransactionExtendedRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
controls
- The set of controls to include in the duplicate request.
public java.lang.String getExtendedRequestName()
getExtendedRequestName
in class ExtendedRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class ExtendedRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |