001 /* 002 * Copyright 2009-2015 UnboundID Corp. 003 * All Rights Reserved. 004 */ 005 /* 006 * Copyright (C) 2009-2015 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 */ 021 package com.unboundid.ldap.sdk; 022 023 024 025 import java.io.Serializable; 026 027 028 029 030 /** 031 * This interface defines a method that may be used to process intermediate 032 * response messages that are returned to the client while processing an 033 * operation. If an operation may return intermediate response messages, then 034 * an intermediate response listener must be registered with the associated 035 * request (via the {@code LDAPRequest#setIntermediateResponseListener} method) 036 * in order to be able to access the intermediate response messages. 037 * 038 * @see IntermediateResponse 039 */ 040 public interface IntermediateResponseListener 041 extends Serializable 042 { 043 /** 044 * Indicates that the provided intermediate response has been returned by the 045 * server and may be processed by this intermediate response listener. 046 * 047 * @param intermediateResponse The intermediate response that has been 048 * returned by the server. 049 */ 050 void intermediateResponseReturned( 051 final IntermediateResponse intermediateResponse); 052 }