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

com.microsoft.azure.servicebus.primitives.MessagingFactory Maven / Gradle / Ivy

There is a newer version: 3.6.7
Show newest version
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.azure.servicebus.primitives;

import java.io.IOException;
import java.net.URI;
import java.nio.channels.UnresolvedAddressException;
import java.time.Duration;
import java.time.Instant;
import java.util.LinkedList;
import java.util.Locale;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledFuture;

import com.microsoft.azure.servicebus.TransactionContext;
import com.microsoft.azure.servicebus.Utils;
import com.microsoft.azure.servicebus.amqp.BaseLinkHandler;
import com.microsoft.azure.servicebus.amqp.ConnectionHandler;
import com.microsoft.azure.servicebus.amqp.DispatchHandler;
import com.microsoft.azure.servicebus.amqp.IAmqpConnection;
import com.microsoft.azure.servicebus.amqp.ProtonUtil;
import com.microsoft.azure.servicebus.amqp.ReactorDispatcher;
import com.microsoft.azure.servicebus.amqp.ReactorHandler;
import org.apache.qpid.proton.amqp.Binary;
import org.apache.qpid.proton.amqp.transport.ErrorCondition;
import org.apache.qpid.proton.engine.BaseHandler;
import org.apache.qpid.proton.engine.Connection;
import org.apache.qpid.proton.engine.EndpointState;
import org.apache.qpid.proton.engine.Event;
import org.apache.qpid.proton.engine.Handler;
import org.apache.qpid.proton.engine.HandlerException;
import org.apache.qpid.proton.engine.Link;
import org.apache.qpid.proton.reactor.Reactor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.Marker;
import org.slf4j.MarkerFactory;

import com.microsoft.azure.servicebus.ClientSettings;
import com.microsoft.azure.servicebus.security.SecurityToken;

/**
 * Abstracts all AMQP related details and encapsulates an AMQP connection and manages its life cycle. Each instance of
 * this class represent one AMQP connection to the namespace. If an application creates multiple senders, receivers
 * or clients using the same MessagingFactory instance, all those senders, receivers or clients will share the same connection to the namespace.
 * @since 1.0
 */
public class MessagingFactory extends ClientEntity implements IAmqpConnection {
    private static final Logger TRACE_LOGGER = LoggerFactory.getLogger(MessagingFactory.class);
    public static final ExecutorService INTERNAL_THREAD_POOL = Executors.newCachedThreadPool();

    private static final String REACTOR_THREAD_NAME_PREFIX = "ReactorThread";
    private static final int MAX_CBS_LINK_CREATION_ATTEMPTS = 3;
    private final String hostName;
    private final CompletableFuture connetionCloseFuture;
    private final ConnectionHandler connectionHandler;
    private final ReactorHandler reactorHandler;
    private final LinkedList registeredLinks;
    private final Object reactorLock;
    private final RequestResponseLinkCache managementLinksCache;

    private Reactor reactor;
    private ReactorDispatcher reactorScheduler;
    private Connection connection;
    private Controller controller;

    private CompletableFuture factoryOpenFuture;
    private CompletableFuture cbsLinkCreationFuture;
    private RequestResponseLink cbsLink;
    private int cbsLinkCreationAttempts = 0;
    private Throwable lastCBSLinkCreationException = null;
    private URI namespaceEndpointUri;

    private final ClientSettings clientSettings;

    private MessagingFactory(URI namespaceEndpointUri, ClientSettings clientSettings) {
        super("MessagingFactory".concat(StringUtil.getShortRandomString()));
        this.clientSettings = clientSettings;
        this.namespaceEndpointUri = namespaceEndpointUri;
        this.hostName = namespaceEndpointUri.getHost();
        this.registeredLinks = new LinkedList();
        this.connetionCloseFuture = new CompletableFuture();
        this.reactorLock = new Object();
        this.connectionHandler =   ConnectionHandler.create(clientSettings.getTransportType(), this);
        this.factoryOpenFuture = new CompletableFuture();
        this.cbsLinkCreationFuture = new CompletableFuture();
        this.managementLinksCache = new RequestResponseLinkCache(this);
        this.reactorHandler = new ReactorHandler() {
            @Override
            public void onReactorInit(Event e) {
                super.onReactorInit(e);

                final Reactor r = e.getReactor();
                TRACE_LOGGER.info("Creating connection to host '{}:{}'",
                        connectionHandler.getOutboundSocketHostName(),
                        connectionHandler.getOutboundSocketPort());
                connection = r.connectionToHost(
                        connectionHandler.getOutboundSocketHostName(),
                        connectionHandler.getOutboundSocketPort(),
                        connectionHandler);
            }
        };
        Timer.register(this.getClientId());
    }

