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