Package com.oracle.bmc.certificatesmanagement

Class CertificatesManagementAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.certificatesmanagement.CertificatesManagementAsyncClient

All Implemented Interfaces:

CertificatesManagementAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210224")
public class CertificatesManagementAsyncClient
extends BaseAsyncClient
implements CertificatesManagementAsync

Async client implementation for CertificatesManagement service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CertificatesManagementAsyncClient.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 CertificatesManagement.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CertificatesManagementAsyncClient.Builder	builder()	Create a builder for this client.
Future<CancelCertificateAuthorityDeletionResponse>	cancelCertificateAuthorityDeletion(CancelCertificateAuthorityDeletionRequest request, AsyncHandler<CancelCertificateAuthorityDeletionRequest,CancelCertificateAuthorityDeletionResponse> handler)	Cancels the scheduled deletion of the specified certificate authority (CA).
Future<CancelCertificateAuthorityVersionDeletionResponse>	cancelCertificateAuthorityVersionDeletion(CancelCertificateAuthorityVersionDeletionRequest request, AsyncHandler<CancelCertificateAuthorityVersionDeletionRequest,CancelCertificateAuthorityVersionDeletionResponse> handler)	Cancels the scheduled deletion of the specified certificate authority (CA) version.
Future<CancelCertificateDeletionResponse>	cancelCertificateDeletion(CancelCertificateDeletionRequest request, AsyncHandler<CancelCertificateDeletionRequest,CancelCertificateDeletionResponse> handler)	Cancels the pending deletion of the specified certificate.
Future<CancelCertificateVersionDeletionResponse>	cancelCertificateVersionDeletion(CancelCertificateVersionDeletionRequest request, AsyncHandler<CancelCertificateVersionDeletionRequest,CancelCertificateVersionDeletionResponse> handler)	Cancels the scheduled deletion of the specified certificate version.
Future<ChangeCaBundleCompartmentResponse>	changeCaBundleCompartment(ChangeCaBundleCompartmentRequest request, AsyncHandler<ChangeCaBundleCompartmentRequest,ChangeCaBundleCompartmentResponse> handler)	Moves a CA bundle to a different compartment in the same tenancy.
Future<ChangeCertificateAuthorityCompartmentResponse>	changeCertificateAuthorityCompartment(ChangeCertificateAuthorityCompartmentRequest request, AsyncHandler<ChangeCertificateAuthorityCompartmentRequest,ChangeCertificateAuthorityCompartmentResponse> handler)	Moves a certificate authority (CA) to a different compartment within the same tenancy.
Future<ChangeCertificateCompartmentResponse>	changeCertificateCompartment(ChangeCertificateCompartmentRequest request, AsyncHandler<ChangeCertificateCompartmentRequest,ChangeCertificateCompartmentResponse> handler)	Moves a certificate to a different compartment within the same tenancy.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateCaBundleResponse>	createCaBundle(CreateCaBundleRequest request, AsyncHandler<CreateCaBundleRequest,CreateCaBundleResponse> handler)	Creates a new CA bundle according to the details of the request.
Future<CreateCertificateResponse>	createCertificate(CreateCertificateRequest request, AsyncHandler<CreateCertificateRequest,CreateCertificateResponse> handler)	Creates a new certificate according to the details of the request.
Future<CreateCertificateAuthorityResponse>	createCertificateAuthority(CreateCertificateAuthorityRequest request, AsyncHandler<CreateCertificateAuthorityRequest,CreateCertificateAuthorityResponse> handler)	Creates a new certificate authority (CA) according to the details of the request.
Future<DeleteCaBundleResponse>	deleteCaBundle(DeleteCaBundleRequest request, AsyncHandler<DeleteCaBundleRequest,DeleteCaBundleResponse> handler)	Deletes the specified CA bundle.
Future<GetAssociationResponse>	getAssociation(GetAssociationRequest request, AsyncHandler<GetAssociationRequest,GetAssociationResponse> handler)	Gets details about the specified association.
Future<GetCaBundleResponse>	getCaBundle(GetCaBundleRequest request, AsyncHandler<GetCaBundleRequest,GetCaBundleResponse> handler)	Gets details about the specified CA bundle.
Future<GetCertificateResponse>	getCertificate(GetCertificateRequest request, AsyncHandler<GetCertificateRequest,GetCertificateResponse> handler)	Gets details about the specified certificate.
Future<GetCertificateAuthorityResponse>	getCertificateAuthority(GetCertificateAuthorityRequest request, AsyncHandler<GetCertificateAuthorityRequest,GetCertificateAuthorityResponse> handler)	Gets details about the specified certificate authority (CA).
Future<GetCertificateAuthorityVersionResponse>	getCertificateAuthorityVersion(GetCertificateAuthorityVersionRequest request, AsyncHandler<GetCertificateAuthorityVersionRequest,GetCertificateAuthorityVersionResponse> handler)	Gets details about the specified certificate authority (CA) version.
Future<GetCertificateVersionResponse>	getCertificateVersion(GetCertificateVersionRequest request, AsyncHandler<GetCertificateVersionRequest,GetCertificateVersionResponse> handler)	Gets details about the specified version of a certificate.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<ListAssociationsResponse>	listAssociations(ListAssociationsRequest request, AsyncHandler<ListAssociationsRequest,ListAssociationsResponse> handler)	Lists all associations that match the query parameters.
Future<ListCaBundlesResponse>	listCaBundles(ListCaBundlesRequest request, AsyncHandler<ListCaBundlesRequest,ListCaBundlesResponse> handler)	Lists all CA bundles that match the query parameters.
Future<ListCertificateAuthoritiesResponse>	listCertificateAuthorities(ListCertificateAuthoritiesRequest request, AsyncHandler<ListCertificateAuthoritiesRequest,ListCertificateAuthoritiesResponse> handler)	Lists all certificate authorities (CAs) in the specified compartment.
Future<ListCertificateAuthorityVersionsResponse>	listCertificateAuthorityVersions(ListCertificateAuthorityVersionsRequest request, AsyncHandler<ListCertificateAuthorityVersionsRequest,ListCertificateAuthorityVersionsResponse> handler)	Lists all versions for the specified certificate authority (CA).
Future<ListCertificatesResponse>	listCertificates(ListCertificatesRequest request, AsyncHandler<ListCertificatesRequest,ListCertificatesResponse> handler)	Lists all certificates that match the query parameters.
Future<ListCertificateVersionsResponse>	listCertificateVersions(ListCertificateVersionsRequest request, AsyncHandler<ListCertificateVersionsRequest,ListCertificateVersionsResponse> handler)	Lists all certificate versions for the specified certificate.
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.
Future<RevokeCertificateAuthorityVersionResponse>	revokeCertificateAuthorityVersion(RevokeCertificateAuthorityVersionRequest request, AsyncHandler<RevokeCertificateAuthorityVersionRequest,RevokeCertificateAuthorityVersionResponse> handler)	Revokes a certificate authority (CA) version.
Future<RevokeCertificateVersionResponse>	revokeCertificateVersion(RevokeCertificateVersionRequest request, AsyncHandler<RevokeCertificateVersionRequest,RevokeCertificateVersionResponse> handler)	Revokes the specified certificate version.
Future<ScheduleCertificateAuthorityDeletionResponse>	scheduleCertificateAuthorityDeletion(ScheduleCertificateAuthorityDeletionRequest request, AsyncHandler<ScheduleCertificateAuthorityDeletionRequest,ScheduleCertificateAuthorityDeletionResponse> handler)	Schedules the deletion of the specified certificate authority (CA).
Future<ScheduleCertificateAuthorityVersionDeletionResponse>	scheduleCertificateAuthorityVersionDeletion(ScheduleCertificateAuthorityVersionDeletionRequest request, AsyncHandler<ScheduleCertificateAuthorityVersionDeletionRequest,ScheduleCertificateAuthorityVersionDeletionResponse> handler)	Schedules the deletion of the specified certificate authority (CA) version.
Future<ScheduleCertificateDeletionResponse>	scheduleCertificateDeletion(ScheduleCertificateDeletionRequest request, AsyncHandler<ScheduleCertificateDeletionRequest,ScheduleCertificateDeletionResponse> handler)	Schedules the deletion of the specified certificate.
Future<ScheduleCertificateVersionDeletionResponse>	scheduleCertificateVersionDeletion(ScheduleCertificateVersionDeletionRequest request, AsyncHandler<ScheduleCertificateVersionDeletionRequest,ScheduleCertificateVersionDeletionResponse> handler)	Schedules the deletion of the specified certificate version.
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.
Future<UpdateCaBundleResponse>	updateCaBundle(UpdateCaBundleRequest request, AsyncHandler<UpdateCaBundleRequest,UpdateCaBundleResponse> handler)	Updates the properties of a CA bundle.
Future<UpdateCertificateResponse>	updateCertificate(UpdateCertificateRequest request, AsyncHandler<UpdateCertificateRequest,UpdateCertificateResponse> handler)	Updates the properties of a certificate.
Future<UpdateCertificateAuthorityResponse>	updateCertificateAuthority(UpdateCertificateAuthorityRequest request, AsyncHandler<UpdateCertificateAuthorityRequest,UpdateCertificateAuthorityResponse> handler)	Updates the properties of the specified certificate authority (CA).
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

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.certificatesmanagement.CertificatesManagementAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for CertificatesManagement.

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