    /**
     * Starts a new service side transaction. The {@link TransactionContext} should be passed to all operations that
     * needs to be in this transaction.
     * @return a new transaction
     * @throws ServiceBusException if transaction fails to start
     * @throws InterruptedException if the current thread was interrupted while waiting
     */
    public TransactionContext startTransaction() throws ServiceBusException, InterruptedException {
        return Utils.completeFuture(this.startTransactionAsync());
    }

    /**
     * Starts a new service side transaction. The {@link TransactionContext} should be passed to all operations that
     * needs to be in this transaction.
     * @return A CompletableFuture which returns a new transaction
     */
    public CompletableFuture startTransactionAsync() {
        return this.getController()
                .thenCompose(controller -> controller.declareAsync()
                        .thenApply(binary -> new TransactionContext(binary.asByteBuffer(), this)));
    }

    /**
     * Ends a transaction that was initiated using {@link MessagingFactory#startTransactionAsync()}.
     * @param transaction The transaction object.
     * @param commit A boolean value of true indicates transaction to be committed. A value of
     *                  false indicates a transaction rollback.
     * @throws ServiceBusException if transaction fails to end
     * @throws InterruptedException if the current thread was interrupted while waiting
     */
    public void endTransaction(TransactionContext transaction, boolean commit) throws ServiceBusException, InterruptedException {
        Utils.completeFuture(this.endTransactionAsync(transaction, commit));
    }

    /**
     * Ends a transaction that was initiated using {@link MessagingFactory#startTransactionAsync()}.
     * @param transaction The transaction object.
     * @param commit A boolean value of true indicates transaction to be committed. A value of
     *                  false indicates a transaction rollback.
     * @return A CompletableFuture
     */
    public CompletableFuture endTransactionAsync(TransactionContext transaction, boolean commit) {
        if (transaction == null) {
            CompletableFuture exceptionCompletion = new CompletableFuture<>();
            exceptionCompletion.completeExceptionally(new ServiceBusException(false, "Transaction cannot not be null"));
            return exceptionCompletion;
        }

        return this.getController()
                .thenCompose(controller -> controller.dischargeAsync(new Binary(transaction.getTransactionId().array()), commit)
                .thenRun(() -> transaction.notifyTransactionCompletion(commit)));
    }

    private CompletableFuture getController() {
        if (this.controller != null) {
            return CompletableFuture.completedFuture(this.controller);
        }

        return createController();
    }

    private synchronized CompletableFuture createController() {
        if (this.controller != null) {
            return CompletableFuture.completedFuture(this.controller);
        }

        Controller controller = new Controller(this.namespaceEndpointUri, this, this.clientSettings);
        return controller.initializeAsync().thenApply(v -> {
            this.controller = controller;
            return controller;
        });
    }

    @Override
    public String getHostName() {
        return this.hostName;
    }

    private Reactor getReactor() {
        synchronized (this.reactorLock) {
            return this.reactor;
        }
    }

    private ReactorDispatcher getReactorScheduler() {
        synchronized (this.reactorLock) {
            return this.reactorScheduler;
        }
    }

    private void startReactor(ReactorHandler reactorHandler) throws IOException {
        TRACE_LOGGER.info("Creating and starting reactor");
        Reactor newReactor = ProtonUtil.reactor(reactorHandler, this.connectionHandler.getMaxFrameSize());
        synchronized (this.reactorLock) {
            this.reactor = newReactor;
            this.reactorScheduler = new ReactorDispatcher(newReactor);
        }

        String reactorThreadName = REACTOR_THREAD_NAME_PREFIX + UUID.randomUUID().toString();
        Thread reactorThread = new Thread(new RunReactor(), reactorThreadName);
        reactorThread.start();
        TRACE_LOGGER.info("Started reactor");
    }

