Interface FailureSASLBindResult
-
- All Superinterfaces:
SASLBindResult
@NotExtensible @ThreadSafety(level=COMPLETELY_THREADSAFE) public interface FailureSASLBindResult extends SASLBindResult
This interface may be used to obtain information about the result of processing a SASL bind operation in which the authentication attempt failed.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAuthenticationFailureReason()
Retrieves a message with potentially detailed information about the reason for the authentication failure.java.lang.String
getUnsuccessfullyAuthenticatedUserDN()
Retrieves the DN of the user that tried to authenticate but was unable to do so successfully, if known.-
Methods inherited from interface com.unboundid.directory.sdk.ds.types.SASLBindResult
getBindResult, getBindResultType
-
-
-
-
Method Detail
-
getAuthenticationFailureReason
java.lang.String getAuthenticationFailureReason()
Retrieves a message with potentially detailed information about the reason for the authentication failure. This message will not be included in the response to the client, but may be included in the server access log in order to help administrators better understand the failure.- Returns:
- A message with potentially detailed information about the reason for the authentication failure.
-
getUnsuccessfullyAuthenticatedUserDN
java.lang.String getUnsuccessfullyAuthenticatedUserDN()
Retrieves the DN of the user that tried to authenticate but was unable to do so successfully, if known.- Returns:
- The DN of the user that tried to authenticate but was unable to
do so successfully, or
null
if the identity of the user is not known.
-
-