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 * Portions Copyright 2010-2023 Ping Identity Corporation 026 */ 027package com.unboundid.directory.sdk.common.operation; 028 029 030 031import com.unboundid.asn1.ASN1OctetString; 032import com.unboundid.ldap.sdk.DN; 033import com.unboundid.util.ByteString; 034import com.unboundid.util.NotExtensible; 035import com.unboundid.util.ThreadSafety; 036import com.unboundid.util.ThreadSafetyLevel; 037 038 039 040/** 041 * This interface defines a set of methods which may be used to update a SASL 042 * bind request. 043 */ 044@NotExtensible() 045@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 046public interface UpdatableSASLBindRequest 047 extends SASLBindRequest, UpdatableBindRequest 048{ 049 /** 050 * Specifies the SASL credentials for the bind request, if any. 051 * 052 * @param saslMechanism The name of the SASL mechanism to use. It must 053 * not be {@code null}. 054 * @param saslCredentials The SASL credentials for the bind request. It may 055 * be {@code null} if no credentials should be used. 056 */ 057 void setSASLCredentials(final String saslMechanism, 058 final ASN1OctetString saslCredentials); 059 060 061 062 /** 063 * Converts this SASL bind request to a simple bind request. After invoking 064 * this method, the caller should not make any further attempt to access this 065 * SASL bind request object, but should only interact with the 066 * {@link UpdatableSimpleBindRequest} object that is returned. 067 * 068 * @param dn The DN to use for the simple bind request. It must not 069 * be {@code null} but may be empty for anonymous simple 070 * authentication (in which case the password must also be 071 * empty). 072 * @param password The password to use for the simple bind request. It 073 * must not be {@code null} but may be empty for anonymous 074 * simple authentication (in which case the DN must also be 075 * empty). 076 * 077 * @return The {@code UpdatableSimpleBindRequest} that was created and will 078 * be used for the operation going forward. 079 */ 080 UpdatableSimpleBindRequest convertToSimpleBindRequest(final DN dn, 081 final ByteString password); 082}