    Connection getActiveConnectionOrNothing() {
		if (this.connection == null || this.connection.getLocalState() == EndpointState.CLOSED || this.connection.getRemoteState() == EndpointState.CLOSED) {
			return null;
		}
		else {
			return this.connection;
		}
	}

	Connection getActiveConnectionCreateIfNecessary() {
        if (this.connection == null || this.connection.getLocalState() == EndpointState.CLOSED || this.connection.getRemoteState() == EndpointState.CLOSED) {
            TRACE_LOGGER.info("Creating connection to host '{}:{}'", this.connectionHandler.getOutboundSocketHostName(), this.connectionHandler.getOutboundSocketPort());
            this.connection = this.getReactor().connectionToHost(
                    this.connectionHandler.getOutboundSocketHostName(),
                    this.connectionHandler.getOutboundSocketPort(),
                    this.connectionHandler);
        }

        return this.connection;
    }

    /**
     * Gets the operation timeout from the connections string.
     * @return operation timeout specified in the connection string
     */
    public Duration getOperationTimeout() {
        return this.clientSettings.getOperationTimeout();
    }

    /**
     * Gets the retry policy from the connection string.
     * @return retry policy specified in the connection string
     */
    public RetryPolicy getRetryPolicy() {
        return this.clientSettings.getRetryPolicy();
    }

    /**
     * Gets client settings for this messaging factory instance
     * @return client settings for this messaging factory instance
     */
    public ClientSettings getClientSettings() {
        return this.clientSettings;
    }

    /**
     * Creates a messaging factory instance from namesapce name and client settings
     * @param sbNamespaceName name of the namespace
     * @param clientSettings clientsettings for the factory
     * @return a completablefuture whose result is messagingfactory instance when its execution completes
     * @deprecated Deprecating as spelling is wrong. Replaced by {@link #createFromNamespaceNameAsync(String, ClientSettings)}
     */
    @Deprecated
    public static CompletableFuture createFromNamespaceNameAsyc(String sbNamespaceName, ClientSettings clientSettings) {
        return createFromNamespaceEndpointURIAsync(Util.convertNamespaceToEndPointURI(sbNamespaceName), clientSettings);
    }
    
    /**
     * Creates a messaging factory instance from namesapce name and client settings
     * @param sbNamespaceName name of the namespace
     * @param clientSettings clientsettings for the factory
     * @return a completablefuture whose result is messagingfactory instance when its execution completes
     */
    public static CompletableFuture createFromNamespaceNameAsync(String sbNamespaceName, ClientSettings clientSettings) {
        return createFromNamespaceEndpointURIAsync(Util.convertNamespaceToEndPointURI(sbNamespaceName), clientSettings);
    }
    
    /**
     * Creates a messaging factory instance from namesapce endpoint URI and client settings
     * @param namespaceEndpointURI Endpoint URI of the namespace
     * @param clientSettings clientsettings for the factory
     * @return a completablefuture whose result is messagingfactory instance when its execution completes
     * @deprecated Deprecating as spelling is wrong. Replaced by {@link #createFromNamespaceEndpointURIAsync(URI, ClientSettings)}
     */
    @Deprecated
    public static CompletableFuture createFromNamespaceEndpointURIAsyc(URI namespaceEndpointURI, ClientSettings clientSettings) {
    	return createFromNamespaceEndpointURIAsync(namespaceEndpointURI, clientSettings);
    }

    /**
     * Creates a messaging factory instance from namesapce endpoint URI and client settings
     * @param namespaceEndpointURI Endpoint URI of the namespace
     * @param clientSettings clientsettings for the factory
     * @return a completablefuture whose result is messagingfactory instance when its execution completes
     */
    public static CompletableFuture createFromNamespaceEndpointURIAsync(URI namespaceEndpointURI, ClientSettings clientSettings) {
        if (TRACE_LOGGER.isInfoEnabled()) {
            TRACE_LOGGER.info("Creating messaging factory from namespace endpoint uri '{}'", namespaceEndpointURI.toString());
        }
        
        MessagingFactory messagingFactory = new MessagingFactory(namespaceEndpointURI, clientSettings);
        try {
            messagingFactory.startReactor(messagingFactory.reactorHandler);
        } catch (IOException e) {
            Marker fatalMarker = MarkerFactory.getMarker(ClientConstants.FATAL_MARKER);
            TRACE_LOGGER.info(fatalMarker, "Starting reactor failed", e);
            messagingFactory.factoryOpenFuture.completeExceptionally(e);
        }
        return messagingFactory.factoryOpenFuture;
    }

