001/*
002 * Copyright 2008-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2008-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) 2008-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 com.unboundid.util.Extensible;
041import com.unboundid.util.NotNull;
042import com.unboundid.util.ThreadSafety;
043import com.unboundid.util.ThreadSafetyLevel;
044
045
046
047/**
048 * This interface provides a mechanism for notifying a client when the search
049 * result done message for an asynchronous search operation has been received.
050 */
051@Extensible()
052@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
053public interface AsyncSearchResultListener
054       extends SearchResultListener
055{
056  /**
057   * Indicates that the provided search result has been received in response to
058   * an asynchronous search operation.  Note that automatic referral following
059   * is not supported for asynchronous operations, so it is possible that this
060   * result could include a referral.
061   *
062   * @param  requestID     The async request ID of the request for which the
063   *                       response was received.
064   * @param  searchResult  The search result that has been received.
065   */
066  void searchResultReceived(@NotNull AsyncRequestID requestID,
067                            @NotNull SearchResult searchResult);
068}