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.Entry;
041import com.unboundid.ldap.sdk.LDAPException;
042import com.unboundid.ldap.sdk.ReadOnlySearchRequest;
043import com.unboundid.ldap.sdk.SearchRequest;
044import com.unboundid.ldap.sdk.SearchResultReference;
045import com.unboundid.util.NotExtensible;
046import com.unboundid.util.NotNull;
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 * search request via the {@link InMemoryOperationInterceptor} API.
055 */
056@NotExtensible()
057@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
058public interface InMemoryInterceptedSearchRequest
059       extends InMemoryInterceptedRequest
060{
061  /**
062   * Retrieves the search request to be processed.
063   *
064   * @return  The search request to be processed.
065   */
066  @NotNull()
067  ReadOnlySearchRequest getRequest();
068
069
070
071  /**
072   * Replaces the search request to be processed.
073   *
074   * @param  searchRequest  The search request that should be processed
075   *                        instead of the one that was originally received
076   *                        from the client.  It must not be {@code null}.
077   */
078  void setRequest(@NotNull SearchRequest searchRequest);
079
080
081
082  /**
083   * Sends the provided search result entry to the client.  It will be processed
084   * by the {@link InMemoryOperationInterceptor#processSearchEntry} method of
085   * all registered operation interceptors.
086   *
087   * @param  entry  The search result entry to be returned to the client.  It
088   *                must not be {@code null}.  If the provided entry is a
089   *                {@code SearchResultEntry}, then it may optionally include
090   *                one or more controls to provide to the client.  If it is any
091   *                other type of {@code Entry}, then it will not include any
092   *                controls.
093   *
094   * @throws  LDAPException  If a problem is encountered while trying to send
095   *                         the search result entry.
096   */
097  void sendSearchEntry(@NotNull Entry entry)
098       throws LDAPException;
099
100
101
102  /**
103   * Sends the provided search result reference to the client.  It will be
104   * processed by the
105   * {@link InMemoryOperationInterceptor#processSearchReference} method of all
106   * registered operation interceptors.
107   *
108   * @param  reference  The search result reference to be returned to the
109   *                    client.  It must not be {@code null}.
110   *
111   * @throws  LDAPException  If a problem is encountered while trying to send
112   *                         the search result reference.
113   */
114  void sendSearchReference(@NotNull SearchResultReference reference)
115       throws LDAPException;
116}