    /**
     * Creates a messaging factory instance from namesapce name and client settings
     * @param sbNamespaceName name of the namespace
     * @param clientSettings clientsettings for the factory
     * @return an instance of MessagingFactory
     * @throws InterruptedException if blocking thread is interrupted
     * @throws ServiceBusException if a connection couldn't be established to the namespace
     */
    public static MessagingFactory createFromNamespaceName(String sbNamespaceName, ClientSettings clientSettings) throws InterruptedException, ServiceBusException {
        return completeFuture(createFromNamespaceNameAsync(sbNamespaceName, clientSettings));
    }
    
    /**
     * Creates a messaging factory instance from namesapce endpoint URI and client settings
     * @param namespaceEndpointURI Endpoint URI of the namespace
     * @param clientSettings clientsettings for the factory
     * @return an instance of MessagingFactory
     * @throws InterruptedException if blocking thread is interrupted
     * @throws ServiceBusException if a connection couldn't be established to the namespace
     */
    public static MessagingFactory createFromNamespaceEndpointURI(URI namespaceEndpointURI, ClientSettings clientSettings) throws InterruptedException, ServiceBusException {
        return completeFuture(createFromNamespaceEndpointURIAsync(namespaceEndpointURI, clientSettings));
    }

    /**
     * Creates an instance of MessagingFactory from the given connection string builder. This is a non-blocking method.
     * @param builder connection string builder to the bus namespace or entity
     * @return a CompletableFuture which completes when a connection is established to the namespace or when a connection couldn't be established.
     * @see java.util.concurrent.CompletableFuture
     */
    public static CompletableFuture createFromConnectionStringBuilderAsync(final ConnectionStringBuilder builder) {
        if (TRACE_LOGGER.isInfoEnabled()) {
            TRACE_LOGGER.info("Creating messaging factory from connection string '{}'", builder.toLoggableString());
        }

        return createFromNamespaceEndpointURIAsync(builder.getEndpoint(), Util.getClientSettingsFromConnectionStringBuilder(builder));
    }

    /**
     * Creates an instance of MessagingFactory from the given connection string. This is a non-blocking method.
     * @param connectionString connection string to the  bus namespace or entity
     * @return a CompletableFuture which completes when a connection is established to the namespace or when a connection couldn't be established.
     * @see java.util.concurrent.CompletableFuture
     */
    public static CompletableFuture createFromConnectionStringAsync(final String connectionString) {
        ConnectionStringBuilder builder = new ConnectionStringBuilder(connectionString);
        return createFromConnectionStringBuilderAsync(builder);
    }

    /**
     * Creates an instance of MessagingFactory from the given connection string builder. This method blocks for a connection to the namespace to be established.
     * @param builder connection string builder to the  bus namespace or entity
     * @return an instance of MessagingFactory
     * @throws InterruptedException if blocking thread is interrupted
     * @throws ExecutionException if a connection couldn't be established to the namespace. Cause of the failure can be found by calling {@link Exception#getCause()}
     */
    public static MessagingFactory createFromConnectionStringBuilder(final ConnectionStringBuilder builder) throws InterruptedException, ExecutionException {
        return createFromConnectionStringBuilderAsync(builder).get();
    }

    /**
     * Creates an instance of MessagingFactory from the given connection string. This method blocks for a connection to the namespace to be established.
     * @param connectionString connection string to the  bus namespace or entity
     * @return an instance of MessagingFactory
     * @throws InterruptedException if blocking thread is interrupted
     * @throws ExecutionException if a connection couldn't be established to the namespace. Cause of the failure can be found by calling {@link Exception#getCause()}
     */
    public static MessagingFactory createFromConnectionString(final String connectionString) throws InterruptedException, ExecutionException {
        return createFromConnectionStringAsync(connectionString).get();
    }

