com.azure.core.amqp.ClaimsBasedSecurityNode 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.

The newest version!

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

package com.azure.core.amqp;

import com.azure.core.credential.TokenCredential;
import com.azure.core.util.AsyncCloseable;
import reactor.core.publisher.Mono;

import java.time.OffsetDateTime;

/**
 * Claims-based security (CBS) node that authorizes connections with AMQP services.
 *
 * @see 
 * AMQP Claims-based Security v1.0
 */
public interface ClaimsBasedSecurityNode extends AutoCloseable, AsyncCloseable {
    /**
     * Authorizes the caller with the CBS node to access resources for the {@code audience}.
     *
     * @param audience The audience to which the token applies. This can be the path within the AMQP message broker.
     * @param scopes The requested scopes for the {@link TokenCredential}.
     * @return A Mono that completes with the callee's expiration date if it is successful and errors if
     * authorization was unsuccessful. Once the expiration date has elapsed, the callee needs to reauthorize with the
     * CBS node.
     */
    Mono authorize(String audience, String scopes);

    /**
     * Closes session to the claims-based security node.
     */
    @Override
    void close();

    @Override
    default Mono closeAsync() {
        return Mono.fromRunnable(() -> close());
    }
}