001/*
002 * Copyright 2009-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-2022 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2009-2022 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.migrate.ldapjdk;
037
038
039
040import com.unboundid.util.Extensible;
041import com.unboundid.util.NotNull;
042import com.unboundid.util.ThreadSafety;
043import com.unboundid.util.ThreadSafetyLevel;
044
045
046
047/**
048 * This interface defines a method that can be used to bind to a server when
049 * following a referral.
050 * <BR><BR>
051 * This class is primarily intended to be used in the process of updating
052 * applications which use the Netscape Directory SDK for Java to switch to or
053 * coexist with the UnboundID LDAP SDK for Java.  For applications not written
054 * using the Netscape Directory SDK for Java, the
055 * {@link com.unboundid.ldap.sdk.ReferralConnector} class should be used
056 * instead.
057 */
058@Extensible()
059@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
060public interface LDAPBind
061{
062  /**
063   * Authenticates the provided connection created for the purpose of following
064   * a referral.
065   *
066   * @param  conn  The connection to be authenticated.
067   *
068   * @throws  LDAPException  If a problem occurs while processing the bind.
069   */
070  void bind(@NotNull LDAPConnection conn)
071       throws LDAPException;
072}