Package com.oracle.bmc.keymanagement

Interface KmsHsmCluster

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    KmsHsmClusterClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public interface KmsHsmCluster
extends AutoCloseable
    Use the Key Management API to manage vaults and keys.

    For more information, see Managing Vaults and Managing Keys.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • 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 service.

      • getEndpoint

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

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • cancelHsmClusterDeletion

        CancelHsmClusterDeletionResponse cancelHsmClusterDeletion​(CancelHsmClusterDeletionRequest request)
        Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/CancelHsmClusterDeletionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelHsmClusterDeletion API.

      • changeHsmClusterCompartment

        ChangeHsmClusterCompartmentResponse changeHsmClusterCompartment​(ChangeHsmClusterCompartmentRequest request)
        Moves a HSM Cluster resource to a different compartment within the same tenancy.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/ChangeHsmClusterCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeHsmClusterCompartment API.

      • createHsmCluster

        CreateHsmClusterResponse createHsmCluster​(CreateHsmClusterRequest request)
        Creates a new HSM cluster resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/CreateHsmClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateHsmCluster API.

      • downloadCertificateSigningRequest

        DownloadCertificateSigningRequestResponse downloadCertificateSigningRequest​(DownloadCertificateSigningRequestRequest request)
        Retrieves the certificate signing request for the designated HSM Cluster resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/DownloadCertificateSigningRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DownloadCertificateSigningRequest API.

      • getHsmCluster

        GetHsmClusterResponse getHsmCluster​(GetHsmClusterRequest request)
        Retrieves configuration details for the specified HSM Cluster resource.

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

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/GetHsmClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetHsmCluster API.

      • getHsmPartition

        GetHsmPartitionResponse getHsmPartition​(GetHsmPartitionRequest request)
        Retrieves HSM partition details for the specified HSM cluster.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/GetHsmPartitionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetHsmPartition API.

      • getPreCoUserCredentials

        GetPreCoUserCredentialsResponse getPreCoUserCredentials​(GetPreCoUserCredentialsRequest request)
        Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/GetPreCoUserCredentialsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPreCoUserCredentials API.

      • listHsmClusters

        ListHsmClustersResponse listHsmClusters​(ListHsmClustersRequest request)
        Lists all HSM cluster resources contained within the specified compartment.

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

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/ListHsmClustersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListHsmClusters API.

      • listHsmPartitions

        ListHsmPartitionsResponse listHsmPartitions​(ListHsmPartitionsRequest request)
        Lists all HSM partitions within the specified HSM Cluster resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/ListHsmPartitionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListHsmPartitions API.

      • scheduleHsmClusterDeletion

        ScheduleHsmClusterDeletionResponse scheduleHsmClusterDeletion​(ScheduleHsmClusterDeletionRequest request)
        Schedules HSM cluster for deletion, update its lifecycle state to ‘PENDING_DELETION’ and deletes it after the retention period.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/ScheduleHsmClusterDeletionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ScheduleHsmClusterDeletion API.

      • updateHsmCluster

        UpdateHsmClusterResponse updateHsmCluster​(UpdateHsmClusterRequest request)
        Modifies properties of an HSM cluster resource, including displayName, freeformTags and definedTags.

        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/UpdateHsmClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateHsmCluster API.

      • uploadPartitionCertificates

        UploadPartitionCertificatesResponse uploadPartitionCertificates​(UploadPartitionCertificatesRequest request)
        Uploads the partition owner certificates to the HSM Cluster resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/keymanagement/UploadPartitionCertificatesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UploadPartitionCertificates API.

      • getWaiters

        KmsHsmClusterWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        KmsHsmClusterPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.