Package com.oracle.bmc.keymanagement

Class KmsHsmClusterClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.keymanagement.KmsHsmClusterClient

All Implemented Interfaces:

KmsHsmCluster, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public class KmsHsmClusterClient
extends BaseSyncClient
implements KmsHsmCluster

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KmsHsmClusterClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for KmsHsmCluster.

Constructor Summary

Constructors

Constructor	Description
KmsHsmClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
KmsHsmClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
KmsHsmClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
KmsHsmClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
KmsHsmClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
KmsHsmClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
KmsHsmClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
KmsHsmClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static KmsHsmClusterClient.Builder	builder()	Create a builder for this client.
CancelHsmClusterDeletionResponse	cancelHsmClusterDeletion(CancelHsmClusterDeletionRequest request)	Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.
ChangeHsmClusterCompartmentResponse	changeHsmClusterCompartment(ChangeHsmClusterCompartmentRequest request)	Moves a HSM Cluster resource to a different compartment within the same tenancy.
void	close()
CreateHsmClusterResponse	createHsmCluster(CreateHsmClusterRequest request)	Creates a new HSM cluster resource.
DownloadCertificateSigningRequestResponse	downloadCertificateSigningRequest(DownloadCertificateSigningRequestRequest request)	Retrieves the certificate signing request for the designated HSM Cluster resource.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetHsmClusterResponse	getHsmCluster(GetHsmClusterRequest request)	Retrieves configuration details for the specified HSM Cluster resource.
GetHsmPartitionResponse	getHsmPartition(GetHsmPartitionRequest request)	Retrieves HSM partition details for the specified HSM cluster.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
KmsHsmClusterPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPreCoUserCredentialsResponse	getPreCoUserCredentials(GetPreCoUserCredentialsRequest request)	Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.
KmsHsmClusterWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListHsmClustersResponse	listHsmClusters(ListHsmClustersRequest request)	Lists all HSM cluster resources contained within the specified compartment.
ListHsmPartitionsResponse	listHsmPartitions(ListHsmPartitionsRequest request)	Lists all HSM partitions within the specified HSM Cluster resource.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
ScheduleHsmClusterDeletionResponse	scheduleHsmClusterDeletion(ScheduleHsmClusterDeletionRequest request)	Schedules HSM cluster for deletion, update its lifecycle state to ‘PENDING_DELETION’ and deletes it after the retention period.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateHsmClusterResponse	updateHsmCluster(UpdateHsmClusterRequest request)	Modifies properties of an HSM cluster resource, including displayName, freeformTags and definedTags.
UploadPartitionCertificatesResponse	uploadPartitionCertificates(UploadPartitionCertificatesRequest request)	Uploads the partition owner certificates to the HSM Cluster resource.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.keymanagement.KmsHsmCluster

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for KmsHsmCluster.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

KmsHsmClusterClient

@Deprecated
public KmsHsmClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KmsHsmClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

KmsHsmClusterClient

@Deprecated
public KmsHsmClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KmsHsmClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

KmsHsmClusterClient

@Deprecated
public KmsHsmClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KmsHsmClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

KmsHsmClusterClient

@Deprecated
public KmsHsmClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KmsHsmClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

KmsHsmClusterClient

@Deprecated
public KmsHsmClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KmsHsmClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

KmsHsmClusterClient

@Deprecated
public KmsHsmClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KmsHsmClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

KmsHsmClusterClient

@Deprecated
public KmsHsmClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KmsHsmClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

KmsHsmClusterClient

@Deprecated
public KmsHsmClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint,
                           ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KmsHsmClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - KmsHsmClusterClient.Builder.executorService

Method Detail

builder

public static KmsHsmClusterClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: KmsHsmCluster

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.

Specified by:

setRegion in interface KmsHsmCluster

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: KmsHsmCluster

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.

Specified by:

setRegion in interface KmsHsmCluster

Parameters:

regionId - The public region ID.

cancelHsmClusterDeletion

public CancelHsmClusterDeletionResponse cancelHsmClusterDeletion(CancelHsmClusterDeletionRequest request)

Description copied from interface: KmsHsmCluster

Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.

Specified by:

cancelHsmClusterDeletion in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeHsmClusterCompartment

public ChangeHsmClusterCompartmentResponse changeHsmClusterCompartment(ChangeHsmClusterCompartmentRequest request)

Description copied from interface: KmsHsmCluster

Moves a HSM Cluster resource to a different compartment within the same tenancy.

Specified by:

changeHsmClusterCompartment in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createHsmCluster

public CreateHsmClusterResponse createHsmCluster(CreateHsmClusterRequest request)

Description copied from interface: KmsHsmCluster

Creates a new HSM cluster resource.

Specified by:

createHsmCluster in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

downloadCertificateSigningRequest

public DownloadCertificateSigningRequestResponse downloadCertificateSigningRequest(DownloadCertificateSigningRequestRequest request)

Description copied from interface: KmsHsmCluster

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

Specified by:

downloadCertificateSigningRequest in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getHsmCluster

public GetHsmClusterResponse getHsmCluster(GetHsmClusterRequest request)

Description copied from interface: KmsHsmCluster

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.

Specified by:

getHsmCluster in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getHsmPartition

public GetHsmPartitionResponse getHsmPartition(GetHsmPartitionRequest request)

Description copied from interface: KmsHsmCluster

Retrieves HSM partition details for the specified HSM cluster.

Specified by:

getHsmPartition in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPreCoUserCredentials

public GetPreCoUserCredentialsResponse getPreCoUserCredentials(GetPreCoUserCredentialsRequest request)

Description copied from interface: KmsHsmCluster

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

Specified by:

getPreCoUserCredentials in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listHsmClusters

public ListHsmClustersResponse listHsmClusters(ListHsmClustersRequest request)

Description copied from interface: KmsHsmCluster

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.

Specified by:

listHsmClusters in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listHsmPartitions

public ListHsmPartitionsResponse listHsmPartitions(ListHsmPartitionsRequest request)

Description copied from interface: KmsHsmCluster

Lists all HSM partitions within the specified HSM Cluster resource.

Specified by:

listHsmPartitions in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

scheduleHsmClusterDeletion

public ScheduleHsmClusterDeletionResponse scheduleHsmClusterDeletion(ScheduleHsmClusterDeletionRequest request)

Description copied from interface: KmsHsmCluster

Schedules HSM cluster for deletion, update its lifecycle state to ‘PENDING_DELETION’ and deletes it after the retention period.

Specified by:

scheduleHsmClusterDeletion in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateHsmCluster

public UpdateHsmClusterResponse updateHsmCluster(UpdateHsmClusterRequest request)

Description copied from interface: KmsHsmCluster

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.

Specified by:

updateHsmCluster in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

uploadPartitionCertificates

public UploadPartitionCertificatesResponse uploadPartitionCertificates(UploadPartitionCertificatesRequest request)

Description copied from interface: KmsHsmCluster

Uploads the partition owner certificates to the HSM Cluster resource.

Specified by:

uploadPartitionCertificates in interface KmsHsmCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public KmsHsmClusterWaiters getWaiters()

Description copied from interface: KmsHsmCluster

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface KmsHsmCluster

Returns:

The service waiters.

getPaginators

public KmsHsmClusterPaginators getPaginators()

Description copied from interface: KmsHsmCluster

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.

Specified by:

getPaginators in interface KmsHsmCluster

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()