Class BatchedTransactionSpecificationRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.BatchedTransactionSpecificationRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class BatchedTransactionSpecificationRequestControl extends Control
This class provides an implementation of the batched transaction specification request control, which may be used to indicate that the associated add, delete, modify, modify DN, or password modify operation is part of a batched transaction. The transaction should be created with the start batched transaction extended operation, which will obtain a transaction ID, and the transaction may be committed or aborted using the end batched transaction extended operation.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
Note that directory servers may limit the set of controls that are available for use in requests that are part of a transaction. RFC 5805 section 4 indicates that the following controls may be used in conjunction with the transaction specification request control:AssertionRequestControl
,ManageDsaITRequestControl
,PreReadRequestControl
, andPostReadRequestControl
. TheProxiedAuthorizationV1RequestControl
andProxiedAuthorizationV2RequestControl
controls cannot be included in requests that are part of a transaction, but you can include them in theStartBatchedTransactionExtendedRequest
to indicate that all operations within the transaction should be processed with the specified authorization identity.
The Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products support the following additional UnboundID-specific controls in conjunction with operations included in a transaction:AccountUsableRequestControl
,HardDeleteRequestControl
,IntermediateClientRequestControl
,PasswordPolicyRequestControl
,ReplicationRepairRequestControl
,SoftDeleteRequestControl
,SoftDeletedEntryAccessRequestControl
,SubtreeDeleteRequestControl
, andUndeleteRequestControl
.
See the documentation for theStartBatchedTransactionExtendedRequest
class for an example of processing a batched transaction.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
BATCHED_TRANSACTION_SPECIFICATION_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.1) for the batched transaction specification request control.
-
Constructor Summary
Constructors Constructor Description BatchedTransactionSpecificationRequestControl(ASN1OctetString transactionID)
Creates a new batched transaction specification request control with the provided transaction ID.BatchedTransactionSpecificationRequestControl(Control control)
Creates a new batched transaction specification request control which is decoded from the provided generic control.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.ASN1OctetString
getTransactionID()
Retrieves the transaction ID for the associated transaction.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.Control
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
-
-
-
-
Field Detail
-
BATCHED_TRANSACTION_SPECIFICATION_REQUEST_OID
public static final java.lang.String BATCHED_TRANSACTION_SPECIFICATION_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.1) for the batched transaction specification request control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BatchedTransactionSpecificationRequestControl
public BatchedTransactionSpecificationRequestControl(ASN1OctetString transactionID)
Creates a new batched transaction specification request control with the provided transaction ID.- Parameters:
transactionID
- The transaction ID for the associated transaction, as obtained from the start batched transaction extended operation. It must not benull
.
-
BatchedTransactionSpecificationRequestControl
public BatchedTransactionSpecificationRequestControl(Control control) throws LDAPException
Creates a new batched transaction specification request control which is decoded from the provided generic control.- Parameters:
control
- The generic control to be decoded as a batched transaction specification request control.- Throws:
LDAPException
- If the provided control cannot be decoded as a batched transaction specification request control.
-
-
Method Detail
-
getTransactionID
public ASN1OctetString getTransactionID()
Retrieves the transaction ID for the associated transaction.- Returns:
- The transaction ID for the associated transaction.
-
getControlName
public java.lang.String getControlName()
Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.- Overrides:
getControlName
in classControl
- Returns:
- The user-friendly name for this control, or the OID if no user-friendly name is available.
-
-