001/*
002 * Copyright 2007-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2007-2024 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) 2007-2024 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;
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 an API that may be used to establish a connection
049 * (and perform authentication if appropriate) to a remote server when following
050 * a referral.
051 * <BR><BR>
052 * Implementations of this interface should be threadsafe to ensure that
053 * multiple connections will be able to safely use the same
054 * {@code ReferralConnector} instance.
055 */
056@Extensible()
057@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
058public interface ReferralConnector
059{
060  /**
061   * Retrieves an (optionally authenticated) LDAP connection for use in
062   * following a referral as defined in the provided LDAP URL.  The connection
063   * will automatically be closed after the referral has been followed.
064   *
065   * @param  referralURL  The LDAP URL representing the referral being followed.
066   * @param  connection   The connection on which the referral was received.
067   *
068   * @return  An LDAP connection established and optionally authenticated to the
069   *          target system that may be used to attempt to follow a referral.
070   *
071   * @throws  LDAPException  If a problem occurs while establishing the
072   *                         connection or performing authentication on it.  If
073   *                         an exception is thrown, then any underlying
074   *                         connection should be terminated before the
075   *                         exception is thrown.
076   */
077  @NotNull()
078  LDAPConnection getReferralConnection(@NotNull LDAPURL referralURL,
079                                       @NotNull LDAPConnection connection)
080                 throws LDAPException;
081}