CertificatesManagementAsyncClient

@Deprecated
public CertificatesManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

CertificatesManagementAsyncClient

@Deprecated
public CertificatesManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

CertificatesManagementAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

CertificatesManagementAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

CertificatesManagementAsyncClient

@Deprecated
public CertificatesManagementAsyncClient(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 CertificatesManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

CertificatesManagementAsyncClient

@Deprecated
public CertificatesManagementAsyncClient(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 CertificatesManagementAsyncClient.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)

CertificatesManagementAsyncClient

@Deprecated
public CertificatesManagementAsyncClient(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 CertificatesManagementAsyncClient.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

Method Detail

builder

public static CertificatesManagementAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: CertificatesManagementAsync

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 CertificatesManagementAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: CertificatesManagementAsync

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 CertificatesManagementAsync

Parameters:

regionId - The public region ID.

cancelCertificateAuthorityDeletion

public Future<CancelCertificateAuthorityDeletionResponse> cancelCertificateAuthorityDeletion(CancelCertificateAuthorityDeletionRequest request,
                                                                                             AsyncHandler<CancelCertificateAuthorityDeletionRequest,CancelCertificateAuthorityDeletionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Cancels the scheduled deletion of the specified certificate authority (CA).

Specified by:

cancelCertificateAuthorityDeletion in interface CertificatesManagementAsync

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.

cancelCertificateAuthorityVersionDeletion

public Future<CancelCertificateAuthorityVersionDeletionResponse> cancelCertificateAuthorityVersionDeletion(CancelCertificateAuthorityVersionDeletionRequest request,
                                                                                                           AsyncHandler<CancelCertificateAuthorityVersionDeletionRequest,CancelCertificateAuthorityVersionDeletionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Cancels the scheduled deletion of the specified certificate authority (CA) version.

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

Specified by:

cancelCertificateAuthorityVersionDeletion in interface CertificatesManagementAsync

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.

cancelCertificateDeletion

public Future<CancelCertificateDeletionResponse> cancelCertificateDeletion(CancelCertificateDeletionRequest request,
                                                                           AsyncHandler<CancelCertificateDeletionRequest,CancelCertificateDeletionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Cancels the pending deletion of the specified certificate.

Canceling a scheduled deletion restores the certificate’s lifecycle state to what it was before you scheduled the certificate for deletion.

Specified by:

cancelCertificateDeletion in interface CertificatesManagementAsync

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.

cancelCertificateVersionDeletion

public Future<CancelCertificateVersionDeletionResponse> cancelCertificateVersionDeletion(CancelCertificateVersionDeletionRequest request,
                                                                                         AsyncHandler<CancelCertificateVersionDeletionRequest,CancelCertificateVersionDeletionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Cancels the scheduled deletion of the specified certificate version.

Specified by:

cancelCertificateVersionDeletion in interface CertificatesManagementAsync

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.

changeCaBundleCompartment

public Future<ChangeCaBundleCompartmentResponse> changeCaBundleCompartment(ChangeCaBundleCompartmentRequest request,
                                                                           AsyncHandler<ChangeCaBundleCompartmentRequest,ChangeCaBundleCompartmentResponse> handler)

Description copied from interface: CertificatesManagementAsync

Moves a CA bundle to a different compartment in 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 secret.

Specified by:

changeCaBundleCompartment in interface CertificatesManagementAsync

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.

changeCertificateAuthorityCompartment

public Future<ChangeCertificateAuthorityCompartmentResponse> changeCertificateAuthorityCompartment(ChangeCertificateAuthorityCompartmentRequest request,
                                                                                                   AsyncHandler<ChangeCertificateAuthorityCompartmentRequest,ChangeCertificateAuthorityCompartmentResponse> handler)

Description copied from interface: CertificatesManagementAsync

Moves a certificate authority (CA) to 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 source.

Specified by:

changeCertificateAuthorityCompartment in interface CertificatesManagementAsync

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.

changeCertificateCompartment

public Future<ChangeCertificateCompartmentResponse> changeCertificateCompartment(ChangeCertificateCompartmentRequest request,
                                                                                 AsyncHandler<ChangeCertificateCompartmentRequest,ChangeCertificateCompartmentResponse> handler)

Description copied from interface: CertificatesManagementAsync

Moves a certificate to 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 secret.

Specified by:

changeCertificateCompartment in interface CertificatesManagementAsync

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.

createCaBundle

public Future<CreateCaBundleResponse> createCaBundle(CreateCaBundleRequest request,
                                                     AsyncHandler<CreateCaBundleRequest,CreateCaBundleResponse> handler)

Description copied from interface: CertificatesManagementAsync

Creates a new CA bundle according to the details of the request.

Specified by:

createCaBundle in interface CertificatesManagementAsync

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.

createCertificate

public Future<CreateCertificateResponse> createCertificate(CreateCertificateRequest request,
                                                           AsyncHandler<CreateCertificateRequest,CreateCertificateResponse> handler)

Description copied from interface: CertificatesManagementAsync

Creates a new certificate according to the details of the request.

Specified by:

createCertificate in interface CertificatesManagementAsync

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.

createCertificateAuthority

public Future<CreateCertificateAuthorityResponse> createCertificateAuthority(CreateCertificateAuthorityRequest request,
                                                                             AsyncHandler<CreateCertificateAuthorityRequest,CreateCertificateAuthorityResponse> handler)

Description copied from interface: CertificatesManagementAsync

Creates a new certificate authority (CA) according to the details of the request.

Specified by:

createCertificateAuthority in interface CertificatesManagementAsync

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.

deleteCaBundle

public Future<DeleteCaBundleResponse> deleteCaBundle(DeleteCaBundleRequest request,
                                                     AsyncHandler<DeleteCaBundleRequest,DeleteCaBundleResponse> handler)

Description copied from interface: CertificatesManagementAsync

Deletes the specified CA bundle.

Specified by:

deleteCaBundle in interface CertificatesManagementAsync

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.

getAssociation

public Future<GetAssociationResponse> getAssociation(GetAssociationRequest request,
                                                     AsyncHandler<GetAssociationRequest,GetAssociationResponse> handler)

Description copied from interface: CertificatesManagementAsync

Gets details about the specified association.

Specified by:

getAssociation in interface CertificatesManagementAsync

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.

getCaBundle

public Future<GetCaBundleResponse> getCaBundle(GetCaBundleRequest request,
                                               AsyncHandler<GetCaBundleRequest,GetCaBundleResponse> handler)

Description copied from interface: CertificatesManagementAsync

Gets details about the specified CA bundle.

Specified by:

getCaBundle in interface CertificatesManagementAsync

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.

getCertificate

public Future<GetCertificateResponse> getCertificate(GetCertificateRequest request,
                                                     AsyncHandler<GetCertificateRequest,GetCertificateResponse> handler)

Description copied from interface: CertificatesManagementAsync

Gets details about the specified certificate.

Specified by:

getCertificate in interface CertificatesManagementAsync

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.

getCertificateAuthority

public Future<GetCertificateAuthorityResponse> getCertificateAuthority(GetCertificateAuthorityRequest request,
                                                                       AsyncHandler<GetCertificateAuthorityRequest,GetCertificateAuthorityResponse> handler)

Description copied from interface: CertificatesManagementAsync

Gets details about the specified certificate authority (CA).

Specified by:

getCertificateAuthority in interface CertificatesManagementAsync

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.

getCertificateAuthorityVersion

public Future<GetCertificateAuthorityVersionResponse> getCertificateAuthorityVersion(GetCertificateAuthorityVersionRequest request,
                                                                                     AsyncHandler<GetCertificateAuthorityVersionRequest,GetCertificateAuthorityVersionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Gets details about the specified certificate authority (CA) version.

Specified by:

getCertificateAuthorityVersion in interface CertificatesManagementAsync

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.

getCertificateVersion

public Future<GetCertificateVersionResponse> getCertificateVersion(GetCertificateVersionRequest request,
                                                                   AsyncHandler<GetCertificateVersionRequest,GetCertificateVersionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Gets details about the specified version of a certificate.

Specified by:

getCertificateVersion in interface CertificatesManagementAsync

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.

listAssociations

public Future<ListAssociationsResponse> listAssociations(ListAssociationsRequest request,
                                                         AsyncHandler<ListAssociationsRequest,ListAssociationsResponse> handler)

Description copied from interface: CertificatesManagementAsync

Lists all associations that match the query parameters.

Optionally, you can use the parameter FilterByAssociationIdQueryParam to limit the result set to a single item that matches the specified association.

Specified by:

listAssociations in interface CertificatesManagementAsync

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.

listCaBundles

public Future<ListCaBundlesResponse> listCaBundles(ListCaBundlesRequest request,
                                                   AsyncHandler<ListCaBundlesRequest,ListCaBundlesResponse> handler)

Description copied from interface: CertificatesManagementAsync

Lists all CA bundles that match the query parameters.

Optionally, you can use the parameter FilterByCaBundleIdQueryParam to limit the result set to a single item that matches the specified CA bundle.

Specified by:

listCaBundles in interface CertificatesManagementAsync

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.

listCertificateAuthorities

public Future<ListCertificateAuthoritiesResponse> listCertificateAuthorities(ListCertificateAuthoritiesRequest request,
                                                                             AsyncHandler<ListCertificateAuthoritiesRequest,ListCertificateAuthoritiesResponse> handler)

Description copied from interface: CertificatesManagementAsync

Lists all certificate authorities (CAs) in the specified compartment.

Optionally, you can use the parameter FilterByCertificateAuthorityIdQueryParam to limit the results to a single item that matches the specified CA.

Specified by:

listCertificateAuthorities in interface CertificatesManagementAsync

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.

listCertificateAuthorityVersions

public Future<ListCertificateAuthorityVersionsResponse> listCertificateAuthorityVersions(ListCertificateAuthorityVersionsRequest request,
                                                                                         AsyncHandler<ListCertificateAuthorityVersionsRequest,ListCertificateAuthorityVersionsResponse> handler)

Description copied from interface: CertificatesManagementAsync

Lists all versions for the specified certificate authority (CA).

Optionally, you can use the parameter FilterByVersionNumberQueryParam to limit the results to a single item that matches the specified version number.

Specified by:

listCertificateAuthorityVersions in interface CertificatesManagementAsync

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.

listCertificateVersions

public Future<ListCertificateVersionsResponse> listCertificateVersions(ListCertificateVersionsRequest request,
                                                                       AsyncHandler<ListCertificateVersionsRequest,ListCertificateVersionsResponse> handler)

Description copied from interface: CertificatesManagementAsync

Lists all certificate versions for the specified certificate.

Optionally, you can use the parameter FilterByVersionNumberQueryParam to limit the result set to a single item that matches the specified version number.

Specified by:

listCertificateVersions in interface CertificatesManagementAsync

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.

listCertificates

public Future<ListCertificatesResponse> listCertificates(ListCertificatesRequest request,
                                                         AsyncHandler<ListCertificatesRequest,ListCertificatesResponse> handler)

Description copied from interface: CertificatesManagementAsync

Lists all certificates that match the query parameters.

Optionally, you can use the parameter FilterByCertificateIdQueryParam to limit the result set to a single item that matches the specified certificate.

Specified by:

listCertificates in interface CertificatesManagementAsync

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.

revokeCertificateAuthorityVersion

public Future<RevokeCertificateAuthorityVersionResponse> revokeCertificateAuthorityVersion(RevokeCertificateAuthorityVersionRequest request,
                                                                                           AsyncHandler<RevokeCertificateAuthorityVersionRequest,RevokeCertificateAuthorityVersionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Revokes a certificate authority (CA) version.

Specified by:

revokeCertificateAuthorityVersion in interface CertificatesManagementAsync

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.

revokeCertificateVersion

public Future<RevokeCertificateVersionResponse> revokeCertificateVersion(RevokeCertificateVersionRequest request,
                                                                         AsyncHandler<RevokeCertificateVersionRequest,RevokeCertificateVersionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Revokes the specified certificate version.

Specified by:

revokeCertificateVersion in interface CertificatesManagementAsync

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.

scheduleCertificateAuthorityDeletion

public Future<ScheduleCertificateAuthorityDeletionResponse> scheduleCertificateAuthorityDeletion(ScheduleCertificateAuthorityDeletionRequest request,
                                                                                                 AsyncHandler<ScheduleCertificateAuthorityDeletionRequest,ScheduleCertificateAuthorityDeletionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Schedules the deletion of the specified certificate authority (CA).

This sets the lifecycle state of the CA to PENDING_DELETION and then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by using GetCertificateAuthority.

Specified by:

scheduleCertificateAuthorityDeletion in interface CertificatesManagementAsync

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.

scheduleCertificateAuthorityVersionDeletion

public Future<ScheduleCertificateAuthorityVersionDeletionResponse> scheduleCertificateAuthorityVersionDeletion(ScheduleCertificateAuthorityVersionDeletionRequest request,
                                                                                                               AsyncHandler<ScheduleCertificateAuthorityVersionDeletionRequest,ScheduleCertificateAuthorityVersionDeletionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Schedules the deletion of the specified certificate authority (CA) version.

This sets the lifecycle state of the CA version to PENDING_DELETION and then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by using GetCertificateAuthorityVersion.

Specified by:

scheduleCertificateAuthorityVersionDeletion in interface CertificatesManagementAsync

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.

scheduleCertificateDeletion

public Future<ScheduleCertificateDeletionResponse> scheduleCertificateDeletion(ScheduleCertificateDeletionRequest request,
                                                                               AsyncHandler<ScheduleCertificateDeletionRequest,ScheduleCertificateDeletionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Schedules the deletion of the specified certificate.

This sets the lifecycle state of the certificate to PENDING_DELETION and then deletes it after the specified retention period ends. You can subsequently use GetCertificate to determine the current deletion status.

Specified by:

scheduleCertificateDeletion in interface CertificatesManagementAsync

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.

scheduleCertificateVersionDeletion

public Future<ScheduleCertificateVersionDeletionResponse> scheduleCertificateVersionDeletion(ScheduleCertificateVersionDeletionRequest request,
                                                                                             AsyncHandler<ScheduleCertificateVersionDeletionRequest,ScheduleCertificateVersionDeletionResponse> handler)

Description copied from interface: CertificatesManagementAsync

Schedules the deletion of the specified certificate version.

This sets the lifecycle state of the certificate version to PENDING_DELETION and then deletes it after the specified retention period ends. You can only delete a certificate version if the certificate version rotation state is marked as DEPRECATED.

You can subsequently use `GetCertificateVersion` to determine the current certificate version deletion status.

Specified by:

scheduleCertificateVersionDeletion in interface CertificatesManagementAsync

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.

updateCaBundle

public Future<UpdateCaBundleResponse> updateCaBundle(UpdateCaBundleRequest request,
                                                     AsyncHandler<UpdateCaBundleRequest,UpdateCaBundleResponse> handler)

Description copied from interface: CertificatesManagementAsync

Updates the properties of a CA bundle.

Specified by:

updateCaBundle in interface CertificatesManagementAsync

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.

updateCertificate

public Future<UpdateCertificateResponse> updateCertificate(UpdateCertificateRequest request,
                                                           AsyncHandler<UpdateCertificateRequest,UpdateCertificateResponse> handler)

Description copied from interface: CertificatesManagementAsync

Updates the properties of a certificate.

Specified by:

updateCertificate in interface CertificatesManagementAsync

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.

updateCertificateAuthority

public Future<UpdateCertificateAuthorityResponse> updateCertificateAuthority(UpdateCertificateAuthorityRequest request,
                                                                             AsyncHandler<UpdateCertificateAuthorityRequest,UpdateCertificateAuthorityResponse> handler)

Description copied from interface: CertificatesManagementAsync

Updates the properties of the specified certificate authority (CA).

Specified by:

updateCertificateAuthority in interface CertificatesManagementAsync

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.

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()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)