All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.jetty.util.Promise Maven / Gradle / Ivy

Go to download

Utility classes for Jetty

The newest version!
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//

package org.eclipse.jetty.util;

import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executor;
import java.util.function.BiConsumer;
import java.util.function.Consumer;

import org.slf4j.LoggerFactory;

/**
 * 
A callback abstraction that handles completed/failed events of asynchronous operations.

 *
 * @param  the type of the context object
 */
public interface Promise
{
    Promise NOOP = new Promise<>()
    {
    };

    @SuppressWarnings("unchecked")
    static  Promise noop()
    {
        return (Promise)NOOP;
    }

    /**
     * 
Callback invoked when the operation completes.

     *
     * @param result the context
     * @see #failed(Throwable)
     */
    default void succeeded(C result)
    {
    }

    /**
     * 
Callback invoked when the operation fails.

     *
     * @param x the reason for the operation failure
     */
    default void failed(Throwable x)
    {
    }

    /**
     * 
Completes this promise with the given {@link CompletableFuture}.

     * 
When the CompletableFuture completes normally, this promise is succeeded;
     * when the CompletableFuture completes exceptionally, this promise is failed.

     *
     * @param completable the CompletableFuture that completes this promise
     */
    default void completeWith(CompletableFuture completable)
    {
        completable.whenComplete((o, x) ->
        {
            if (x == null)
                succeeded(o);
            else
                failed(x);
        });
    }

    /**
     * 
Empty implementation of {@link Promise}.

     *
     * @param  the type of the result
     */
    class Adapter implements Promise
    {
        @Override
        public void failed(Throwable x)
        {
            LoggerFactory.getLogger(this.getClass()).warn("Failed", x);
        }
    }

    /**
     * 
Creates a Promise from the given success and failure consumers.

     *
     * @param success the consumer invoked when the promise is succeeded
     * @param failure the consumer invoked when the promise is failed
     * @param  the type of the result
     * @return a new Promise wrapping the success and failure consumers.
     */
    static  Promise from(Consumer success, Consumer failure)
    {
        return new Promise<>()
        {
            @Override
            public void succeeded(T result)
            {
                success.accept(result);
            }

            @Override
            public void failed(Throwable x)
            {
                failure.accept(x);
            }
        };
    }

    /**
     * 
Creates a promise from the given incomplete CompletableFuture.

     * 
When the promise completes, either succeeding or failing, the
     * CompletableFuture is also completed, respectively via
     * {@link CompletableFuture#complete(Object)} or
     * {@link CompletableFuture#completeExceptionally(Throwable)}.

     *
     * @param completable the CompletableFuture to convert into a promise
     * @param  the type of the result
     * @return a promise that when completed, completes the given CompletableFuture
     */
    static  Promise from(CompletableFuture completable)
    {
        if (completable instanceof Promise)
            return (Promise)completable;

        return new Promise()
        {
            @Override
            public void succeeded(T result)
            {
                completable.complete(result);
            }

            @Override
            public void failed(Throwable x)
            {
                completable.completeExceptionally(x);
            }
        };
    }

    /**
     * 
A CompletableFuture that is also a Promise.

     *
     * @param  the type of the result
     */
    class Completable extends CompletableFuture implements Promise
    {
        /**
         * 
Creates a new {@code Completable} to be consumed by the given
         * {@code consumer}, then returns the newly created {@code Completable}.

         *
         * @param consumer the code that consumes the newly created {@code Completable}
         * @return the newly created {@code Completable}
         * @param  the type of the result
         */
        public static  Completable with(Consumer> consumer)
        {
            Completable completable = new Completable<>();
            consumer.accept(completable);
            return completable;
        }

        @Override
        public void succeeded(S result)
        {
            complete(result);
        }

        @Override
        public void failed(Throwable x)
        {
            completeExceptionally(x);
        }
    }

    class Wrapper implements Promise
    {
        private final Promise promise;

        public Wrapper(Promise promise)
        {
            this.promise = Objects.requireNonNull(promise);
        }

        @Override
        public void succeeded(W result)
        {
            promise.succeeded(result);
        }

