com.azure.security.keyvault.keys.cryptography.models.UnwrapResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-security-keyvault-keys Show documentation

This module contains client library for Microsoft Azure KeyVault Keys.

There is a newer version: 4.9.0

Show newest version

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

package com.azure.security.keyvault.keys.cryptography.models;

import com.azure.core.annotation.Immutable;
import com.azure.core.util.CoreUtils;

/**
 * Represents the details of key unwrap operation result.
 */
@Immutable
public final class UnwrapResult {
    /**
     * The unwrapped key content.
     */
    private final byte[] key;

    /**
     * The algorithm used for the key wrap operation.
     */
    private final KeyWrapAlgorithm algorithm;

    /**
     * The identifier of the key used for the key wrap operation.
     */
    private final String keyId;

    /**
     * Creates the instance of KeyUnwrap Result holding the unwrapped key content.
     *
     * @param key The unwrapped key content.
     * @param algorithm The algorithm used for the operation
     * @param keyId The id of key used for the operation
     */
    public UnwrapResult(byte[] key, KeyWrapAlgorithm algorithm, String keyId) {
        this.key = CoreUtils.clone(key);
        this.algorithm = algorithm;
        this.keyId = keyId;
    }

    /**
     * Get the unwrapped key content.
     *
     * @return The unwrapped key content.
     */
    public byte[] getKey() {
        return CoreUtils.clone(key);
    }

    /**
     * Get the algorithm used for key wrap operation.
     *
     * @return The encryption algorithm used.
     */
    public KeyWrapAlgorithm getAlgorithm() {
        return algorithm;
    }

    /**
     * Get the identifier of the key used for the key wrap encryption
     *
     * @return the key identifier
     */
    public String getKeyId() {
        return keyId;
    }
}