001/*
002 * Copyright 2014-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2014-2022 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-2022 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.ReadOnlySearchRequest;
041import com.unboundid.ldap.sdk.SearchResultReference;
042import com.unboundid.util.NotExtensible;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.Nullable;
045import com.unboundid.util.ThreadSafety;
046import com.unboundid.util.ThreadSafetyLevel;
047
048
049
050/**
051 * This class provides an API that can be used in the course of processing a
052 * search request via the {@link InMemoryOperationInterceptor} API.
053 */
054@NotExtensible()
055@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
056public interface InMemoryInterceptedSearchReference
057       extends InMemoryInterceptedResult
058{
059  /**
060   * Retrieves the search request that is being processed.  If the request was
061   * altered between the time it was received from the client and the time it
062   * was actually processed by the in-memory directory server, then this will be
063   * the most recently altered version.
064   *
065   * @return  The search request that was processed.
066   */
067  @NotNull()
068  ReadOnlySearchRequest getRequest();
069
070
071
072  /**
073   * Retrieves the search result reference to be returned to the client.
074   *
075   * @return  The search result reference to be returned to the client.
076   */
077  @Nullable()
078  SearchResultReference getSearchReference();
079
080
081
082  /**
083   * Replaces the search result reference to be returned to the client.  It may
084   * be {@code null} if the reference should be suppressed rather than being
085   * returned to the client.
086   *
087   * @param  reference  The search result reference to be returned to the
088   *                    client.  It may be {@code null} if the reference should
089   *                    be suppressed rather than being returned to the client.
090   */
091  void setSearchReference(@Nullable SearchResultReference reference);
092}