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.util.NotExtensible;
042import com.unboundid.util.NotNull;
043import com.unboundid.util.Nullable;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This class provides an API that can be used in the course of processing an
051 * intermediate response via the {@link InMemoryOperationInterceptor} API.
052 */
053@NotExtensible()
054@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
055public interface InMemoryInterceptedIntermediateResponse
056       extends InMemoryInterceptedResult
057{
058  /**
059   * Retrieves the request associated with the operation that is being
060   * processed.  If the request was altered between the time it was received
061   * from the client and the time it was actually processed by the in-memory
062   * directory server, then this will be the most recently altered version.
063   *
064   * @return  The request associated with the operation that is being processed.
065   */
066  @NotNull()
067  InMemoryInterceptedRequest getRequest();
068
069
070
071  /**
072   * Retrieves the intermediate response to be returned to the client.
073   *
074   * @return  The intermediate response to be returned to the client.
075   */
076  @Nullable()
077  IntermediateResponse getIntermediateResponse();
078
079
080
081  /**
082   * Replaces the intermediate response to be returned to the client.  It may be
083   * {@code null} if the response should be suppressed rather than being
084   * returned to the client.
085   *
086   * @param  response  The intermediate response to be returned to the client.
087   *                   It may be {@code null} if the response should be
088   *                   suppressed rather than being returned to the client.
089   */
090  void setIntermediateResponse(@Nullable IntermediateResponse response);
091}