    /**
     * Internal method. Clients should not use this method.
     */
    @Override
    public void onConnectionOpen() {
        if (!factoryOpenFuture.isDone()) {
            TRACE_LOGGER.info("MessagingFactory opened.");
            AsyncUtil.completeFuture(this.factoryOpenFuture, this);
        }

        // Connection opened. Initiate new cbs link creation
        TRACE_LOGGER.info("Connection opened to host.");
        if (this.cbsLink == null) {
            this.createCBSLinkAsync();
        }
    }

    /**
     * Internal method. Clients should not use this method.
     */
    @Override
    public void onConnectionError(ErrorCondition error) {
        if (error != null && error.getCondition() != null) {
            TRACE_LOGGER.info("Connection error. '{}'", error);
        }

        if (!this.factoryOpenFuture.isDone()) {
            AsyncUtil.completeFutureExceptionally(this.factoryOpenFuture, ExceptionUtil.toException(error));
            this.setClosed();
        } else {
            this.closeConnection(error, null);
        }

        if (this.getIsClosingOrClosed() && !this.connetionCloseFuture.isDone()) {
            TRACE_LOGGER.info("Connection to host closed.");
            AsyncUtil.completeFuture(this.connetionCloseFuture, null);
            Timer.unregister(this.getClientId());
        }
    }

    private void onReactorError(Exception cause) {
        if (!this.factoryOpenFuture.isDone()) {
            TRACE_LOGGER.info("Reactor error occured", cause);
            AsyncUtil.completeFutureExceptionally(this.factoryOpenFuture, cause);
            this.setClosed();
        } else {
            if (this.getIsClosingOrClosed()) {
                return;
            }

            TRACE_LOGGER.info("Reactor error occured", cause);

            try {
                this.startReactor(this.reactorHandler);
            } catch (IOException e) {
                Marker fatalMarker = MarkerFactory.getMarker(ClientConstants.FATAL_MARKER);
                TRACE_LOGGER.info(fatalMarker, "Re-starting reactor failed with exception.", e);
                this.onReactorError(cause);
            }

            this.closeConnection(null, cause);
        }
    }

    // One of the parameters must be null
    private void closeConnection(ErrorCondition error, Exception cause) {
        // Important to copy the reference of the connection as a call to getConnection might create a new connection while we are still in this method
        Connection currentConnection = this.connection;
        if (currentConnection != null) {
            Link[] links = this.registeredLinks.toArray(new Link[0]);
            this.registeredLinks.clear();

            TRACE_LOGGER.debug("Closing all links on the connection. Number of links '{}'", links.length);
            for (Link link : links) {
                link.close();
            }

            TRACE_LOGGER.debug("Closed all links on the connection. Number of links '{}'", links.length);

            if (currentConnection.getLocalState() != EndpointState.CLOSED) {
                TRACE_LOGGER.info("Closing connection to host");
                currentConnection.close();
            }

            for (Link link : links) {
                Handler handler = BaseHandler.getHandler(link);
                if (handler != null && handler instanceof BaseLinkHandler) {
                    BaseLinkHandler linkHandler = (BaseLinkHandler) handler;
                    if (error != null) {
                        linkHandler.processOnClose(link, error);
                    } else {
                        linkHandler.processOnClose(link, cause);
                    }
                }
            }
        }
    }

