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 2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.scim2.types;
028
029import com.unboundid.scim2.common.ScimResource;
030import com.unboundid.util.NotExtensible;
031
032/**
033 * This interfaces defines an API for a SCIM 2-based Server SDK extension to
034 * provide search results to the PingAuthorize Server as they are returned from
035 * the extension's data store.
036 */
037@NotExtensible
038public interface SCIMSearchResultListener
039{
040  /**
041   * Indicates that the provided resource has been returned by the extension's
042   * data store and may be processed by the PingAuthorize Server.
043   *
044   * @param scimResource
045   *          A resource that was returned by a search.
046   */
047  void searchResultReturned(final ScimResource scimResource);
048}