com.azure.core.amqp.AmqpShutdownSignal Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-core-amqp Show documentation

This package contains core types for Azure Java AMQP clients.

There is a newer version: 2.9.12

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.core.amqp;

import com.azure.core.util.logging.LoggingEventBuilder;

/**
 * Represents a signal that caused the AMQP connection to shutdown.
 */
public class AmqpShutdownSignal {
    private final boolean isTransient;
    private final boolean isInitiatedByClient;
    private final String message;

    /**
     * Creates a new instance of the AmqpShutdownSignal.
     *
     * @param isTransient Whether the shutdown signal can be retried or not.
     * @param isInitiatedByClient {@code true} if the shutdown was initiated by the client; {@code false} otherwise.
     * @param message Message associated with the shutdown.
     */
    public AmqpShutdownSignal(boolean isTransient, boolean isInitiatedByClient, String message) {
        this.isTransient = isTransient;
        this.isInitiatedByClient = isInitiatedByClient;
        this.message = message;
    }

    /**
     * Gets whether or not this shutdown signal is transient or if it can be restarted.
     *
     * @return {@code true} if the shutdown signal is transient and the connection, session, or link can be recreated.
     *     {@code false} otherwise.
     */
    public boolean isTransient() {
        return isTransient;
    }

    /**
     * Gets whether or not this shutdown signal was initiated by the client.
     *
     * @return {@code true} if the shutdown signal was initiated by the client, {@code false} if the shutdown signal
     *     occurred in the underlying AMQP layer or from the AMQP message broker.
     */
    public boolean isInitiatedByClient() {
        return isInitiatedByClient;
    }

    /**
     * Returns String representing the message of this {@code AmqpShutdownSignal} signal.
     *
     * To write logs, please use {@link com.azure.core.amqp.implementation.AmqpLoggingUtils#addShutdownSignal(LoggingEventBuilder, AmqpShutdownSignal)}.
     */
    @Override
    public String toString() {
        return message;
    }
}