001/*
002 * Copyright 2010-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2010-2024 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) 2010-2024 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;
037
038
039
040import com.unboundid.ldap.protocol.SearchResultEntryProtocolOp;
041import com.unboundid.ldap.sdk.Control;
042import com.unboundid.util.Extensible;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.Nullable;
045import com.unboundid.util.ThreadSafety;
046import com.unboundid.util.ThreadSafetyLevel;
047import com.unboundid.util.ObjectPair;
048
049
050
051/**
052 * This interface may be implemented by a class which wishes to intercept and
053 * alter search result entries in some way before they are returned to the
054 * client, and/or to prevent them from being returned altogether.  Search entry
055 * transformers may be enabled or disabled by adding them to or removing them
056 * from an {@link LDAPListenerClientConnection}.
057 */
058@Extensible()
059@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
060public interface SearchEntryTransformer
061{
062  /**
063   * Transforms the provided search result entry and/or set of controls to alter
064   * what will be returned to the client.
065   *
066   * @param  messageID  The message ID for the associated search operation.
067   * @param  entry      The search result entry to be processed.  It will not be
068   *                    {@code null}.
069   * @param  controls   The set of controls to be processed.  It will not be
070   *                    {@code null} but may be empty if there are no controls.
071   *
072   * @return  An {@link ObjectPair} containing a possibly updated entry and set
073   *          of controls, or {@code null} to indicate that the entry should not
074   *          be returned to the client.
075   */
076  @Nullable()
077  ObjectPair<SearchResultEntryProtocolOp,Control[]> transformEntry(
078       int messageID, @NotNull SearchResultEntryProtocolOp entry,
079       @NotNull Control[] controls);
080}