|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.MultiUpdateExtendedResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class MultiUpdateExtendedResult
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.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:
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, ... }, }
MultiUpdateChangesApplied
,
MultiUpdateExtendedRequest
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
MULTI_UPDATE_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.18) for the multi-update extended result. |
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
MultiUpdateExtendedResult(ExtendedResult extendedResult)
Creates a new multi-update extended result from the provided extended result. |
|
MultiUpdateExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
MultiUpdateChangesApplied changesApplied,
java.util.List<ObjectPair<OperationType,LDAPResult>> results,
Control... controls)
Creates a new multi-update extended request with the provided information. |
Method Summary | |
---|---|
MultiUpdateChangesApplied |
getChangesApplied()
Retrieves the value that indicates whether any or all changes from the multi-update request were successfully applied. |
java.lang.String |
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. |
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. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended result to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult |
---|
getOID, getValue, hasValue, toString |
Methods inherited from class com.unboundid.ldap.sdk.LDAPResult |
---|
getDiagnosticMessage, getMatchedDN, getMessageID, getReferralURLs, getResponseControl, getResponseControls, getResultCode, hasResponseControl, hasResponseControl |
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 MULTI_UPDATE_RESULT_OID
Constructor Detail |
---|
public MultiUpdateExtendedResult(ExtendedResult extendedResult) throws LDAPException
extendedResult
- The extended result to be decoded as a multi-update
result.
LDAPException
- If a problem is encountered while attempting to
decode the provided extended result as a
multi-update result.public MultiUpdateExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, MultiUpdateChangesApplied changesApplied, java.util.List<ObjectPair<OperationType,LDAPResult>> results, Control... controls) throws LDAPException
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.
LDAPException
- If any of the results are for an inappropriate
operation type.Method Detail |
---|
public MultiUpdateChangesApplied getChangesApplied()
public java.util.List<ObjectPair<OperationType,LDAPResult>> getResults()
public java.lang.String getExtendedResultName()
null
will be returned.
getExtendedResultName
in class ExtendedResult
null
if neither a user-friendly name nor a response OID
are available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class ExtendedResult
buffer
- The buffer to which a string representation of this
extended result will be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |