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-2017 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.proxy.internal;
028
029
030
031import com.unboundid.ldap.sdk.SearchResultEntry;
032import com.unboundid.ldap.sdk.SearchResultReference;
033import com.unboundid.util.NotExtensible;
034import com.unboundid.util.ThreadSafety;
035import com.unboundid.util.ThreadSafetyLevel;
036
037
038
039/**
040 * This interface defines a set of methods that may be used to cause the
041 * Directory Proxy Server to send search result entries and/or references to
042 * the client in the course of processing a proxy transformation.
043 */
044@NotExtensible()
045@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
046public interface SearchResultProvider
047{
048  /**
049   * Attempts to return the provided search result entry to the client.
050   *
051   * @param  entry                 The entry to return to the client.
052   * @param  applyTransformations  Indicates whether to apply any configured
053   *                               proxy transformations to the entry before
054   *                               returning it to the client.
055   *
056   * @return  {@code true} if the caller may attempt to send additional entries
057   *          or references to the client if desired, or {@code false} if not
058   *          (e.g., because the size limit or time limit has been exceeded, or
059   *          because the connection has been closed).
060   */
061  boolean sendEntry(final SearchResultEntry entry,
062                    final boolean applyTransformations);
063
064
065
066  /**
067   * Attempts to return the provided search result reference to the client.
068   *
069   * @param  reference             The reference to return to the client.
070   * @param  applyTransformations  Indicates whether to apply any configured
071   *                               proxy transformations to the reference before
072   *                               returning it to the client.
073   *
074   * @return  {@code true} if the caller may attempt to send additional entries
075   *          or references to the client if desired, or {@code false} if not
076   *          (e.g., because the size limit or time limit has been exceeded, or
077   *          because the connection has been closed).
078   */
079  boolean sendReference(final SearchResultReference reference,
080                        final boolean applyTransformations);
081}