com.unboundid.ldap.sdk

Class SASLBindInProgressException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.unboundid.util.LDAPSDKException

com.unboundid.ldap.sdk.LDAPException

com.unboundid.ldap.sdk.LDAPBindException

com.unboundid.ldap.sdk.SASLBindInProgressException

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SASLBindInProgressException
extends LDAPBindException

This class defines an exception that can be thrown if the server sends a bind response with a result code of ResultCode.SASL_BIND_IN_PROGRESS, which indicates that SASL bind processing has not yet completed. This is not an error, but neither does it indicate that bind processing has completed. This exception provides access to the bind result and the server SASL credentials that it may optionally contain so that this information may be used to continue bind processing.

See Also:

Serialized Form

Field Summary

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

NO_CONTROLS, NO_REFERRALS

Method Summary

Modifier and Type	Method and Description
BindResult	getBindResult() Retrieves the bind result that was returned by the server.
ASN1OctetString	getServerSASLCredentials() Retrieves the server SASL credentials included in the bind result, if any.

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

toLDAPResult

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

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

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

Method Detail

getBindResult

@NotNull
public BindResult getBindResult()

Retrieves the bind result that was returned by the server.

Overrides:

getBindResult in class LDAPBindException

Returns:

The bind result that was returned by the server.

getServerSASLCredentials

@Nullable
public ASN1OctetString getServerSASLCredentials()

Retrieves the server SASL credentials included in the bind result, if any.

Overrides:

getServerSASLCredentials in class LDAPBindException

Returns:

The server SASL credentials included in the bind result, or null if the bind result did not include any server SASL credentials.