001    /*
002     * Copyright 2010-2015 UnboundID Corp.
003     * All Rights Reserved.
004     */
005    /*
006     * Copyright (C) 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.unboundidds.extensions;
022    
023    
024    
025    import com.unboundid.ldap.sdk.IntermediateResponse;
026    import com.unboundid.util.Extensible;
027    import com.unboundid.util.ThreadSafety;
028    import com.unboundid.util.ThreadSafetyLevel;
029    
030    
031    
032    /**
033     * <BLOCKQUOTE>
034     *   <B>NOTE:</B>  This class is part of the Commercial Edition of the UnboundID
035     *   LDAP SDK for Java.  It is not available for use in applications that
036     *   include only the Standard Edition of the LDAP SDK, and is not supported for
037     *   use in conjunction with non-UnboundID products.
038     * </BLOCKQUOTE>
039     * This interface defines a set of methods that will be invoked when an
040     * intermediate response is returned in the course of processing a get changelog
041     * batch extended operation.  It may be used to process changelog entries as
042     * they are returned by the server rather than accessing them in a list when the
043     * extended result has been received.
044     */
045    @Extensible()
046    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
047    public interface ChangelogEntryListener
048    {
049      /**
050       * Performs any processing necessary for a changelog entry intermediate
051       * response returned by the server.
052       *
053       * @param  ir  The changelog entry intermediate response that was returned by
054       *            the server.
055       */
056      void handleChangelogEntry(final ChangelogEntryIntermediateResponse ir);
057    
058    
059    
060      /**
061       * Performs any processing necessary for a missing changelog entries
062       * intermediate response returned by the server.
063       *
064       * @param  ir  The missing changelog entries intermediate response that was
065       *             returned by the server.
066       */
067      void handleMissingChangelogEntries(
068                final MissingChangelogEntriesIntermediateResponse ir);
069    
070    
071    
072      /**
073       * Performs any processing necessary for some other type of intermediate
074       * response returned during processing for a get changelog batch extended
075       * operation.  This method may do nothing if this implementation does not
076       * provide support for any other types of intermediate responses.
077       *
078       * @param  ir  The generic entry intermediate response that was returned by
079       *             the server.
080       */
081      void handleOtherIntermediateResponse(final IntermediateResponse ir);
082    }