001/* 002 * Copyright 2010-2024 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2010-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) 2010-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.listener; 037 038 039 040import java.net.Socket; 041 042import com.unboundid.ldap.sdk.LDAPException; 043import com.unboundid.util.Extensible; 044import com.unboundid.util.NotNull; 045import com.unboundid.util.Nullable; 046import com.unboundid.util.ThreadSafety; 047import com.unboundid.util.ThreadSafetyLevel; 048 049 050 051/** 052 * This interface defines an API that may be implemented by a class that should 053 * be notified whenever a problem occurs with the LDAP listener or any of its 054 * associated connections in a manner that may not be directly visible to the 055 * caller. 056 */ 057@Extensible() 058@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE) 059public interface LDAPListenerExceptionHandler 060{ 061 /** 062 * Indicates that the specified connection is about to be terminated because 063 * an unexpected error occurred during processing. 064 * 065 * @param socket The socket to be used for the failed connection. It may be 066 * {@code null} if the failure occurred while attempting to 067 * accept the socket rather than attempting to create the 068 * client connection from an accepted socket. 069 * @param cause An exception providing additional information about the 070 * problem that occurred. It will not be {@code null}. 071 */ 072 void connectionCreationFailure(@Nullable Socket socket, 073 @NotNull Throwable cause); 074 075 076 077 /** 078 * Indicates that the specified connection is about to be terminated because 079 * an unexpected error occurred during processing. 080 * 081 * @param connection The connection that will be terminated. It will not be 082 * {@code null}. 083 * @param cause An exception providing additional information about the 084 * reason for the termination. It will not be 085 * {@code null}. 086 */ 087 void connectionTerminated(@NotNull LDAPListenerClientConnection connection, 088 @NotNull LDAPException cause); 089}