Package org.forgerock.opendj.ldap.spi

Class LdapPromiseImpl<S>

    • Method Detail

      • newLdapPromiseImpl

        public static <S> LdapPromiseImpl<S> newLdapPromiseImpl​(int requestId)
        Creates a new LdapPromiseImpl with a requestId.
        Type Parameters:
        S - The type of result of the promise.
        Parameters:
        requestId - Identifier of the request.
        Returns:
        a new LdapPromiseImpl

      • getRequestId

        public int getRequestId()
        Description copied from interface: LdapPromise
        Returns the request ID of the request if appropriate.
        Specified by:
        getRequestId in interface LdapPromise<R>
        Returns:
        The request ID, or -1 if there is no request ID.

      • cancel

        public boolean cancel​(boolean mayInterruptIfRunning)
        Description copied from interface: Promise
        Attempts to cancel the asynchronous task associated with this Promise. Cancellation will fail if this Promise has already completed or has already been cancelled. If successful, then cancellation will complete this Promise with an appropriate exception and notify any registered functions and completion handlers.

        After this method returns, subsequent calls to Promise.isDone() will always return true. Subsequent calls to Promise.isCancelled() will always return true if this method returned true.

        Specified by:
        cancel in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        mayInterruptIfRunning - true if the thread executing executing the response handler should be interrupted; otherwise, in-progress response handlers are allowed to complete.
        Returns:
        false if Promise could not be cancelled, typically because it has already completed normally; true otherwise.

      • get

        public R get()
      throws ExecutionException,
             InterruptedException
        Description copied from interface: Promise
        Waits if necessary for this Promise to complete, and then returns the result if it completed successfully, or throws an ExecutionException containing the cause of the failure.
        Specified by:
        get in interface Promise<R,​P extends Promise<R,​LdapException>>
        Returns:
        The result, but only if this Promise completed successfully.
        Throws:
        ExecutionException - If this Promise was cancelled or did not complete successfully. The ExecutionException will contain the cause of the failure.
        InterruptedException - If the current thread was interrupted while waiting.

      • get

        public R get​(long timeout,
             TimeUnit unit)
      throws ExecutionException,
             TimeoutException,
             InterruptedException
        Description copied from interface: Promise
        Waits if necessary for at most the given time for this Promise to complete, and then returns the result if it completed successfully, or throws an ExecutionException containing the cause of the failure.
        Specified by:
        get in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        timeout - The maximum time to wait.
        unit - The time unit of the timeout argument.
        Returns:
        The result, but only if this Promise completed successfully.
        Throws:
        ExecutionException - If this Promise was cancelled or did not complete successfully. The ExecutionException will contain the cause of the failure.
        TimeoutException - If the wait timed out.
        InterruptedException - If the current thread was interrupted while waiting.

      • getOrThrow

        public R getOrThrow()
             throws InterruptedException,
                    LdapException
        Description copied from interface: Promise
        Waits if necessary for this Promise to complete, and then returns the result if it completed successfully, or throws an exception representing the cause of the failure.
        Specified by:
        getOrThrow in interface Promise<R,​P extends Promise<R,​LdapException>>
        Returns:
        The result, but only if this Promise completed successfully.
        Throws:
        InterruptedException - If the current thread was interrupted while waiting.
        LdapException

      • getOrThrow

        public R getOrThrow​(long timeout,
                    TimeUnit unit)
             throws InterruptedException,
                    LdapException,
                    TimeoutException
        Description copied from interface: Promise
        Waits if necessary for at most the given time for this Promise to complete, and then returns the result if it completed successfully, or throws an exception representing the cause of the failure.
        Specified by:
        getOrThrow in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        timeout - The maximum time to wait.
        unit - The time unit of the timeout argument.
        Returns:
        The result, but only if this Promise completed successfully.
        Throws:
        InterruptedException - If the current thread was interrupted while waiting.
        TimeoutException - If the wait timed out.
        LdapException

      • getOrThrowUninterruptibly

        public R getOrThrowUninterruptibly()
                            throws LdapException
        Description copied from interface: Promise
        Waits if necessary for this Promise to complete, and then returns the result if it completed successfully, or throws an exception representing the cause of the failure.

        This method is similar to Promise.getOrThrow() except that it will ignore thread interrupts. When this method returns the status of the current thread will be interrupted if an interrupt was received while waiting.

        Specified by:
        getOrThrowUninterruptibly in interface Promise<R,​P extends Promise<R,​LdapException>>
        Returns:
        The result, but only if this Promise completed successfully.
        Throws:
        LdapException

      • getOrThrowUninterruptibly

        public R getOrThrowUninterruptibly​(long timeout,
                                   TimeUnit unit)
                            throws LdapException,
                                   TimeoutException
        Description copied from interface: Promise
        Waits if necessary for at most the given time for this Promise to complete, and then returns the result if it completed successfully, or throws an exception representing the cause of the failure.

        This method is similar to Promise.getOrThrow(long, TimeUnit) except that it will ignore thread interrupts. When this method returns the status of the current thread will be interrupted if an interrupt was received while waiting.

        Specified by:
        getOrThrowUninterruptibly in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        timeout - The maximum time to wait.
        unit - The time unit of the timeout argument.
        Returns:
        The result, but only if this Promise completed successfully.
        Throws:
        TimeoutException - If the wait timed out.
        LdapException

      • isCancelled

        public boolean isCancelled()
        Description copied from interface: Promise
        Returns true if this Promise was cancelled before it completed normally.
        Specified by:
        isCancelled in interface Promise<R,​P extends Promise<R,​LdapException>>
        Returns:
        true if this Promise was cancelled before it completed normally, otherwise false.

      • isDone

        public boolean isDone()
        Description copied from interface: Promise
        Returns true if this Promise has completed.

        Completion may be due to normal termination, an exception, or cancellation. In all of these cases, this method will return true.

        Specified by:
        isDone in interface Promise<R,​P extends Promise<R,​LdapException>>
        Returns:
        true if this Promise has completed, otherwise false.

      • isResult

        public boolean isResult()
        Description copied from interface: Promise
        Returns true if this Promise has completed and contains a value.
        Specified by:
        isResult in interface Promise<R,​P extends Promise<R,​LdapException>>
        Returns:
        true if this Promise has completed with a value.

      • thenOnCompletion

        public <T extends ResultHandler<? super R> & ExceptionHandler<? super LdapException> & RuntimeExceptionHandler> Promise<R,​LdapException> thenOnCompletion​(T handler)
        Description copied from interface: Promise
        Registers the provided completion handler for notification for all completion cases of this Promise.

        This method can be used for asynchronous completion notification.

        Specified by:
        thenOnCompletion in interface Promise<R,​P extends Promise<R,​LdapException>>
        Type Parameters:
        T - the composite type of the handler for handling all completion cases
        Parameters:
        handler - The handler that will be called once this Promise is completed.
        Returns:
        A Promise that is guaranteed to be completed once the provided callback has been executed.

      • thenOnException

        public LdapPromise<R> thenOnException​(ExceptionHandler<? super LdapException> onException)
        Description copied from interface: Promise
        Registers the provided completion handler for notification if this Promise cannot be completed due to an exception. If this Promise completes with a result then the completion handler will not be notified.

        This method can be used for asynchronous completion notification.

        Specified by:
        thenOnException in interface LdapPromise<R>
        Specified by:
        thenOnException in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        onException - The completion handler which will be notified upon failure completion of this Promise.
        Returns:
        A Promise that is guaranteed to be completed once the provided callback has been executed.

      • thenOnRuntimeException

        public LdapPromise<R> thenOnRuntimeException​(RuntimeExceptionHandler onRuntimeException)
        Description copied from interface: Promise
        Registers the provided completion handler for notification if this Promise cannot be completed due to an runtime exception. If this Promise completes with a result or the typed exception then the completion handler will not be notified.

        This method can be used for asynchronous completion notification.

        Specified by:
        thenOnRuntimeException in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        onRuntimeException - The completion handler which will be notified upon an uncaught runtime exception completion of this Promise.
        Returns:
        A Promise that is guaranteed to be completed once the provided callback has been executed.

      • thenOnResult

        public LdapPromise<R> thenOnResult​(ResultHandler<? super R> onResult)
        Description copied from interface: Promise
        Registers the provided completion handler for notification once this Promise has completed with a result. If this Promise completes with an exception then the completion handler will not be notified.

        This method can be used for asynchronous completion notification and is equivalent to Promise.then(Function).

        Specified by:
        thenOnResult in interface LdapPromise<R>
        Specified by:
        thenOnResult in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        onResult - The completion handler which will be notified upon successful completion of this Promise.
        Returns:
        A Promise that is guaranteed to be completed once the provided callback has been executed.

      • thenOnResultOrException

        public LdapPromise<R> thenOnResultOrException​(Runnable onResultOrException)
        Description copied from interface: Promise
        Submits the provided runnable for execution once this Promise has completed, and regardless of whether it has a result or an exception.

        This method can be used for resource cleanup after a series of asynchronous tasks have completed. More specifically, this method should be used in a similar manner to finally statements in try...catch expressions.

        This method is equivalent to Promise.thenAlways(Runnable).

        Specified by:
        thenOnResultOrException in interface LdapPromise<R>
        Specified by:
        thenOnResultOrException in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        onResultOrException - The runnable which will be notified regardless of the final outcome of this Promise.
        Returns:
        A Promise that is guaranteed to be completed once the provided callback has been executed.

      • then

        public <VOUT> LdapPromise<VOUT> then​(Function<? super R,​VOUT,​LdapException> onResult)
        Description copied from interface: Promise
        Submits the provided function for execution once this Promise has completed with a result, and returns a new Promise representing the outcome of the function. If this Promise does not complete with a result then the function will not be invoked and the exception will be forwarded to the returned Promise.

        This method can be used for transforming the result of an asynchronous task.

        Specified by:
        then in interface LdapPromise<R>
        Specified by:
        then in interface Promise<R,​P extends Promise<R,​LdapException>>
        Type Parameters:
        VOUT - The type of the function's result, or Void if the function does not return anything (i.e. it only has side-effects). Note that the type may be different to the type of this Promise.
        Parameters:
        onResult - The function which will be executed upon successful completion of this Promise.
        Returns:
        A new Promise representing the outcome of the function.

      • then

        public <VOUT,​EOUT extends Exception> Promise<VOUT,​EOUT> then​(Function<? super R,​VOUT,​EOUT> onResult,
                                                                         Function<? super LdapException,​VOUT,​EOUT> onException)
        Description copied from interface: Promise
        Submits the provided functions for execution once this Promise has completed (with a result or an exception), and returns a new Promise representing the outcome of the invoked function. If this Promise completes with a result then onResult will be invoked with the result, otherwise onException will be invoked with the exception that occurred.

        This method can be used for transforming the outcome of an asynchronous task.

        Specified by:
        then in interface Promise<R,​P extends Promise<R,​LdapException>>
        Type Parameters:
        VOUT - The type of the functions' result, or Void if the functions do not return anything (i.e. they only have side-effects). Note that the type may be different to the type of this Promise.
        EOUT - The type of the exception thrown by the functions if they fail, or NeverThrowsException if they cannot fail. Note that the type may be different to the type of this Promise.
        Parameters:
        onResult - The function which will be executed upon successful completion of this Promise.
        onException - The function which will be executed upon failure of this Promise.
        Returns:
        A new Promise representing the outcome of the invoked function.

      • then

        public <VOUT,​EOUT extends Exception> Promise<VOUT,​EOUT> then​(Function<? super R,​VOUT,​EOUT> onResult,
                                                                         Function<? super LdapException,​VOUT,​EOUT> onException,
                                                                         Function<? super RuntimeException,​VOUT,​EOUT> onRuntimeException)
        Description copied from interface: Promise
        Submits the provided functions for execution once this Promise has completed (with a result or an exception or a RuntimeException), and returns a new Promise representing the outcome of the invoked function. If this Promise completes with a result then onResult will be invoked with the result, with a RuntimeException then onRuntimeException will be invoked with the runtime exception that occurred, otherwise onException will be invoked with the exception that occurred.

        This method can be used for transforming the outcome of an asynchronous task.

        Specified by:
        then in interface Promise<R,​P extends Promise<R,​LdapException>>
        Type Parameters:
        VOUT - The type of the functions' result, or Void if the functions do not return anything (i.e. they only have side-effects). Note that the type may be different to the type of this Promise.
        EOUT - The type of the exception thrown by the functions if they fail, or NeverThrowsException if they cannot fail. Note that the type may be different to the type of this Promise.
        Parameters:
        onResult - The function which will be executed upon successful completion of this Promise.
        onException - The function which will be executed upon failure of this Promise.
        onRuntimeException - The function which will be executed upon failure with RuntimeException of this Promise.
        Returns:
        A new Promise representing the outcome of the invoked function.

      • thenOnResultOrException

        public LdapPromise<R> thenOnResultOrException​(ResultHandler<? super R> onResult,
                                              ExceptionHandler<? super LdapException> onException)
        Description copied from interface: Promise
        Registers the provided completion handlers for notification once this Promise has completed (with a result or an exception). If this Promise completes with a result then onResult will be notified with the result, otherwise onException will be notified with the exception that occurred.

        This method can be used for asynchronous completion notification.

        Specified by:
        thenOnResultOrException in interface LdapPromise<R>
        Specified by:
        thenOnResultOrException in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        onResult - The completion handler which will be notified upon completion with a result of this Promise.
        onException - The completion handler which will be notified upon failure of this Promise.
        Returns:
        A Promise that is guaranted to be completed once the provided callback has been executed.

      • thenAlways

        public LdapPromise<R> thenAlways​(Runnable onResultOrException)
        Description copied from interface: Promise
        Submits the provided runnable for execution once this Promise has completed, and regardless of whether it has a result or an exception.

        This method can be used for resource cleanup after a series of asynchronous tasks have completed. More specifically, this method should be used in a similar manner to finally statements in try...catch expressions.

        This method is equivalent to Promise.thenOnResultOrException(Runnable).

        Specified by:
        thenAlways in interface LdapPromise<R>
        Specified by:
        thenAlways in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        onResultOrException - The runnable which will be notified regardless of the final outcome of this Promise.
        Returns:
        A Promise that is guaranteed to be completed once the provided callback has been executed.

      • thenAsync

        public <VOUT> LdapPromise<VOUT> thenAsync​(AsyncFunction<? super R,​VOUT,​LdapException> onResult)
        Description copied from interface: Promise
        Submits the provided asynchronous function for execution once this Promise has completed with a result, and returns a new Promise representing the outcome of the function. If this Promise complete with an exception then the function will not be invoked and the error will be forwarded to the returned Promise.

        This method may be used for chaining together a series of asynchronous tasks.

        Specified by:
        thenAsync in interface LdapPromise<R>
        Specified by:
        thenAsync in interface Promise<R,​P extends Promise<R,​LdapException>>
        Type Parameters:
        VOUT - The type of the function's result, or Void if the function does not return anything (i.e. it only has side-effects). Note that the type may be different to the type of this Promise.
        Parameters:
        onResult - The asynchronous function which will be executed upon successful completion of this Promise.
        Returns:
        A new Promise representing the outcome of the function.

      • thenAsync

        public <VOUT,​EOUT extends Exception> Promise<VOUT,​EOUT> thenAsync​(AsyncFunction<? super R,​VOUT,​EOUT> onResult,
                                                                              AsyncFunction<? super LdapException,​VOUT,​EOUT> onException)
        Description copied from interface: Promise
        Submits the provided asynchronous functions for execution once this Promise has completed, and returns a new Promise representing the outcome of the invoked function. If this Promise completes with a result then onResult will be invoked with the result, otherwise onException will be invoked with the exception that occurred.

        This method may be used for chaining together a series of asynchronous tasks.

        Specified by:
        thenAsync in interface Promise<R,​P extends Promise<R,​LdapException>>
        Type Parameters:
        VOUT - The type of the functions' result, or Void if the functions do not return anything (i.e. they only have side-effects). Note that the type may be different to the type of this Promise.
        EOUT - The type of the exception thrown by the functions if they fail, or NeverThrowsException if they cannot fail. Note that the type may be different to the type of this Promise.
        Parameters:
        onResult - The asynchronous function which will be executed upon successful completion of this Promise.
        onException - The asynchronous function which will be executed upon failure of this Promise.
        Returns:
        A new Promise representing the outcome of the invoked function.

      • thenAsync

        public <VOUT,​EOUT extends Exception> Promise<VOUT,​EOUT> thenAsync​(AsyncFunction<? super R,​VOUT,​EOUT> onResult,
                                                                              AsyncFunction<? super LdapException,​VOUT,​EOUT> onException,
                                                                              AsyncFunction<? super RuntimeException,​VOUT,​EOUT> onRuntimeException)
        Description copied from interface: Promise
        Submits the provided asynchronous functions for execution once this Promise has completed, and returns a new Promise representing the outcome of the invoked function. If this Promise completes with a result then onResult will be invoked with the result, otherwise onException will be invoked with the exception that occurred, or onRuntimeException will be invoked with the runtime exception that occurred.

        This method may be used for chaining together a series of asynchronous tasks.

        Specified by:
        thenAsync in interface Promise<R,​P extends Promise<R,​LdapException>>
        Type Parameters:
        VOUT - The type of the functions' result, or Void if the functions do not return anything (i.e. they only have side-effects). Note that the type may be different to the type of this Promise.
        EOUT - The type of the exception thrown by the functions if they fail, or NeverThrowsException if they cannot fail. Note that the type may be different to the type of this Promise.
        Parameters:
        onResult - The asynchronous function which will be executed upon successful completion of this Promise.
        onException - The asynchronous function which will be executed upon failure of this Promise.
        onRuntimeException - The asynchronous function which will be executed upon failure with RuntimeException of this Promise.
        Returns:
        A new Promise representing the outcome of the invoked function.

      • thenCatch

        public <EOUT extends Exception> Promise<R,​EOUT> thenCatch​(Function<? super LdapException,​R,​EOUT> onException)
        Description copied from interface: Promise
        Submits the provided function for execution once this Promise has not completed with a result (has completed with an exception), and returns a new Promise representing the outcome of the function. If this Promise completes with a result then the function will not be invoked and the result notification will be forwarded to the returned Promise.

        This method can be used for transforming the result of an asynchronous task.

        Specified by:
        thenCatch in interface Promise<R,​P extends Promise<R,​LdapException>>
        Type Parameters:
        EOUT - The type of the exception thrown by the function if it fails, or NeverThrowsException if it cannot fails. Note that the type may be different to the type of this Promise.
        Parameters:
        onException - The function which will be executed upon failure completion of this Promise.
        Returns:
        A new Promise representing the outcome of the function.

      • thenCatchRuntimeException

        public Promise<R,​LdapException> thenCatchRuntimeException​(Function<? super RuntimeException,​R,​LdapException> onRuntimeException)
        Description copied from interface: Promise
        Submits the provided function for execution once this Promise has not completed with a result nor with an exception but with a RuntimeException, and returns a new Promise representing the outcome of the function. If this Promise completes with a result or an exception then the function will not be invoked and the result notification will be forwarded to the returned Promise.

        This method can be used for transforming the result of an asynchronous task.

        Specified by:
        thenCatchRuntimeException in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        onRuntimeException - The function which will be executed upon failure completion of this Promise.
        Returns:
        A new Promise representing the outcome of the function.

      • thenCatchRuntimeExceptionAsync

        public Promise<R,​LdapException> thenCatchRuntimeExceptionAsync​(AsyncFunction<? super RuntimeException,​R,​LdapException> onRuntimeException)
        Description copied from interface: Promise
        Submits the provided asynchronous function for execution once this Promise has completed with a RuntimeException, and returns a new Promise representing the outcome of the function. If this Promise completes with a result or the typed exception then the completion asynchronous function will not be called.

        This method may be used for chaining together a series of asynchronous tasks.

        Specified by:
        thenCatchRuntimeExceptionAsync in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        onRuntimeException - The asynchronous function which will be executed upon failure completion with a RuntimeException of this Promise.
        Returns:
        A new Promise representing the outcome of the function.

      • thenFinally

        public LdapPromise<R> thenFinally​(Runnable onResultOrException)
        Description copied from interface: Promise
        Submits the provided runnable for execution once this Promise has completed, and regardless of whether of its outcome.

        This method can be used for resource cleanup after a series of asynchronous tasks have completed. More specifically, this method should be used in a similar manner to finally statements in try...catch expressions.

        This method is equivalent to Promise.thenAlways(Runnable).

        Specified by:
        thenFinally in interface LdapPromise<R>
        Specified by:
        thenFinally in interface Promise<R,​P extends Promise<R,​LdapException>>
        Parameters:
        onResultOrException - The runnable which will be notified regardless of the final outcome of this Promise.
        Returns:
        A Promise that is guaranteed to be completed once the provided callback has been executed.

      • thenCatchAsync

        public <EOUT extends Exception> Promise<R,​EOUT> thenCatchAsync​(AsyncFunction<? super LdapException,​R,​EOUT> onException)
        Description copied from interface: Promise
        Submits the provided asynchronous function for execution once this Promise has completed with an exception, and returns a new Promise representing the outcome of the function. If this Promise completes with a result then the function will not be invoked and the exception will be forwarded to the returned Promise.

        This method may be used for chaining together a series of asynchronous tasks.

        Specified by:
        thenCatchAsync in interface Promise<R,​P extends Promise<R,​LdapException>>
        Type Parameters:
        EOUT - The type of the exception thrown by the function if it fails, or NeverThrowsException if it cannot fails. Note that the type may be different to the type of this Promise.
        Parameters:
        onException - The asynchronous function which will be executed upon failure completion of this Promise.
        Returns:
        A new Promise representing the outcome of the function.