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 2010-2019 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.operation;
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 defines a set of methods which may be used to interact with a
040 * SASL bind request.
041 */
042@NotExtensible()
043@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
044public interface SASLBindRequest
045       extends BindRequest
046{
047  /**
048   * Retrieves the name of the SASL mechanism to use.
049   *
050   * @return  The name of the SASL mechanism to use.
051   */
052  String getSASLMechanism();
053
054
055
056  /**
057   * Retrieves the SASL credentials for the bind request, if any.
058   *
059   * @return  The SASL credentials for the bind request, or {@code null} if
060   *          there are none.
061   */
062  ASN1OctetString getSASLCredentials();
063
064
065
066  /**
067   * Retrieves an LDAP SDK representation of this SASL bind request.
068   *
069   * @return  An LDAP SDK representation of this SASL bind request.
070   */
071  com.unboundid.ldap.sdk.SASLBindRequest toLDAPSDKRequest();
072}