001/*
002 * Copyright 2023-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2023-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) 2023-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 obtain a
049 * {@link FullLDAPInterface} (e.g., a connection pool) that may be used for the
050 * purpose of following a referral.  When configured with a
051 * {@code ReusableReferralConnector} rather than a base
052 * {@link ReferralConnector}, one of the methods in this class will be used in
053 * preference to the {@link ReferralConnector#getReferralConnection} method.
054 */
055@Extensible()
056@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
057public interface ReusableReferralConnector
058       extends ReferralConnector
059{
060  /**
061   * Retrieves a {@link FullLDAPInterface} for use in following a referral
062   * returned in the provided result.  The caller must not do anything to
063   * attempt to leave the interface in an unusable state (e.g., closing a
064   * connection or connection pool).
065   *
066   * @param  referralURL  The LDAP URL for the referral to follow.  It must not
067   *                      be {@code null}.
068   * @param  connection   The connection on which the referral was received.  It
069   *                      will not be {@code null}.
070   *
071   * @return  A {@link FullLDAPInterface} for use in following a referral with
072   *          the given URL.
073   *
074   * @throws  LDAPException  If a problem occurs while obtaining the
075   *                         {@code FullLDAPInterface} to use for following the
076   *                         referral.
077   */
078  @NotNull()
079  FullLDAPInterface getReferralInterface(@NotNull LDAPURL referralURL,
080                                         @NotNull LDAPConnection connection)
081       throws LDAPException;
082}