    @Override
    protected CompletableFuture onClose() {
        if (!this.getIsClosed()) {
            TRACE_LOGGER.info("Closing messaging factory");
            CompletableFuture cbsLinkCloseFuture;
            if (this.cbsLink == null) {
                cbsLinkCloseFuture = CompletableFuture.completedFuture(null);
            } else {
                TRACE_LOGGER.info("Closing CBS link");
                cbsLinkCloseFuture = this.cbsLink.closeAsync();
            }

            cbsLinkCloseFuture.thenRun(() -> this.managementLinksCache.freeAsync()).thenRun(() -> {
                if (this.cbsLinkCreationFuture != null && !this.cbsLinkCreationFuture.isDone()) {
                    this.cbsLinkCreationFuture.completeExceptionally(new Exception("Connection closed."));
                }

                if (this.connection != null && this.connection.getRemoteState() != EndpointState.CLOSED) {
                    try {
                        this.scheduleOnReactorThread(new DispatchHandler() {
                            @Override
                            public void onEvent() {
                                if (MessagingFactory.this.connection != null && MessagingFactory.this.connection.getLocalState() != EndpointState.CLOSED) {
                                    TRACE_LOGGER.info("Closing connection to host");
                                    MessagingFactory.this.connection.close();
                                }
                            }
                        });
                    } catch (IOException e) {
                        this.connetionCloseFuture.completeExceptionally(e);
                    }

                    Timer.schedule(() -> {
                        if (!MessagingFactory.this.connetionCloseFuture.isDone()) {
                            String errorMessage = "Closing MessagingFactory timed out.";
                            TRACE_LOGGER.info(errorMessage);
                            AsyncUtil.completeFutureExceptionally(MessagingFactory.this.connetionCloseFuture, new TimeoutException(errorMessage));
                        }
                    },
                        this.clientSettings.getOperationTimeout(), TimerType.OneTimeRun);
                } else {
                    this.connetionCloseFuture.complete(null);
                    Timer.unregister(this.getClientId());
                }
            });

            return this.connetionCloseFuture;
        } else {
            return CompletableFuture.completedFuture(null);
        }
    }

    private class RunReactor implements Runnable {
        private final Reactor rctr;

        RunReactor() {
            this.rctr = MessagingFactory.this.getReactor();
        }

        public void run() {
            TRACE_LOGGER.info("starting reactor instance.");
            try {
                this.rctr.setTimeout(3141);
                this.rctr.start();
                boolean continueProcessing = true;
                while (!Thread.interrupted() && continueProcessing) {
                    // If factory is closed, stop reactor too
                    if (MessagingFactory.this.getIsClosed()) {
                        TRACE_LOGGER.info("Gracefully releasing reactor thread as messaging factory is closed");
                        break;
                    }
                    continueProcessing = this.rctr.process();
                }
                TRACE_LOGGER.info("Stopping reactor");
                this.rctr.stop();
            } catch (HandlerException handlerException) {
                Throwable cause = handlerException.getCause();
                if (cause == null) {
                    cause = handlerException;
                }

                TRACE_LOGGER.info("UnHandled exception while processing events in reactor:", handlerException);

                String message = !StringUtil.isNullOrEmpty(cause.getMessage())
                        ? cause.getMessage()
                        : !StringUtil.isNullOrEmpty(handlerException.getMessage())
                            ? handlerException.getMessage()
                            : "Reactor encountered unrecoverable error";
                ServiceBusException sbException = new ServiceBusException(
                        true,
                        String.format(Locale.US, "%s, %s", message, ExceptionUtil.getTrackingIDAndTimeToLog()),
                        cause);

                if (cause instanceof UnresolvedAddressException) {
                    sbException = new CommunicationException(
                            String.format(Locale.US, "%s. This is usually caused by incorrect hostname or network configuration. Please check to see if namespace information is correct. %s", message, ExceptionUtil.getTrackingIDAndTimeToLog()),
                            cause);
                }

                MessagingFactory.this.onReactorError(sbException);
            } finally {
                this.rctr.free();
            }
        }
    }

    /**
     * Internal method. Clients should not use this method.
     */
    @Override
    public void registerForConnectionError(Link link) {
        if (link != null) {
            this.registeredLinks.add(link);
        }
    }

    /**
     * Internal method. Clients should not use this method.
     */
    @Override
    public void deregisterForConnectionError(Link link) {
        if (link != null) {
            this.registeredLinks.remove(link);
        }
    }

    void scheduleOnReactorThread(final DispatchHandler handler) throws IOException {
        this.getReactorScheduler().invoke(handler);
    }

    void scheduleOnReactorThread(final int delay, final DispatchHandler handler) throws IOException {
        this.getReactorScheduler().invoke(delay, handler);
    }

