Class MultiUpdateExtendedResult

  • All Implemented Interfaces:
    LDAPResponse, java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class MultiUpdateExtendedResult
    extends ExtendedResult
    This class provides an implementation of an extended result that can be used to provide information about the processing for a MultiUpdateExtendedRequest. The OID for this result is 1.3.6.1.4.1.30221.2.6.18, and the value (if present) should have the following encoding:
    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.

       MultiUpdateResultValue ::= SEQUENCE {
            changesApplied     ENUMERATED {
                 none        (0),
                 all         (1),
                 partial     (2),
                 ... },
            responses     SEQUENCE OF SEQUENCE {
                 responseOp     CHOICE {
                      modifyResponse     ModifyResponse,
                      addResponse        AddResponse,
                      delResponse        DelResponse,
                      modDNResponse      ModifyDNResponse,
                      extendedResp       ExtendedResponse,
                      ... },
                 controls       [0] Controls OPTIONAL,
                 ... },
            ... }
     
    See Also:
    MultiUpdateChangesApplied, MultiUpdateExtendedRequest, Serialized Form
    • Constructor Detail

      • MultiUpdateExtendedResult

        public MultiUpdateExtendedResult​(@NotNull
                                         ExtendedResult extendedResult)
                                  throws LDAPException
        Creates a new multi-update extended result from the provided extended result.
        Parameters:
        extendedResult - The extended result to be decoded as a multi-update result.
        Throws:
        LDAPException - If a problem is encountered while attempting to decode the provided extended result as a multi-update result.
      • MultiUpdateExtendedResult

        public MultiUpdateExtendedResult​(int messageID,
                                         @NotNull
                                         ResultCode resultCode,
                                         @Nullable
                                         java.lang.String diagnosticMessage,
                                         @Nullable
                                         java.lang.String matchedDN,
                                         @Nullable
                                         java.lang.String[] referralURLs,
                                         @Nullable
                                         MultiUpdateChangesApplied changesApplied,
                                         @Nullable
                                         java.util.List<ObjectPair<OperationType,​LDAPResult>> results,
                                         @Nullable
                                         Control... controls)
                                  throws LDAPException
        Creates a new multi-update extended request with the provided information.
        Parameters:
        messageID - The message ID for this extended result.
        resultCode - The result code for this result. It must not be null.
        diagnosticMessage - The diagnostic message to include in the result. It may be null if no diagnostic message should be included.
        matchedDN - The matched DN to include in the result. It may be null if no matched DN should be included.
        referralURLs - The set of referral URLs to include in the result. It may be null or empty if no referral URLs should be included.
        changesApplied - The value which indicates whether any or all of the changes from the request were successfully applied.
        results - The set of operation results to be included in the extended result value. It may be null or empty if no operation results should be included.
        controls - The set of controls to include in the multi-update result. It may be null or empty if no controls should be included.
        Throws:
        LDAPException - If any of the results are for an inappropriate operation type.
    • Method Detail

      • getChangesApplied

        @Nullable
        public MultiUpdateChangesApplied getChangesApplied()
        Retrieves the value that indicates whether any or all changes from the multi-update request were successfully applied.
        Returns:
        The value that indicates whether any or all changes from the multi-update request were successfully applied.
      • getResults

        @NotNull
        public java.util.List<ObjectPair<OperationType,​LDAPResult>> getResults()
        Retrieves a list of the results for operations processed as part of the multi-update operation, with each result paired with its corresponding operation type.
        Returns:
        A list of the results for operations processed as part of the multi-update operation. The returned list may be empty if no operation results were available.
      • getExtendedResultName

        @NotNull
        public java.lang.String getExtendedResultName()
        Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.
        Overrides:
        getExtendedResultName in class ExtendedResult
        Returns:
        The user-friendly name for this extended request, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.
      • toString

        public void toString​(@NotNull
                             java.lang.StringBuilder buffer)
        Appends a string representation of this extended result to the provided buffer.
        Specified by:
        toString in interface LDAPResponse
        Overrides:
        toString in class ExtendedResult
        Parameters:
        buffer - The buffer to which a string representation of this extended result will be appended.