001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2010-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.types;
028
029
030
031import com.unboundid.ldap.sdk.SearchResultEntry;
032import com.unboundid.ldap.sdk.SearchResultReference;
033import com.unboundid.ldap.sdk.LDAPException;
034import com.unboundid.util.NotExtensible;
035import com.unboundid.util.ThreadSafety;
036import com.unboundid.util.ThreadSafetyLevel;
037
038
039
040/**
041 * This interface defines a set of methods that may be used to obtain
042 * information about a search operation that is actively being processed and for
043 * which the final response has not yet been sent.
044 */
045@NotExtensible()
046@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
047public interface ActiveSearchOperationContext
048       extends ActiveOperationContext
049{
050  /**
051   * Attempts to send a search result entry to the client.
052   *
053   * @param  e  The entry to be returned to the client.
054   *
055   * @throws  LDAPException  If a problem occurs while attempting to send the
056   *                         entry and processing on the associated operation
057   *                         should be aborted.
058   */
059  void sendSearchEntry(final SearchResultEntry e)
060       throws LDAPException;
061
062
063
064  /**
065   * Attempts to send a search result reference to the client.
066   *
067   * @param  r  The reference to be returned to the client.
068   *
069   * @throws  LDAPException  If a problem occurs while attempting to send the
070   *                         reference and processing on the associated
071   *                         operation should be aborted.
072   */
073  void sendSearchReference(final SearchResultReference r)
074       throws LDAPException;
075}