001/*
002 * Copyright 2014-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2014-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) 2014-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.listener.interceptor;
037
038
039
040import com.unboundid.ldap.sdk.IntermediateResponse;
041import com.unboundid.ldap.sdk.LDAPException;
042import com.unboundid.ldap.sdk.LDAPResult;
043import com.unboundid.ldap.sdk.ReadOnlyCompareRequest;
044import com.unboundid.util.NotExtensible;
045import com.unboundid.util.NotNull;
046import com.unboundid.util.Nullable;
047import com.unboundid.util.ThreadSafety;
048import com.unboundid.util.ThreadSafetyLevel;
049
050
051
052/**
053 * This class provides an API that can be used in the course of processing a
054 * compare request via the {@link InMemoryOperationInterceptor} API.
055 */
056@NotExtensible()
057@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
058public interface InMemoryInterceptedCompareResult
059       extends InMemoryInterceptedResult
060{
061  /**
062   * Retrieves the compare request that was processed.  If the request was
063   * altered between the time it was received from the client and the time it
064   * was actually processed by the in-memory directory server, then this will be
065   * the most recently altered version.
066   *
067   * @return  The compare request that was processed.
068   */
069  @NotNull()
070  ReadOnlyCompareRequest getRequest();
071
072
073
074  /**
075   * Retrieves the compare result to be returned to the client.
076   *
077   * @return  The compare result to be returned to the client.
078   */
079  @Nullable()
080  LDAPResult getResult();
081
082
083
084  /**
085   * Replaces the compare result to be returned to the client.
086   *
087   * @param  compareResult  The compare result that should be returned to the
088   *                        client instead of the result originally generated by
089   *                        the in-memory directory server.  It must not be
090   *                        {@code null}.
091   */
092  void setResult(@NotNull LDAPResult compareResult);
093
094
095
096  /**
097   * Sends the provided intermediate response message to the client.  It will
098   * be processed by the
099   * {@link InMemoryOperationInterceptor#processIntermediateResponse} method of
100   * all registered operation interceptors.
101   *
102   * @param  intermediateResponse  The intermediate response to send to the
103   *                               client.  It must not be {@code null}.
104   *
105   * @throws  LDAPException  If a problem is encountered while trying to send
106   *                         the intermediate response.
107   */
108  void sendIntermediateResponse(
109            @NotNull IntermediateResponse intermediateResponse)
110       throws LDAPException;
111}