org.eclipse.jetty.util.Callback Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
//
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.util;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import org.eclipse.jetty.util.thread.Invocable;
/**
* A callback abstraction that handles completed/failed events of asynchronous operations.
*
* Semantically this is equivalent to an optimise Promise<Void>, but callback is a more meaningful
* name than EmptyPromise
*
* @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
*/
@Deprecated(since = "2021-05-27")
public interface Callback extends Invocable {
/**
* Instance of Adapter that can be used when the callback methods need an empty
* implementation without incurring in the cost of allocating a new Adapter object.
*/
Callback NOOP = new Callback() {
@Override
public InvocationType getInvocationType() {
return InvocationType.NON_BLOCKING;
}
};
/**
* Callback invoked when the operation completes.
*
* @see #failed(Throwable)
*/
default void succeeded() {
}
/**
* Callback invoked when the operation fails.
*
* @param x the reason for the operation failure
*/
default void failed(Throwable x) {
}
/**
* Creates a non-blocking callback from the given incomplete CompletableFuture.
* When the callback 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 callback
* @return a callback that when completed, completes the given CompletableFuture
*/
static Callback from(CompletableFuture completable) {
return from(completable, InvocationType.NON_BLOCKING);
}
/**
* Creates a callback from the given incomplete CompletableFuture,
* with the given {@code blocking} characteristic.
*
* @param completable the CompletableFuture to convert into a callback
* @param invocation whether the callback is blocking
* @return a callback that when completed, completes the given CompletableFuture
*/
static Callback from(CompletableFuture completable, InvocationType invocation) {
if (completable instanceof Callback)
return (Callback) completable;
return new Callback() {
@Override
public void succeeded() {
completable.complete(null);
}
@Override
public void failed(Throwable x) {
completable.completeExceptionally(x);
}
@Override
public InvocationType getInvocationType() {
return invocation;
}
};
}
/**
* Creates a callback from the given success and failure lambdas.
*
* @param success Called when the callback succeeds
* @param failure Called when the callback fails
* @return a new Callback
*/
static Callback from(Runnable success, Consumer failure) {
return from(InvocationType.BLOCKING, success, failure);
}
/**
* Creates a callback with the given InvocationType from the given success and failure lambdas.
*
* @param invocationType the Callback invocation type
* @param success Called when the callback succeeds
* @param failure Called when the callback fails
* @return a new Callback
*/
static Callback from(InvocationType invocationType, Runnable success, Consumer failure) {
return new Callback() {
@Override
public void succeeded() {
success.run();
}
@Override
public void failed(Throwable x) {
failure.accept(x);
}
@Override
public InvocationType getInvocationType() {
return invocationType;
}
};
}
/**
* Creaste a callback that runs completed when it succeeds or fails
*
* @param completed The completion to run on success or failure
* @return a new callback
*/
static Callback from(Runnable completed) {
return new Completing() {
public void completed() {
completed.run();
}
};
}
/**
* Create a nested callback that runs completed after
* completing the nested callback.
*
* @param callback The nested callback
* @param completed The completion to run after the nested callback is completed
* @return a new callback.
*/
static Callback from(Callback callback, Runnable completed) {
return new Nested(callback) {
public void completed() {
completed.run();
}
};
}
/**
* Create a nested callback that runs completed before
* completing the nested callback.
*
* @param callback The nested callback
* @param completed The completion to run before the nested callback is completed. Any exceptions thrown
* from completed will result in a callback failure.
* @return a new callback.
*/
static Callback from(Runnable completed, Callback callback) {
return new Callback() {
@Override
public void succeeded() {
try {
completed.run();
callback.succeeded();
} catch (Throwable t) {
callback.failed(t);
}
}
@Override
public void failed(Throwable x) {
try {
completed.run();
} catch (Throwable t) {
x.addSuppressed(t);
}
callback.failed(x);
}
};
}
// @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
@Deprecated(since = "2021-05-27")
class Completing implements Callback {
@Override
public void succeeded() {
completed();
}
@Override
public void failed(Throwable x) {
completed();
}
public void completed() {
}
}
/**
* Nested Completing Callback that completes after
* completing the nested callback
*
* @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
*/
@Deprecated(since = "2021-05-27")
class Nested extends Completing {
private final Callback callback;
public Nested(Callback callback) {
this.callback = callback;
}
public Nested(Nested nested) {
this.callback = nested.callback;
}
public Callback getCallback() {
return callback;
}
@Override
public void succeeded() {
try {
callback.succeeded();
} finally {
completed();
}
}
@Override
public void failed(Throwable x) {
try {
callback.failed(x);
} finally {
completed();
}
}
@Override
public InvocationType getInvocationType() {
return callback.getInvocationType();
}
}
static Callback combine(Callback cb1, Callback cb2) {
if (cb1 == null || cb1 == cb2)
return cb2;
if (cb2 == null)
return cb1;
return new Callback() {
@Override
public void succeeded() {
try {
cb1.succeeded();
} finally {
cb2.succeeded();
}
}
@Override
public void failed(Throwable x) {
try {
cb1.failed(x);
} catch (Throwable t) {
if (x != t)
x.addSuppressed(t);
} finally {
cb2.failed(x);
}
}
@Override
public InvocationType getInvocationType() {
return Invocable.combine(Invocable.getInvocationType(cb1), Invocable.getInvocationType(cb2));
}
};
}
/**
* A CompletableFuture that is also a Callback.
*
* @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
*/
@Deprecated(since = "2021-05-27")
class Completable extends CompletableFuture implements Callback {
private final InvocationType invocation;
public Completable() {
this(Invocable.InvocationType.NON_BLOCKING);
}
public Completable(InvocationType invocation) {
this.invocation = invocation;
}
@Override
public void succeeded() {
complete(null);
}
@Override
public void failed(Throwable x) {
completeExceptionally(x);
}
@Override
public InvocationType getInvocationType() {
return invocation;
}
}
}