        @Override
        public void failed(Throwable x)
        {
            promise.failed(x);
        }

        public Promise getPromise()
        {
            return promise;
        }

        public Promise unwrap()
        {
            Promise result = promise;
            while (true)
            {
                if (result instanceof Wrapper)
                    result = ((Wrapper)result).unwrap();
                else
                    break;
            }
            return result;
        }
    }

    /**
     * An {@link org.eclipse.jetty.util.thread.Invocable} {@link Promise} that provides the
     * {@link InvocationType} of calls to {@link Promise#succeeded(Object)}.
     * Also provides the {@link BiConsumer} interface as a convenient for working
     * with {@link CompletableFuture}.
     * @param  The result type
     */
    interface Invocable extends org.eclipse.jetty.util.thread.Invocable, Promise, BiConsumer
    {
        @Override
        default void accept(R result, Throwable error)
        {
            if (error != null)
                failed(error);
            else
                succeeded(result);
        }
    }

    /**
     * Create an {@link Promise.Invocable}
     * @param invocationType The {@link org.eclipse.jetty.util.thread.Invocable.InvocationType} of calls to the {@link Invocable}
     * @param promise The promise on which to delegate calls to.
     * @param  The type
     * @return An {@link org.eclipse.jetty.util.thread.Invocable} {@link Promise}.
     */
    static  Invocable from(org.eclipse.jetty.util.thread.Invocable.InvocationType invocationType, Promise promise)
    {
        return new Invocable()
        {
            @Override
            public InvocationType getInvocationType()
            {
                return invocationType;
            }

            @Override
            public void succeeded(C result)
            {
                promise.succeeded(result);
            }

            @Override
            public void failed(Throwable x)
            {
                promise.failed(x);
            }
        };
    }

    /**
     * Create an {@link Invocable} that is {@link org.eclipse.jetty.util.thread.Invocable.InvocationType#NON_BLOCKING} because
     * it executes the callbacks
     * @param promise The promise on which to delegate calls to.
     * @param  The type
     * @return An {@link org.eclipse.jetty.util.thread.Invocable} {@link Promise}.
     */
    static  Invocable from(Executor executor, Promise promise)
    {
        Objects.requireNonNull(executor);
        return new Invocable()
        {
            @Override
            public InvocationType getInvocationType()
            {
                return InvocationType.NON_BLOCKING;
            }

            @Override
            public void succeeded(C result)
            {
                executor.execute(() -> promise.succeeded(result));
            }

            @Override
            public void failed(Throwable x)
            {
                executor.execute(() -> promise.failed(x));
            }
        };
    }

    /**
     * 
A {@link Promise} that implements {@link Runnable} to perform
     * a one-shot task that eventually completes this {@link Promise}.

     * 
Subclasses override {@link #run()} to implement the task.

     * 
Users of this class start the task execution via {@link #run()}.

     * 
Typical usage:

     * 
{@code
     * // Specify what to do in case of success and failure.
     * Promise.Task task = new Promise.Task<>(() -> onSuccess(), x -> onFailure(x))
     * {
     *     @Override
     *     public void run()
     *     {
     *         try
     *         {
     *             // Perform some task.
     *             T result = performTask();
     *
     *             // Eventually succeed this Promise.
     *             succeeded(result);
     *         }
     *         catch (Throwable x)
     *         {
     *             // Fail this Promise.
     *             failed(x);
     *         }
     *     }
     * }
     *
     * // Start the task.
     * task.run();
     * }

     *
     * @param  the type of the result of the task
     */
    abstract class Task implements Promise, Runnable
    {
        private final Runnable onSuccess;
        private final Consumer onFailure;

        public Task()
        {
            onSuccess = null;
            onFailure = null;
        }

        public Task(Runnable onSuccess, Consumer onFailure)
        {
            this.onSuccess = Objects.requireNonNull(onSuccess);
            this.onFailure = Objects.requireNonNull(onFailure);
        }

        @Override
        public void succeeded(T result)
        {
            if (onSuccess != null)
                onSuccess.run();
        }

        @Override
        public void failed(Throwable x)
        {
            if (onFailure != null)
                onFailure.accept(x);
        }
    }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy