Package com.unboundid.ldap.sdk.unboundidds.extensions

Class EndInteractiveTransactionExtendedRequest

  • All Implemented Interfaces:
    ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable
    @NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class EndInteractiveTransactionExtendedRequest
extends ExtendedRequest
    This class provides an implementation of the end interactive transaction extended request. It may be used to either commit or abort a transaction that was created using the start interactive transaction request. See the documentation in the StartInteractiveTransactionExtendedRequest for an example of processing an interactive transaction.
    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.
    See Also:
    Serialized Form

    • Constructor Detail

      • EndInteractiveTransactionExtendedRequest

        public EndInteractiveTransactionExtendedRequest​(ASN1OctetString transactionID,
                                                boolean commit)
        Creates a new end interactive transaction extended request with the provided information.
        Parameters:
        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.

      • EndInteractiveTransactionExtendedRequest

        public EndInteractiveTransactionExtendedRequest​(ASN1OctetString transactionID,
                                                boolean commit,
                                                Control[] controls)
        Creates a new end interactive transaction extended request with the provided information.
        Parameters:
        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.

      • EndInteractiveTransactionExtendedRequest

        public EndInteractiveTransactionExtendedRequest​(ExtendedRequest extendedRequest)
                                         throws LDAPException
        Creates a new end interactive transaction extended request from the provided generic extended request.
        Parameters:
        extendedRequest - The generic extended request to use to create this end interactive transaction extended request.
        Throws:
        LDAPException - If a problem occurs while decoding the request.

    • Method Detail

      • getTransactionID

        public ASN1OctetString getTransactionID()
        Retrieves the transaction ID for the transaction to commit or abort.
        Returns:
        The transaction ID for the transaction to commit or abort.

      • commit

        public boolean commit()
        Indicates whether the transaction should be committed or aborted.
        Returns:
        true if the transaction should be committed, or false if it should be aborted.

      • duplicate

        public EndInteractiveTransactionExtendedRequest duplicate​(Control[] controls)
        Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type.
        Specified by:
        duplicate in interface ReadOnlyLDAPRequest
        Overrides:
        duplicate in class ExtendedRequest
        Parameters:
        controls - The set of controls to include in the duplicate request.
        Returns:
        A new instance of this LDAP request that may be modified without impacting this request.

      • getExtendedRequestName

        public java.lang.String getExtendedRequestName()
        Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.
        Overrides:
        getExtendedRequestName in class ExtendedRequest
        Returns:
        The user-friendly name for this extended request, or the OID if no user-friendly name is available.

      • toString

        public void toString​(java.lang.StringBuilder buffer)
        Appends a string representation of this request to the provided buffer.
        Specified by:
        toString in interface ProtocolOp
        Specified by:
        toString in interface ReadOnlyLDAPRequest
        Overrides:
        toString in class ExtendedRequest
        Parameters:
        buffer - The buffer to which to append a string representation of this request.