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