001/*
002 * Copyright 2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2020 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) 2020 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.unboundidds.extensions;
037
038
039
040import com.unboundid.ldap.sdk.IntermediateResponse;
041import com.unboundid.util.Extensible;
042import com.unboundid.util.ThreadSafety;
043import com.unboundid.util.ThreadSafetyLevel;
044
045
046
047/**
048 * This interface provide an API that may be used to handle intermediate
049 * response messages returned as part of processing for an
050 * {@link CollectSupportDataExtendedRequest}.  It provides specific support for
051 * the {@link CollectSupportDataOutputIntermediateResponse} and
052 * {@link CollectSupportDataArchiveFragmentIntermediateResponse} intermediate
053 * response types, but also allows handling other types of intermediate
054 * responses as well.
055 * <BR>
056 * <BLOCKQUOTE>
057 *   <B>NOTE:</B>  This class, and other classes within the
058 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
059 *   supported for use against Ping Identity, UnboundID, and
060 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
061 *   for proprietary functionality or for external specifications that are not
062 *   considered stable or mature enough to be guaranteed to work in an
063 *   interoperable way with other types of LDAP servers.
064 * </BLOCKQUOTE>
065 *
066 * @see  CollectSupportDataExtendedRequest
067 * @see  CollectSupportDataExtendedResult
068 * @see  CollectSupportDataArchiveFragmentIntermediateResponse
069 * @see  CollectSupportDataOutputIntermediateResponse
070 */
071@Extensible()
072@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
073public interface CollectSupportDataIntermediateResponseListener
074{
075  /**
076   * Performs any processing that may be necessary for the provided collect
077   * support data output intermediate response.
078   *
079   * @param  response  The collect support data output intermediate response to
080   *                   be processed.  It must not be {@code null}.
081   */
082  void handleOutputIntermediateResponse(
083            CollectSupportDataOutputIntermediateResponse response);
084
085
086
087  /**
088   * Performs any processing that may be necessary for the provided collect
089   * support data archive fragment intermediate response.
090   *
091   * @param  response  The collect support data archive fragment intermediate
092   *                   response to be processed.  It must not be {@code null}.
093   */
094  void handleArchiveFragmentIntermediateResponse(
095            CollectSupportDataArchiveFragmentIntermediateResponse response);
096
097
098
099  /**
100   * Performs any processing that may be necessary for any other type of
101   * intermediate response that may be returned in response to a
102   * {@link CollectSupportDataExtendedRequest}.
103   *
104   * @param  response  The generic intermediate response to be processed.  It
105   *                   must not be {@code null}.
106   */
107  void handleOtherIntermediateResponse(IntermediateResponse response);
108}