com.azure.core.credential.AzureNamedKeyCredential Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-core Show documentation
This package contains core types for Azure Java clients.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.core.credential;

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

import java.util.Objects;

/**
 * 
 * The {@link AzureNamedKeyCredential} is used to authenticate and authorize requests made to Azure services.
 * It is specifically designed for scenarios where you need to authenticate using a key with a name identifier
 * associated with it.
 * 
 *
 * 
 * A key is a unique identifier or token that is associated with a specific user or application. It serves as a
 * simple form of authentication to ensure that only authorized clients can access the protected resources or APIs.
 * This authentication is commonly used for accessing certain services, such as Azure Tables and Azure Event Hubs.
 * Each service may have its own specific way of using API keys, but the general concept remains the same.
 * 
 *
 * 
 * The {@link com.azure.core.credential.AzureNamedKeyCredential} can be created for keys which have a name
 * identifier associated with them.
 * 
 *
 * 
 * Code Samples
 * 
 *
 * 
 * Create a named credential for a service specific sas key.
 * 
 *
 * 
 *  * AzureNamedKeyCredential azureNamedKeyCredential =
 *     new AzureNamedKeyCredential("AZURE-SERVICE-SAS-KEY-NAME", "AZURE-SERVICE-SAS-KEY");
 * 
 * 
 *
 * @see com.azure.core.credential
 */
public final class AzureNamedKeyCredential {
    // AzureNamedKeyCredential is a commonly used credential type, use a static logger.
    private static final ClientLogger LOGGER = new ClientLogger(AzureNamedKeyCredential.class);

    private volatile AzureNamedKey credentials;

    /**
     * Creates a credential with specified {@code name} that authorizes request with the given {@code key}.
     *
     * @param name The name of the key credential.
     * @param key The key used to authorize requests.
     * @throws NullPointerException If {@code key} or {@code name} is {@code null}.
     * @throws IllegalArgumentException If {@code key} or {@code name} is an empty string.
     */
    public AzureNamedKeyCredential(String name, String key) {
        validateInputParameters(name, key);
        this.credentials = new AzureNamedKey(name, key);
    }

    /**
     * Retrieves the {@link AzureNamedKey} containing the name and key associated with this credential.
     *
     * @return The {@link AzureNamedKey} containing the name and key .
     */
    public AzureNamedKey getAzureNamedKey() {
        return this.credentials;
    }

    /**
     * Rotates the {@code name} and  {@code key} associated to this credential.
     *
     * @param name The new name of the key credential.
     * @param key The new key to be associated with this credential.
     * @return The updated {@code AzureNamedKeyCredential} object.
     * @throws NullPointerException If {@code key} or {@code name} is {@code null}.
     * @throws IllegalArgumentException If {@code key} or {@code name} is an empty string.
     */
    public AzureNamedKeyCredential update(String name, String key) {
        validateInputParameters(name, key);
        this.credentials = new AzureNamedKey(name, key);
        return this;
    }

    private void validateInputParameters(String name, String key) {
        Objects.requireNonNull(name, "'name' cannot be null.");
        Objects.requireNonNull(key, "'key' cannot be null.");
        if (name.isEmpty()) {
            throw LOGGER.logExceptionAsError(new IllegalArgumentException("'name' cannot be empty."));
        }
        if (key.isEmpty()) {
            throw LOGGER.logExceptionAsError(new IllegalArgumentException("'key' cannot be empty."));
        }
    }
}