001    /*
002     * Copyright 2014-2016 UnboundID Corp.
003     * All Rights Reserved.
004     */
005    /*
006     * Copyright (C) 2014-2016 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.listener.interceptor;
022    
023    
024    
025    import com.unboundid.ldap.sdk.CompareRequest;
026    import com.unboundid.ldap.sdk.ReadOnlyCompareRequest;
027    import com.unboundid.util.NotExtensible;
028    import com.unboundid.util.ThreadSafety;
029    import com.unboundid.util.ThreadSafetyLevel;
030    
031    
032    
033    /**
034     * This class provides an API that can be used in the course of processing a
035     * compare request via the {@link InMemoryOperationInterceptor} API.
036     */
037    @NotExtensible()
038    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
039    public interface InMemoryInterceptedCompareRequest
040           extends InMemoryInterceptedRequest
041    {
042      /**
043       * Retrieves the compare request to be processed.
044       *
045       * @return  The compare request to be processed.
046       */
047      ReadOnlyCompareRequest getRequest();
048    
049    
050    
051      /**
052       * Replaces the compare request to be processed.
053       *
054       * @param  compareRequest  The compare request that should be processed
055       *                         instead of the one that was originally received
056       *                         from the client.  It must not be {@code null}.
057       */
058      void setRequest(final CompareRequest compareRequest);
059    }