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.IntermediateResponse;
042import com.unboundid.ldap.sdk.LDAPException;
043import com.unboundid.ldap.sdk.LDAPResult;
044import com.unboundid.ldap.sdk.ReadOnlySearchRequest;
045import com.unboundid.ldap.sdk.SearchResultReference;
046import com.unboundid.util.NotExtensible;
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 InMemoryInterceptedSearchResult
059       extends InMemoryInterceptedResult
060{
061  /**
062   * Retrieves the search 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 search request that was processed.
068   */
069  ReadOnlySearchRequest getRequest();
070
071
072
073  /**
074   * Retrieves the search result to be returned to the client.
075   *
076   * @return  The search result to be returned to the client.
077   */
078  LDAPResult getResult();
079
080
081
082  /**
083   * Replaces the search result to be returned to the client.
084   *
085   * @param  searchResult  The search result that should be returned to the
086   *                       client instead of the result originally generated by
087   *                       the in-memory directory server.  It must not be
088   *                       {@code null}.
089   */
090  void setResult(LDAPResult searchResult);
091
092
093
094  /**
095   * Sends the provided search result entry to the client.  It will be processed
096   * by the {@link InMemoryOperationInterceptor#processSearchEntry} method of
097   * all registered operation interceptors.
098   *
099   * @param  entry  The search result entry to be returned to the client.  It
100   *                must not be {@code null}.  If the provided entry is a
101   *                {@code SearchResultEntry}, then it may optionally include
102   *                one or more controls to provide to the client.  If it is any
103   *                other type of {@code Entry}, then it will not include any
104   *                controls.
105   *
106   * @throws  LDAPException  If a problem is encountered while trying to send
107   *                         the search result entry.
108   */
109  void sendSearchEntry(Entry entry)
110       throws LDAPException;
111
112
113
114  /**
115   * Sends the provided search result reference to the client.  It will be
116   * processed by the
117   * {@link InMemoryOperationInterceptor#processSearchReference} method of all
118   * registered operation interceptors.
119   *
120   * @param  reference  The search result reference to be returned to the
121   *                    client.  It must not be {@code null}.
122   *
123   * @throws  LDAPException  If a problem is encountered while trying to send
124   *                         the search result reference.
125   */
126  void sendSearchReference(SearchResultReference reference)
127       throws LDAPException;
128
129
130
131  /**
132   * Sends the provided intermediate response message to the client.  It will
133   * be processed by the
134   * {@link InMemoryOperationInterceptor#processIntermediateResponse} method of
135   * all registered operation interceptors.
136   *
137   * @param  intermediateResponse  The intermediate response to send to the
138   *                               client.  It must not be {@code null}.
139   *
140   * @throws  LDAPException  If a problem is encountered while trying to send
141   *                         the intermediate response.
142   */
143  void sendIntermediateResponse(IntermediateResponse intermediateResponse)
144         throws LDAPException;
145}