Package com.oracle.bmc.keymanagement

Interface KmsManagementAsync

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the serice.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • backupKey

        Future<BackupKeyResponse> backupKey​(BackupKeyRequest request,
                                    AsyncHandler<BackupKeyRequest,​BackupKeyResponse> handler)
        Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore the key later.

        The file also contains the metadata of the vault that the key belonged to.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • cancelKeyDeletion

        Future<CancelKeyDeletionResponse> cancelKeyDeletion​(CancelKeyDeletionRequest request,
                                                    AsyncHandler<CancelKeyDeletionRequest,​CancelKeyDeletionResponse> handler)
        Cancels the scheduled deletion of the specified key.

        Canceling a scheduled deletion restores the key’s lifecycle state to what it was before its scheduled deletion.

        As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • cancelKeyVersionDeletion

        Future<CancelKeyVersionDeletionResponse> cancelKeyVersionDeletion​(CancelKeyVersionDeletionRequest request,
                                                                  AsyncHandler<CancelKeyVersionDeletionRequest,​CancelKeyVersionDeletionResponse> handler)
        Cancels the scheduled deletion of the specified key version.

        Canceling a scheduled deletion restores the key version to its lifecycle state from before its scheduled deletion.

        As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • changeKeyCompartment

        Future<ChangeKeyCompartmentResponse> changeKeyCompartment​(ChangeKeyCompartmentRequest request,
                                                          AsyncHandler<ChangeKeyCompartmentRequest,​ChangeKeyCompartmentResponse> handler)
        Moves a key into a different compartment within the same tenancy.

        For information about moving resources between compartments, see Moving Resources to a Different Compartment.

        When provided, if-match is checked against the ETag values of the key.

        As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createKey

        Future<CreateKeyResponse> createKey​(CreateKeyRequest request,
                                    AsyncHandler<CreateKeyRequest,​CreateKeyResponse> handler)
        Creates a new master encryption key.

        As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createKeyVersion

        Future<CreateKeyVersionResponse> createKeyVersion​(CreateKeyVersionRequest request,
                                                  AsyncHandler<CreateKeyVersionRequest,​CreateKeyVersionResponse> handler)
        Generates a new KeyVersion resource that provides new cryptographic material for a master encryption key.

        The key must be in an ENABLED state to be rotated.

        As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • disableKey

        Future<DisableKeyResponse> disableKey​(DisableKeyRequest request,
                                      AsyncHandler<DisableKeyRequest,​DisableKeyResponse> handler)
        Disables a master encryption key so it can no longer be used for encryption, decryption, or generating new data encryption keys.

        As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • enableKey

        Future<EnableKeyResponse> enableKey​(EnableKeyRequest request,
                                    AsyncHandler<EnableKeyRequest,​EnableKeyResponse> handler)
        Enables a master encryption key so it can be used for encryption, decryption, or generating new data encryption keys.

        As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getKey

        Future<GetKeyResponse> getKey​(GetKeyRequest request,
                              AsyncHandler<GetKeyRequest,​GetKeyResponse> handler)
        Gets information about the specified master encryption key.

        As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getKeyVersion

        Future<GetKeyVersionResponse> getKeyVersion​(GetKeyVersionRequest request,
                                            AsyncHandler<GetKeyVersionRequest,​GetKeyVersionResponse> handler)
        Gets information about the specified key version.

        As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getReplicationStatus

        Future<GetReplicationStatusResponse> getReplicationStatus​(GetReplicationStatusRequest request,
                                                          AsyncHandler<GetReplicationStatusRequest,​GetReplicationStatusResponse> handler)
        When a vault has a replica, each operation on the vault or its resources, such as keys, is replicated and has an associated replicationId.

        Replication status provides details about whether the operation associated with the given replicationId has been successfully applied across replicas.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getWrappingKey

        Future<GetWrappingKeyResponse> getWrappingKey​(GetWrappingKeyRequest request,
                                              AsyncHandler<GetWrappingKeyRequest,​GetWrappingKeyResponse> handler)
        Gets details about the public RSA wrapping key associated with the vault in the endpoint.

        Each vault has an RSA key-pair that wraps and unwraps AES key material for import into Key Management.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • importKey

        Future<ImportKeyResponse> importKey​(ImportKeyRequest request,
                                    AsyncHandler<ImportKeyRequest,​ImportKeyResponse> handler)
        Imports AES and RSA keys to create a new key.

        The key material must be base64-encoded and wrapped by the vault’s public RSA wrapping key before you can import it. Key Management supports both RSA and AES keys. The AES keys are symmetric keys of length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes). Furthermore, the key length must match what you specify at the time of import. When importing an asymmetric key, only private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • importKeyVersion

        Future<ImportKeyVersionResponse> importKeyVersion​(ImportKeyVersionRequest request,
                                                  AsyncHandler<ImportKeyVersionRequest,​ImportKeyVersionResponse> handler)
        Imports AES key material to create a new key version and then rotate the key to begin using the new key version.

        The key material must be base64-encoded and wrapped by the vault’s public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match the length of the specified key and what you specify as the length at the time of import. When importing an asymmetric key, only the private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listKeyVersions

        Future<ListKeyVersionsResponse> listKeyVersions​(ListKeyVersionsRequest request,
                                                AsyncHandler<ListKeyVersionsRequest,​ListKeyVersionsResponse> handler)
        Lists all KeyVersion resources for the specified master encryption key.

        As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listKeys

        Future<ListKeysResponse> listKeys​(ListKeysRequest request,
                                  AsyncHandler<ListKeysRequest,​ListKeysResponse> handler)
        Lists the master encryption keys in the specified vault and compartment.

        As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • restoreKeyFromFile

        Future<RestoreKeyFromFileResponse> restoreKeyFromFile​(RestoreKeyFromFileRequest request,
                                                      AsyncHandler<RestoreKeyFromFileRequest,​RestoreKeyFromFileResponse> handler)
        Restores the specified key to the specified vault, based on information in the backup file provided.

        If the vault doesn’t exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • restoreKeyFromObjectStore

        Future<RestoreKeyFromObjectStoreResponse> restoreKeyFromObjectStore​(RestoreKeyFromObjectStoreRequest request,
                                                                    AsyncHandler<RestoreKeyFromObjectStoreRequest,​RestoreKeyFromObjectStoreResponse> handler)
        Restores the specified key to the specified vault from an Oracle Cloud Infrastructure Object Storage location.

        If the vault doesn’t exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • scheduleKeyDeletion

        Future<ScheduleKeyDeletionResponse> scheduleKeyDeletion​(ScheduleKeyDeletionRequest request,
                                                        AsyncHandler<ScheduleKeyDeletionRequest,​ScheduleKeyDeletionResponse> handler)
        Schedules the deletion of the specified key.

        This sets the lifecycle state of the key to PENDING_DELETION and then deletes it after the specified retention period ends.

        As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • scheduleKeyVersionDeletion

        Future<ScheduleKeyVersionDeletionResponse> scheduleKeyVersionDeletion​(ScheduleKeyVersionDeletionRequest request,
                                                                      AsyncHandler<ScheduleKeyVersionDeletionRequest,​ScheduleKeyVersionDeletionResponse> handler)
        Schedules the deletion of the specified key version.

        This sets the lifecycle state of the key version to PENDING_DELETION and then deletes it after the specified retention period ends.

        As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateKey

        Future<UpdateKeyResponse> updateKey​(UpdateKeyRequest request,
                                    AsyncHandler<UpdateKeyRequest,​UpdateKeyResponse> handler)
        Updates the properties of a master encryption key.

        Specifically, you can update the displayName, freeformTags, and definedTags properties. Furthermore, the key must be in an ENABLED or CREATING state to be updated.

        As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.