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.ReadOnlySearchRequest; 042import com.unboundid.ldap.sdk.SearchResultEntry; 043import com.unboundid.util.NotExtensible; 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 a 051 * search request via the {@link InMemoryOperationInterceptor} API. 052 */ 053@NotExtensible() 054@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 055public interface InMemoryInterceptedSearchEntry 056 extends InMemoryInterceptedResult 057{ 058 /** 059 * Retrieves the search request that is being processed. If the request was 060 * altered between the time it was received from the client and the time it 061 * was actually processed by the in-memory directory server, then this will be 062 * the most recently altered version. 063 * 064 * @return The search request that was processed. 065 */ 066 ReadOnlySearchRequest getRequest(); 067 068 069 070 /** 071 * Retrieves the search result entry to be returned to the client. 072 * 073 * @return The search result entry to be returned to the client. 074 */ 075 SearchResultEntry getSearchEntry(); 076 077 078 079 /** 080 * Replaces the search result entry to be returned to the client. It may be 081 * {@code null} if the entry should be suppressed rather than being returned 082 * to the client. If the provided entry is a {@code SearchResultEntry}, then 083 * it may optionally include one or more controls to provide to the client. 084 * If it is any other type of {@code Entry}, then it will not include any 085 * controls. 086 * 087 * @param entry The search result entry to be returned to the client. It 088 * may be {@code null} if the entry should be suppressed rather 089 * than being returned to the client. If the provided entry is 090 * a {@code SearchResultEntry}, then it may optionally include 091 * one or more controls to provide to the client. If it is any 092 * other type of {@code Entry}, then it will not include any 093 * controls. 094 */ 095 void setSearchEntry(Entry entry); 096}