    CompletableFuture sendSecurityToken(String sasTokenAudienceUri) {
        TRACE_LOGGER.debug("Sending token for {}", sasTokenAudienceUri);
        CompletableFuture tokenFuture = this.clientSettings.getTokenProvider().getSecurityTokenAsync(sasTokenAudienceUri);
        return tokenFuture.thenComposeAsync((t) -> {
            SecurityToken generatedSecurityToken = t;
            CompletableFuture sendTokenFuture = this.cbsLinkCreationFuture.thenComposeAsync((v) -> CommonRequestResponseOperations.sendCBSTokenAsync(this.cbsLink, Util.adjustServerTimeout(this.clientSettings.getOperationTimeout()), generatedSecurityToken), MessagingFactory.INTERNAL_THREAD_POOL);

            return sendTokenFuture.thenAccept((v) -> TRACE_LOGGER.debug("Sent token for {}", sasTokenAudienceUri));

        }, MessagingFactory.INTERNAL_THREAD_POOL);
    }

    CompletableFuture> sendSecurityTokenAndSetRenewTimer(String sasTokenAudienceURI, boolean retryOnFailure, Runnable validityRenewer) {
        CompletableFuture> result = new CompletableFuture>();
        TRACE_LOGGER.debug("Sending token for {}", sasTokenAudienceURI);
        CompletableFuture sendTokenFuture = this.generateAndSendSecurityToken(sasTokenAudienceURI);
        sendTokenFuture.handleAsync((validUntil, sendTokenEx) -> {
            if (sendTokenEx == null) {
                TRACE_LOGGER.debug("Sent CBS token for {} and setting renew timer", sasTokenAudienceURI);
                ScheduledFuture renewalFuture = MessagingFactory.scheduleRenewTimer(validUntil, validityRenewer);
                result.complete(renewalFuture);
            } else {
                Throwable sendFailureCause = ExceptionUtil.extractAsyncCompletionCause(sendTokenEx);
                TRACE_LOGGER.info("Sending CBS Token for {} failed.", sasTokenAudienceURI, sendFailureCause);
                if (retryOnFailure) {
                    // Just schedule another attempt
                    TRACE_LOGGER.info("Will retry sending CBS Token for {} after {} seconds.", sasTokenAudienceURI, ClientConstants.DEFAULT_SAS_TOKEN_SEND_RETRY_INTERVAL_IN_SECONDS);
                    ScheduledFuture renewalFuture = Timer.schedule(validityRenewer, Duration.ofSeconds(ClientConstants.DEFAULT_SAS_TOKEN_SEND_RETRY_INTERVAL_IN_SECONDS), TimerType.OneTimeRun);
                    result.complete(renewalFuture);
                } else {
                    if (sendFailureCause instanceof TimeoutException) {
                        // Retry immediately on timeout. This is a special case as CBSLink may be disconnected right after the token is sent, but before it reaches the service
                        TRACE_LOGGER.debug("Resending token for {}", sasTokenAudienceURI);
                        CompletableFuture resendTokenFuture = this.generateAndSendSecurityToken(sasTokenAudienceURI);
                        resendTokenFuture.handleAsync((resendValidUntil, resendTokenEx) -> {
                            if (resendTokenEx == null) {
                                TRACE_LOGGER.debug("Sent CBS token for {} and setting renew timer", sasTokenAudienceURI);
                                ScheduledFuture renewalFuture = MessagingFactory.scheduleRenewTimer(resendValidUntil, validityRenewer);
                                result.complete(renewalFuture);
                            } else {
                                Throwable resendFailureCause = ExceptionUtil.extractAsyncCompletionCause(resendTokenEx);
                                TRACE_LOGGER.info("Resending CBS Token for {} failed.", sasTokenAudienceURI, resendFailureCause);
                                result.completeExceptionally(resendFailureCause);
                            }
                            return null;
                        }, MessagingFactory.INTERNAL_THREAD_POOL);
                    } else {
                        result.completeExceptionally(sendFailureCause);
                    }
                }
            }
            return null;
        }, MessagingFactory.INTERNAL_THREAD_POOL);

        return result;
    }

