001    /*
002     * Copyright 2008-2013 UnboundID Corp.
003     * All Rights Reserved.
004     */
005    /*
006     * Copyright (C) 2008-2013 UnboundID Corp.
007     *
008     * This program is free software; you can redistribute it and/or modify
009     * it under the terms of the GNU General Public License (GPLv2 only)
010     * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011     * as published by the Free Software Foundation.
012     *
013     * This program is distributed in the hope that it will be useful,
014     * but WITHOUT ANY WARRANTY; without even the implied warranty of
015     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016     * GNU General Public License for more details.
017     *
018     * You should have received a copy of the GNU General Public License
019     * along with this program; if not, see <http://www.gnu.org/licenses>.
020     */
021    package com.unboundid.ldap.sdk;
022    
023    
024    
025    import com.unboundid.util.Extensible;
026    import com.unboundid.util.ThreadSafety;
027    import com.unboundid.util.ThreadSafetyLevel;
028    
029    
030    
031    /**
032     * This interface provides a mechanism for notifying a client when the result
033     * for an asynchronous operation has been received.
034     */
035    @Extensible()
036    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
037    public interface AsyncResultListener
038    {
039      /**
040       * Indicates that the provided LDAP result has been received in response to an
041       * asynchronous operation.  Note that automatic referral following is not
042       * supported for asynchronous operations, so it is possible that this result
043       * could include a referral.
044       *
045       * @param  requestID   The async request ID of the request for which the
046       *                     response was received.
047       * @param  ldapResult  The LDAP result that has been received.
048       */
049      void ldapResultReceived(final AsyncRequestID requestID,
050                              final LDAPResult ldapResult);
051    }