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 2016-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.broker.types;
028
029import com.fasterxml.jackson.databind.node.ObjectNode;
030import com.unboundid.scim2.common.filters.Filter;
031
032/**
033 * Request context for the method called for each entry found during a search
034 * in the native data store.
035 */
036public interface StorePostSearchEntryContext extends StoreRequestContext
037{
038  /**
039   * Retrieves the SCIM Filter associated with this search request.
040   *
041   * @return  The SCIM Filter that should be used. This may be {@code null} if
042   *          no filtering is required.
043   */
044  Filter getSCIMFilter();
045
046  /**
047   * Retrieves the search entry object returned by the store adapter.
048   * The plugin may make changes directly to this object. To remove an entry
049   * from search results entirely, the plugin should do so by modifying the
050   * entry so that it does not match the original search filter.
051   *
052   * @return The search entry returned by the store adapter.
053   */
054  ObjectNode getSearchEntry();
055}