/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at legal-notices/CDDLv1_0.txt.
|
* If applicable, add the following below this CDDL HEADER, with the
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
* information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2009 Sun Microsystems, Inc.
|
* Portions copyright 2011 ForgeRock AS.
|
*/
|
|
package org.forgerock.opendj.ldap;
|
|
/**
|
* A completion handler for consuming the result of an asynchronous operation or
|
* connection attempts.
|
* <p>
|
* A result completion handler may be specified when performing asynchronous
|
* operations using a {@link Connection} object or when connecting
|
* asynchronously to a remote Directory Server using an
|
* {@link ConnectionFactory}. The {@link #handleResult} method is invoked when
|
* the operation or connection attempt completes successfully. The
|
* {@link #handleErrorResult} method is invoked if the operation or connection
|
* attempt fails.
|
* <p>
|
* Implementations of these methods should complete in a timely manner so as to
|
* avoid keeping the invoking thread from dispatching to other completion
|
* handlers.
|
*
|
* @param <S>
|
* The type of result handled by this result handler.
|
*/
|
public interface ResultHandler<S> {
|
/**
|
* Invoked when the asynchronous operation has failed.
|
*
|
* @param error
|
* The error result exception indicating why the asynchronous
|
* operation has failed.
|
*/
|
void handleErrorResult(ErrorResultException error);
|
|
/**
|
* Invoked when the asynchronous operation has completed successfully.
|
*
|
* @param result
|
* The result of the asynchronous operation.
|
*/
|
void handleResult(S result);
|
}
|
