Class EndTransactionExtendedRequest

    • Constructor Detail

      • EndTransactionExtendedRequest

        public EndTransactionExtendedRequest​(@NotNull
                                             ASN1OctetString transactionID,
                                             boolean commit,
                                             @Nullable
                                             Control... controls)
        Creates a new end 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.
      • EndTransactionExtendedRequest

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

      • getTransactionID

        @NotNull
        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.
      • process

        @NotNull
        public EndTransactionExtendedResult process​(@NotNull
                                                    LDAPConnection connection,
                                                    int depth)
                                             throws LDAPException
        Sends this extended request to the directory server over the provided connection and returns the associated response.
        Overrides:
        process in class ExtendedRequest
        Parameters:
        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.
        Returns:
        An LDAP result object that provides information about the result of the extended operation processing.
        Throws:
        LDAPException - If a problem occurs while sending the request or reading the response.
      • duplicate

        @NotNull
        public EndTransactionExtendedRequest duplicate​(@Nullable
                                                       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

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