org.springframework.kafka.requestreply.RequestReplyMessageFuture Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-kafka Show documentation
Spring Kafka Support
There is a newer version: 3.3.1
/*
 * Copyright 2021-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.kafka.requestreply;

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Future;

import org.springframework.kafka.support.SendResult;
import org.springframework.messaging.Message;
import org.springframework.util.Assert;
import org.springframework.util.concurrent.ListenableFuture;
import org.springframework.util.concurrent.SettableListenableFuture;

/**
 * A listenable future for {@link Message} replies.
 *
 * @param  the key type.
 * @param  the outbound data type.
 *
 * @author Gary Russell
 * @since 2.7
 *
 */
public class RequestReplyMessageFuture extends SettableListenableFuture> {

	protected final ListenableFuture> sendFuture; // NOSONAR

	protected CompletableFuture> completableSendFuture; // NOSONAR

	private Completable completable;

	RequestReplyMessageFuture(ListenableFuture> sendFuture) {
		this.sendFuture = sendFuture;
	}

	/**
	 * Return the send future.
	 * @return the send future.
	 */
	public ListenableFuture> getSendFuture() {
		return this.sendFuture;
	}

	/**
	 * Return a {@link CompletableFuture} representation of this instance.
	 * @return the {@link CompletableFuture}.
	 * @since 2.9
	 */
	public synchronized Completable asCompletable() {
		if (this.completable == null) {
			this.completable = new Completable(this);
			addCallback(this.completable::complete, this.completable::completeExceptionally);
		}
		return this.completable;
	}

	/**
	 * A {@link CompletableFuture} version.
	 * @since 2.9
	 */
	public class Completable extends CompletableFuture> {

		private final Future> delegate;

		Completable(Future> delegate) {
			Assert.notNull(delegate, "Delegate must not be null");
			this.delegate = delegate;
		}

		/**
		 * Return the send future as a {@link CompletableFuture}.
		 * @return the send future.
		 */
		public synchronized CompletableFuture> getSendFuture() {
			if (RequestReplyMessageFuture.this.completableSendFuture == null) {
				RequestReplyMessageFuture.this.completableSendFuture =
						RequestReplyMessageFuture.this.sendFuture.completable();
			}
			return RequestReplyMessageFuture.this.completableSendFuture;
		}

		@Override
		public boolean cancel(boolean mayInterruptIfRunning) {
			boolean result = this.delegate.cancel(mayInterruptIfRunning);
			super.cancel(mayInterruptIfRunning);
			return result;
		}

	}

}