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.asn1.ASN1OctetString;
032import com.unboundid.util.NotExtensible;
033import com.unboundid.util.ThreadSafety;
034import com.unboundid.util.ThreadSafetyLevel;
035
036
037
038/**
039 * This interface may be used to obtain information about the result of
040 * processing a SASL bind operation in which a user has successfully completed
041 * the authentication process.
042 */
043@NotExtensible()
044@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
045public interface SuccessSASLBindResult
046       extends SASLBindResult
047{
048  /**
049   * Retrieves the DN of the user that was successfully authenticated.
050   *
051   * @return  The DN of the user that was successfully authenticated, or
052   *          an empty string if the authentication was anonymous.
053   */
054  String getAuthenticatedUserDN();
055
056
057
058  /**
059   * Retrieves the DN of the authorization identity resulting from the bind.
060   *
061   * @return  The DN of the authorization identity resulting from the bind, or
062   *          an empty string if the authorization identity should be anonymous.
063   */
064  String getAuthorizedUserDN();
065
066
067
068  /**
069   * Retrieves the plaintext representation of the password used to
070   * authenticate, if available.
071   *
072   * @return  The plaintext representation of the password used to authenticate,
073   *          or {@code null} if this is not available or applicable.
074   */
075  ASN1OctetString getPasswordUsed();
076}