001/*
002 * Copyright 2009-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-2022 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) 2009-2022 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.persist;
037
038
039
040import com.unboundid.ldap.sdk.SearchResultEntry;
041import com.unboundid.ldap.sdk.SearchResultReference;
042import com.unboundid.util.Extensible;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This interface defines a set of methods that provide access to objects
051 * returned by the {@link LDAPPersister} class in the course of performing a
052 * search.
053 *
054 * @param  <T>  The type of object handled by this class.
055 */
056@Extensible()
057@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
058public interface ObjectSearchListener<T>
059{
060  /**
061   * Indicates that the provided object was created from an entry retrieved from
062   * the directory server in the course of processing the search operation.
063   *
064   * @param  o  The object that has been decoded from the entry that was
065   *            returned.  It will never be {@code null}.
066   */
067  void objectReturned(@NotNull T o);
068
069
070
071  /**
072   * Indicates that the provided entry was retrieved from the director server
073   * in the course of processing the search operation, but an error occurred
074   * while attempting to instantiate an object from it.
075   *
076   * @param  entry      The entry that was retrieved from the directory server
077   *                    but could not be decoded as an object.
078   * @param  exception  The exception that was encountered while trying to
079   *                    create and initialize an object from the provided entry.
080   */
081  void unparsableEntryReturned(@NotNull SearchResultEntry entry,
082                               @NotNull LDAPPersistException exception);
083
084
085
086  /**
087   * Indicates that the provided search result reference was retrieved from the
088   * directory server in the course of processing the search operation.
089   *
090   * @param  searchReference  The search result reference that has been
091   *                          retrieved from the server.
092   */
093  void searchReferenceReturned(@NotNull SearchResultReference searchReference);
094}