com.unboundid.ldap.sdk

Class LDAPExtendedOperationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.unboundid.util.LDAPSDKException

com.unboundid.ldap.sdk.LDAPException

com.unboundid.ldap.sdk.LDAPExtendedOperationException

All Implemented Interfaces:

java.io.Serializable

@NotExtensible
 @NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public class LDAPExtendedOperationException
extends LDAPException

This class defines an exception that can be thrown if the server returns an extended response that indicates that the operation did not complete successfully. This may be used to obtain access to any response OID and/or value that may have been included in the extended result.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.unboundid.ldap.sdk.LDAPException

NO_CONTROLS, NO_REFERRALS

Constructor Summary

Constructors

Constructor and Description
LDAPExtendedOperationException(ExtendedResult extendedResult) Creates a new LDAP extended operation exception from the provided extended result.

Method Summary

Modifier and Type	Method and Description
ExtendedResult	getExtendedResult() Retrieves the extended result that was returned by the server.
java.lang.String	getResponseOID() Retrieves the response OID from the extended result, if any.
ASN1OctetString	getResponseValue() Retrieves the response value from the extended result, if any.
LDAPResult	toLDAPResult() Creates a new LDAPResult object from this exception.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this exception to the provided buffer.
void	toString(java.lang.StringBuilder buffer, boolean includeCause, boolean includeStackTrace) Appends a string representation of this LDAPException to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.LDAPException

getDiagnosticMessage, getExceptionMessage, getExceptionMessage, getMatchedDN, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl

Methods inherited from class com.unboundid.util.LDAPSDKException

toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LDAPExtendedOperationException

public LDAPExtendedOperationException(@NotNull
                                      ExtendedResult extendedResult)

Creates a new LDAP extended operation exception from the provided extended result.

Parameters:

extendedResult - The extended result to use to create this exception.

Method Detail

toLDAPResult

@NotNull
public LDAPResult toLDAPResult()

Creates a new LDAPResult object from this exception.

Overrides:

toLDAPResult in class LDAPException

Returns:

The LDAPResult object created from this exception.

getExtendedResult

@NotNull
public ExtendedResult getExtendedResult()

Retrieves the extended result that was returned by the server.

Returns:

The extended result that was returned by the server.

getResponseOID

@Nullable
public java.lang.String getResponseOID()

Retrieves the response OID from the extended result, if any.

Returns:

The response OID from the extended result, or null if the result did not include an OID.

getResponseValue

@Nullable
public ASN1OctetString getResponseValue()

Retrieves the response value from the extended result, if any.

Returns:

The response value from the extended result, or null if the result did not include a value.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this exception to the provided buffer.

Overrides:

toString in class LDAPException

Parameters:

buffer - The buffer to which the string representation of this exception is to be appended.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer,
                     boolean includeCause,
                     boolean includeStackTrace)

Appends a string representation of this LDAPException to the provided buffer.

Overrides:

toString in class LDAPException

Parameters:

buffer - The buffer to which the information should be appended. This must not be null.

includeCause - Indicates whether to include information about the cause (if any) in the exception message.

includeStackTrace - Indicates whether to include a condensed representation of the stack trace in the exception message. If a stack trace is included, then the cause (if any) will automatically be included, regardless of the value of the includeCause argument.