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-2017 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.operation;
028
029
030
031import com.unboundid.ldap.sdk.DN;
032import com.unboundid.util.ByteString;
033import com.unboundid.util.NotExtensible;
034import com.unboundid.util.ThreadSafety;
035import com.unboundid.util.ThreadSafetyLevel;
036
037
038
039/**
040 * This interface defines a set of methods which may be used to update a simple
041 * bind request.
042 */
043@NotExtensible()
044@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
045public interface UpdatableSimpleBindRequest
046       extends SimpleBindRequest, UpdatableBindRequest
047{
048  /**
049   * Specifies the DN of the user attempting to bind.
050   *
051   * @param  dn  The DN of the user that is trying to authenticate.  It must not
052   *             be {@code null}, but it may be an empty string to indicate a
053   *             zero-length DN.
054   */
055  void setDN(final String dn);
056
057
058
059  /**
060   * Specifies the DN of the user attempting to bind.
061   *
062   * @param  dn  The DN of the user that is trying to authenticate.  It must not
063   *             be {@code null}, but it may be an empty string to indicate a
064   *             zero-length DN.
065   */
066  void setDN(final DN dn);
067
068
069
070  /**
071   * Specifies the password for the bind request.
072   *
073   * @param  password  The password for the bind request.  It must not be
074   *                   {@code null} but may be a zero-length byte string  for
075   *                   anonymous authentication.
076   */
077  void setPassword(final ByteString password);
078
079
080
081  /**
082   * Specifies the password for the bind request.
083   *
084   * @param  password  The password for the bind request.  It must not be
085   *                   {@code null} but may be a zero-length byte string  for
086   *                   anonymous authentication.
087   */
088  void setPassword(final String password);
089}