001/*
002 * Copyright 2007-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2007-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) 2007-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;
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 provides the ability to perform custom processing immediately
049 * after creating an LDAP connection for use in a connection pool.  It may be
050 * used, for example, to perform StartTLS negotiation on the connection before
051 * it is made available for use in the pool.
052 * <BR><BR>
053 * Implementations of this interface must be threadsafe to allow for the
054 * possibility of performing post-connect processing on different connections
055 * at the same time in separate threads.
056 */
057@Extensible()
058@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
059public interface PostConnectProcessor
060{
061  /**
062   * Performs any appropriate processing on the provided connection before
063   * making it available for use in a connection pool.  This method will be
064   * invoked immediately after the connection has been established but before
065   * any attempt has been made to perform any authentication.
066   *
067   * @param  connection  The connection for which the processing is to be
068   *                     performed.
069   *
070   * @throws  LDAPException  If a problem occurs during processing.  If an
071   *                         exception is thrown, then the connection will be
072   *                         terminated and not used in the pool.
073   */
074  void processPreAuthenticatedConnection(@NotNull LDAPConnection connection)
075       throws LDAPException;
076
077
078
079  /**
080   * Performs any appropriate processing on the provided connection before
081   * making it available for use in a connection pool.  This method will be
082   * invoked immediately after any appropriate authentication has been performed
083   * on the connection.
084   *
085   * @param  connection  The connection for which the processing is to be
086   *                     performed.
087   *
088   * @throws  LDAPException  If a problem occurs during processing.  If an
089   *                         exception is thrown, then the connection will be
090   *                         terminated and not used in the pool.
091   */
092  void processPostAuthenticatedConnection(@NotNull LDAPConnection connection)
093       throws LDAPException;
094}