001/*
002 * Copyright 2007-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2007-2023 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) 2007-2023 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.sdk;
037
038
039
040import java.io.Serializable;
041
042import com.unboundid.util.Extensible;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This interface defines a set of methods that provide search result entries
051 * and references to a requester as they are returned from the server.  It
052 * provides a memory-efficient mechanism for dealing with searches that match a
053 * large number of entries, as well as more timely processing for those that
054 * take a long time to complete and return entries sporadically over the
055 * duration of the search.
056 * <BR><BR>
057 * The {@link LDAPEntrySource} class implements this interface and may be used
058 * to provide access to the search results in an {@code Iterator}-like manner.
059 */
060@Extensible()
061@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
062public interface SearchResultListener
063       extends Serializable
064{
065  /**
066   * Indicates that the provided search result entry has been returned by the
067   * server and may be processed by this search result listener.
068   *
069   * @param  searchEntry  The search result entry that has been returned by the
070   *                      server.
071   */
072  void searchEntryReturned(@NotNull SearchResultEntry searchEntry);
073
074
075
076  /**
077   * Indicates that the provided search result reference has been returned by
078   * the server and may be processed by this search result listener.
079   *
080   * @param  searchReference  The search result reference that has been returned
081   *                          by the server.
082   */
083  void searchReferenceReturned(@NotNull SearchResultReference searchReference);
084}