001/* 002 * Copyright 2009-2017 UnboundID Corp. 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright (C) 2009-2017 UnboundID Corp. 007 * 008 * This program is free software; you can redistribute it and/or modify 009 * it under the terms of the GNU General Public License (GPLv2 only) 010 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only) 011 * as published by the Free Software Foundation. 012 * 013 * This program is distributed in the hope that it will be useful, 014 * but WITHOUT ANY WARRANTY; without even the implied warranty of 015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 016 * GNU General Public License for more details. 017 * 018 * You should have received a copy of the GNU General Public License 019 * along with this program; if not, see <http://www.gnu.org/licenses>. 020 */ 021package com.unboundid.ldap.sdk; 022 023 024 025import java.io.Serializable; 026 027import com.unboundid.util.Extensible; 028import com.unboundid.util.ThreadSafety; 029import com.unboundid.util.ThreadSafetyLevel; 030 031 032 033/** 034 * This interface defines a method that may be used to process intermediate 035 * response messages that are returned to the client while processing an 036 * operation. If an operation may return intermediate response messages, then 037 * an intermediate response listener must be registered with the associated 038 * request (via the {@link LDAPRequest#setIntermediateResponseListener} method) 039 * in order to be able to access the intermediate response messages. 040 * 041 * @see IntermediateResponse 042 */ 043@Extensible() 044@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 045public interface IntermediateResponseListener 046 extends Serializable 047{ 048 /** 049 * Indicates that the provided intermediate response has been returned by the 050 * server and may be processed by this intermediate response listener. 051 * 052 * @param intermediateResponse The intermediate response that has been 053 * returned by the server. 054 */ 055 void intermediateResponseReturned( 056 final IntermediateResponse intermediateResponse); 057}