com.microsoft.azure.servicebus.InitializableEntity Maven / Gradle / Ivy

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

Java library for Azure Service Bus. Please note, a newer package com.azure:azure-messaging-servicebus for Azure Service Bus is available as of December 2020. While this package will continue to receive critical bug fixes, we strongly encourage you to upgrade. Read the migration guide at https://aka.ms/azsdk/java/migrate/sb for more details.

There is a newer version: 3.6.7

Show newest version

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

package com.microsoft.azure.servicebus;

import java.util.concurrent.CompletableFuture;

import com.microsoft.azure.servicebus.primitives.ClientEntity;

/**
 * Represents an entity that needs to be initialized before using. This class defines a standard way of properly initializing client objects.
 *
 * @since 1.0
 */
abstract class InitializableEntity extends ClientEntity {

    //TODO Init and close semantics are primitive now. Fix them with support for other states like Initializing, Closing, and concurrency.
    protected InitializableEntity(String clientId, ClientEntity parent) {
        super(clientId, parent);
    }

    /**
     * Initializes this object. This method is asynchronous and returns a CompletableFuture immediately. Initializing of the object is complete when the returned future completes.
     *
     * @return CompletableFuture representing the initialization
     */
    abstract CompletableFuture initializeAsync();

}