com.unboundid.ldap.sdk.PostConnectProcessor Maven / Gradle / Ivy
/*
* Copyright 2007-2019 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2008-2019 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk;
import com.unboundid.util.Extensible;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This interface provides the ability to perform custom processing immediately
* after creating an LDAP connection for use in a connection pool. It may be
* used, for example, to perform StartTLS negotiation on the connection before
* it is made available for use in the pool.
*
* Implementations of this interface must be threadsafe to allow for the
* possibility of performing post-connect processing on different connections
* at the same time in separate threads.
*/
@Extensible()
@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
public interface PostConnectProcessor
{
/**
* Performs any appropriate processing on the provided connection before
* making it available for use in a connection pool. This method will be
* invoked immediately after the connection has been established but before
* any attempt has been made to perform any authentication.
*
* @param connection The connection for which the processing is to be
* performed.
*
* @throws LDAPException If a problem occurs during processing. If an
* exception is thrown, then the connection will be
* terminated and not used in the pool.
*/
void processPreAuthenticatedConnection(LDAPConnection connection)
throws LDAPException;
/**
* Performs any appropriate processing on the provided connection before
* making it available for use in a connection pool. This method will be
* invoked immediately after any appropriate authentication has been performed
* on the connection.
*
* @param connection The connection for which the processing is to be
* performed.
*
* @throws LDAPException If a problem occurs during processing. If an
* exception is thrown, then the connection will be
* terminated and not used in the pool.
*/
void processPostAuthenticatedConnection(LDAPConnection connection)
throws LDAPException;
}