001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2012-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.ds.types;
028
029
030
031import com.unboundid.util.NotExtensible;
032import com.unboundid.util.ThreadSafety;
033import com.unboundid.util.ThreadSafetyLevel;
034
035
036
037/**
038 * This interface may be used to obtain information about the result of
039 * processing a SASL bind operation in which the authentication attempt failed.
040 */
041@NotExtensible()
042@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
043public interface FailureSASLBindResult
044       extends SASLBindResult
045{
046  /**
047   * Retrieves a message with potentially detailed information about the reason
048   * for the authentication failure.  This message will not be included in the
049   * response to the client, but may be included in the server access log in
050   * order to help administrators better understand the failure.
051   *
052   * @return  A message with potentially detailed information about the reason
053   *          for the authentication failure.
054   */
055  String getAuthenticationFailureReason();
056
057
058
059  /**
060   * Retrieves the DN of the user that tried to authenticate but was unable to
061   * do so successfully, if known.
062   *
063   * @return  The DN of the user that tried to authenticate but was unable to
064   *          do so successfully, or {@code null} if the identity of the user is
065   *          not known.
066   */
067  String getUnsuccessfullyAuthenticatedUserDN();
068}