    private CompletableFuture generateAndSendSecurityToken(String sasTokenAudienceURI) {
        CompletableFuture tokenFuture = this.clientSettings.getTokenProvider().getSecurityTokenAsync(sasTokenAudienceURI);
        return tokenFuture.thenComposeAsync((t) -> {
            SecurityToken generatedSecurityToken = t;
            return this.cbsLinkCreationFuture.thenComposeAsync((v) -> CommonRequestResponseOperations.sendCBSTokenAsync(this.cbsLink, ClientConstants.SAS_TOKEN_SEND_TIMEOUT, generatedSecurityToken).thenApply((u) -> generatedSecurityToken.getValidUntil()), MessagingFactory.INTERNAL_THREAD_POOL);
        }, MessagingFactory.INTERNAL_THREAD_POOL);
    }

    private static ScheduledFuture scheduleRenewTimer(Instant currentTokenValidUntil, Runnable validityRenewer) {
        if (currentTokenValidUntil == Instant.MAX) {
            // User provided token or will never expire
            return null;
        } else {
            // It will eventually expire. Renew it
            int renewInterval = Util.getTokenRenewIntervalInSeconds((int) Duration.between(Instant.now(), currentTokenValidUntil).getSeconds());
            return Timer.schedule(validityRenewer, Duration.ofSeconds(renewInterval), TimerType.OneTimeRun);
        }
    }

    CompletableFuture obtainRequestResponseLinkAsync(String entityPath, MessagingEntityType entityType) {
        this.throwIfClosed(null);
        return this.managementLinksCache.obtainRequestResponseLinkAsync(entityPath, null, entityType);
    }

    CompletableFuture obtainRequestResponseLinkAsync(String entityPath, String transferDestinationPath, MessagingEntityType entityType) {
        this.throwIfClosed(null);
        return this.managementLinksCache.obtainRequestResponseLinkAsync(entityPath, transferDestinationPath, entityType);
    }

    void releaseRequestResponseLink(String entityPath) {
        if (!this.getIsClosed()) {
            this.managementLinksCache.releaseRequestResponseLink(entityPath, null);
        }
    }

    void releaseRequestResponseLink(String entityPath, String transferDestinationPath) {
        if (!this.getIsClosed()) {
            this.managementLinksCache.releaseRequestResponseLink(entityPath, transferDestinationPath);
        }
    }

    private void createCBSLinkAsync() {
        if (this.getIsClosingOrClosed()) {
            return;
        }

        if (++this.cbsLinkCreationAttempts > MAX_CBS_LINK_CREATION_ATTEMPTS) {
            Throwable completionEx = this.lastCBSLinkCreationException == null ? new Exception("CBS link creation failed multiple times.") : this.lastCBSLinkCreationException;
            this.cbsLinkCreationFuture.completeExceptionally(completionEx);
        } else {
            String requestResponseLinkPath = RequestResponseLink.getCBSNodeLinkPath();
            TRACE_LOGGER.info("Creating CBS link to {}", requestResponseLinkPath);
            RequestResponseLink.createAsync(this, this.getClientId() + "-cbs", requestResponseLinkPath, null, null, null, null).handleAsync((cbsLink, ex) -> {
                if (ex == null) {
                    TRACE_LOGGER.info("Created CBS link to {}", requestResponseLinkPath);
                    if (this.getIsClosingOrClosed()) {
                        // Factory is closed before CBSLink could be created. Close the created CBS link too
                        cbsLink.closeAsync();
                    } else {
                        this.cbsLink = cbsLink;
                        this.cbsLinkCreationFuture.complete(null);
                    }                    
                } else {
                    this.lastCBSLinkCreationException = ExceptionUtil.extractAsyncCompletionCause(ex);
                    TRACE_LOGGER.info("Creating CBS link to {} failed. Attempts '{}'", requestResponseLinkPath, this.cbsLinkCreationAttempts);
                    this.createCBSLinkAsync();
                }
                return null;
            }, MessagingFactory.INTERNAL_THREAD_POOL);

        }
    }

    private static  T completeFuture(CompletableFuture future) throws InterruptedException, ServiceBusException {
        try {
            return future.get();
        } catch (InterruptedException ie) {
            // Rare instance
            throw ie;
        } catch (ExecutionException ee) {
            Throwable cause = ee.getCause();
            if (cause instanceof ServiceBusException) {
                throw (ServiceBusException) cause;
            } else {
                throw new ServiceBusException(true, cause);
            }
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy