001/* 002 * Copyright 2009-2024 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2009-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) 2009-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 java.io.Serializable; 041 042import com.unboundid.util.Extensible; 043import com.unboundid.util.NotNull; 044import com.unboundid.util.ThreadSafety; 045import com.unboundid.util.ThreadSafetyLevel; 046 047 048 049/** 050 * This interface defines a method that may be used to process intermediate 051 * response messages that are returned to the client while processing an 052 * operation. If an operation may return intermediate response messages, then 053 * an intermediate response listener must be registered with the associated 054 * request (via the {@link LDAPRequest#setIntermediateResponseListener} method) 055 * in order to be able to access the intermediate response messages. 056 * 057 * @see IntermediateResponse 058 */ 059@Extensible() 060@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 061public interface IntermediateResponseListener 062 extends Serializable 063{ 064 /** 065 * Indicates that the provided intermediate response has been returned by the 066 * server and may be processed by this intermediate response listener. 067 * 068 * @param intermediateResponse The intermediate response that has been 069 * returned by the server. 070 */ 071 void intermediateResponseReturned( 072 @NotNull IntermediateResponse intermediateResponse); 073}