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.sdk.unboundidds.extensions;
037
038
039
040import com.unboundid.ldap.sdk.IntermediateResponse;
041import com.unboundid.util.Extensible;
042import com.unboundid.util.NotNull;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This interface defines a set of methods that will be invoked when an
050 * intermediate response is returned in the course of processing a get changelog
051 * batch extended operation.  It may be used to process changelog entries as
052 * they are returned by the server rather than accessing them in a list when the
053 * extended result has been received.
054 * <BR>
055 * <BLOCKQUOTE>
056 *   <B>NOTE:</B>  This class, and other classes within the
057 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
058 *   supported for use against Ping Identity, UnboundID, and
059 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
060 *   for proprietary functionality or for external specifications that are not
061 *   considered stable or mature enough to be guaranteed to work in an
062 *   interoperable way with other types of LDAP servers.
063 * </BLOCKQUOTE>
064 */
065@Extensible()
066@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
067public interface ChangelogEntryListener
068{
069  /**
070   * Performs any processing necessary for a changelog entry intermediate
071   * response returned by the server.
072   *
073   * @param  ir  The changelog entry intermediate response that was returned by
074   *            the server.
075   */
076  void handleChangelogEntry(@NotNull ChangelogEntryIntermediateResponse ir);
077
078
079
080  /**
081   * Performs any processing necessary for a missing changelog entries
082   * intermediate response returned by the server.
083   *
084   * @param  ir  The missing changelog entries intermediate response that was
085   *             returned by the server.
086   */
087  void handleMissingChangelogEntries(
088            @NotNull MissingChangelogEntriesIntermediateResponse ir);
089
090
091
092  /**
093   * Performs any processing necessary for some other type of intermediate
094   * response returned during processing for a get changelog batch extended
095   * operation.  This method may do nothing if this implementation does not
096   * provide support for any other types of intermediate responses.
097   *
098   * @param  ir  The generic entry intermediate response that was returned by
099   *             the server.
100   */
101  void handleOtherIntermediateResponse(@NotNull IntermediateResponse ir);
102}