|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
com.unboundid.util.LDAPSDKException
com.unboundid.ldap.sdk.LDAPException
com.unboundid.ldap.sdk.LDAPBindException
public class LDAPBindException
This class defines an exception that can be thrown if the server sends a bind
response with a result code other than ResultCode#SUCCESS
, which
indicates that the bind operation did not complete successfully. This may be
used to obtain access to any server SASL credentials contained in the
non-successful bind result.
Field Summary |
---|
Fields inherited from class com.unboundid.ldap.sdk.LDAPException |
---|
NO_CONTROLS, NO_REFERRALS |
Constructor Summary | |
---|---|
LDAPBindException(BindResult bindResult)
Creates a new LDAP bind exception from the provided bind result. |
Method Summary | |
---|---|
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.LDAPException |
---|
getDiagnosticMessage, getExceptionMessage, getMatchedDN, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl, toLDAPResult, toString |
Methods inherited from class com.unboundid.util.LDAPSDKException |
---|
toString |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LDAPBindException(BindResult bindResult)
bindResult
- The bind result to use to create this exception.Method Detail |
---|
public BindResult getBindResult()
public ASN1OctetString getServerSASLCredentials()
null
if the bind result did not include any server SASL
credentials.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |