com.oracle.bmc.keymanagement

Interface KmsHsmClusterAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

KmsHsmClusterAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public interface KmsHsmClusterAsync
extends AutoCloseable

Use the Key Management API to manage vaults and keys. For more information, see Managing Vaults and Managing Keys.

Method Summary

Modifier and Type	Method and Description
Future<CancelHsmClusterDeletionResponse>	cancelHsmClusterDeletion(CancelHsmClusterDeletionRequest request, AsyncHandler<CancelHsmClusterDeletionRequest,CancelHsmClusterDeletionResponse> handler) Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.
Future<ChangeHsmClusterCompartmentResponse>	changeHsmClusterCompartment(ChangeHsmClusterCompartmentRequest request, AsyncHandler<ChangeHsmClusterCompartmentRequest,ChangeHsmClusterCompartmentResponse> handler) Moves a HSM Cluster resource to a different compartment within the same tenancy.
Future<CreateHsmClusterResponse>	createHsmCluster(CreateHsmClusterRequest request, AsyncHandler<CreateHsmClusterRequest,CreateHsmClusterResponse> handler) Creates a new HSM cluster resource.
Future<DownloadCertificateSigningRequestResponse>	downloadCertificateSigningRequest(DownloadCertificateSigningRequestRequest request, AsyncHandler<DownloadCertificateSigningRequestRequest,DownloadCertificateSigningRequestResponse> handler) Retrieves the certificate signing request for the designated HSM Cluster resource.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetHsmClusterResponse>	getHsmCluster(GetHsmClusterRequest request, AsyncHandler<GetHsmClusterRequest,GetHsmClusterResponse> handler) Retrieves configuration details for the specified HSM Cluster resource.
Future<GetHsmPartitionResponse>	getHsmPartition(GetHsmPartitionRequest request, AsyncHandler<GetHsmPartitionRequest,GetHsmPartitionResponse> handler) Retrieves HSM partition details for the specified HSM cluster.
Future<GetPreCoUserCredentialsResponse>	getPreCoUserCredentials(GetPreCoUserCredentialsRequest request, AsyncHandler<GetPreCoUserCredentialsRequest,GetPreCoUserCredentialsResponse> handler) Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.
Future<ListHsmClustersResponse>	listHsmClusters(ListHsmClustersRequest request, AsyncHandler<ListHsmClustersRequest,ListHsmClustersResponse> handler) Lists all HSM cluster resources contained within the specified compartment.
Future<ListHsmPartitionsResponse>	listHsmPartitions(ListHsmPartitionsRequest request, AsyncHandler<ListHsmPartitionsRequest,ListHsmPartitionsResponse> handler) Lists all HSM partitions within the specified HSM Cluster resource.
void	refreshClient() Rebuilds the client from scratch.
Future<ScheduleHsmClusterDeletionResponse>	scheduleHsmClusterDeletion(ScheduleHsmClusterDeletionRequest request, AsyncHandler<ScheduleHsmClusterDeletionRequest,ScheduleHsmClusterDeletionResponse> handler) Schedules HSM cluster for deletion, update its lifecycle state to ‘PENDING_DELETION’ and deletes it after the retention period.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<UpdateHsmClusterResponse>	updateHsmCluster(UpdateHsmClusterRequest request, AsyncHandler<UpdateHsmClusterRequest,UpdateHsmClusterResponse> handler) Modifies properties of an HSM cluster resource, including displayName, freeformTags and definedTags.
Future<UploadPartitionCertificatesResponse>	uploadPartitionCertificates(UploadPartitionCertificatesRequest request, AsyncHandler<UploadPartitionCertificatesRequest,UploadPartitionCertificatesResponse> handler) Uploads the partition owner certificates to the HSM Cluster resource.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

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)

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

Future<CancelHsmClusterDeletionResponse> cancelHsmClusterDeletion(CancelHsmClusterDeletionRequest request,
                                                                  AsyncHandler<CancelHsmClusterDeletionRequest,CancelHsmClusterDeletionResponse> handler)

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

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.

changeHsmClusterCompartment

Future<ChangeHsmClusterCompartmentResponse> changeHsmClusterCompartment(ChangeHsmClusterCompartmentRequest request,
                                                                        AsyncHandler<ChangeHsmClusterCompartmentRequest,ChangeHsmClusterCompartmentResponse> handler)

Moves a HSM Cluster resource to a different compartment within the same 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.

createHsmCluster

Future<CreateHsmClusterResponse> createHsmCluster(CreateHsmClusterRequest request,
                                                  AsyncHandler<CreateHsmClusterRequest,CreateHsmClusterResponse> handler)

Creates a new HSM cluster resource.

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.

downloadCertificateSigningRequest

Future<DownloadCertificateSigningRequestResponse> downloadCertificateSigningRequest(DownloadCertificateSigningRequestRequest request,
                                                                                    AsyncHandler<DownloadCertificateSigningRequestRequest,DownloadCertificateSigningRequestResponse> handler)

Retrieves the certificate signing request for the designated HSM Cluster resource.

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.

getHsmCluster

Future<GetHsmClusterResponse> getHsmCluster(GetHsmClusterRequest request,
                                            AsyncHandler<GetHsmClusterRequest,GetHsmClusterResponse> handler)

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

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.

getHsmPartition

Future<GetHsmPartitionResponse> getHsmPartition(GetHsmPartitionRequest request,
                                                AsyncHandler<GetHsmPartitionRequest,GetHsmPartitionResponse> handler)

Retrieves HSM partition details for the specified HSM cluster.

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.

getPreCoUserCredentials

Future<GetPreCoUserCredentialsResponse> getPreCoUserCredentials(GetPreCoUserCredentialsRequest request,
                                                                AsyncHandler<GetPreCoUserCredentialsRequest,GetPreCoUserCredentialsResponse> handler)

Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.

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.

listHsmClusters

Future<ListHsmClustersResponse> listHsmClusters(ListHsmClustersRequest request,
                                                AsyncHandler<ListHsmClustersRequest,ListHsmClustersResponse> handler)

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

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.

listHsmPartitions

Future<ListHsmPartitionsResponse> listHsmPartitions(ListHsmPartitionsRequest request,
                                                    AsyncHandler<ListHsmPartitionsRequest,ListHsmPartitionsResponse> handler)

Lists all HSM partitions within the specified HSM Cluster resource.

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.

scheduleHsmClusterDeletion

Future<ScheduleHsmClusterDeletionResponse> scheduleHsmClusterDeletion(ScheduleHsmClusterDeletionRequest request,
                                                                      AsyncHandler<ScheduleHsmClusterDeletionRequest,ScheduleHsmClusterDeletionResponse> handler)

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

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.

updateHsmCluster

Future<UpdateHsmClusterResponse> updateHsmCluster(UpdateHsmClusterRequest request,
                                                  AsyncHandler<UpdateHsmClusterRequest,UpdateHsmClusterResponse> handler)

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

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.

uploadPartitionCertificates

Future<UploadPartitionCertificatesResponse> uploadPartitionCertificates(UploadPartitionCertificatesRequest request,
                                                                        AsyncHandler<UploadPartitionCertificatesRequest,UploadPartitionCertificatesResponse> handler)

Uploads the partition owner certificates to the HSM Cluster resource.

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.