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 CertificatesManagementAsyncAsync 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 anInputStream, 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 classCertificatesManagementAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for CertificatesManagement.
-
Constructor Summary
Constructors Constructor Description CertificatesManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.CertificatesManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.CertificatesManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.CertificatesManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.CertificatesManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.CertificatesManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.CertificatesManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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
-
-
-
-
Constructor Detail
-
CertificatesManagementAsyncClient
@Deprecated public CertificatesManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
CertificatesManagementAsyncClient
@Deprecated public CertificatesManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
CertificatesManagementAsyncClient
@Deprecated public CertificatesManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
CertificatesManagementAsyncClient
@Deprecated public CertificatesManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
CertificatesManagementAsyncClient
@Deprecated public CertificatesManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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:CertificatesManagementAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceCertificatesManagementAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:CertificatesManagementAsyncSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceCertificatesManagementAsync- Parameters:
regionId- The public region ID.
-
cancelCertificateAuthorityDeletion
public Future<CancelCertificateAuthorityDeletionResponse> cancelCertificateAuthorityDeletion(CancelCertificateAuthorityDeletionRequest request, AsyncHandler<CancelCertificateAuthorityDeletionRequest,CancelCertificateAuthorityDeletionResponse> handler)
Description copied from interface:CertificatesManagementAsyncCancels the scheduled deletion of the specified certificate authority (CA).- Specified by:
cancelCertificateAuthorityDeletionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncCancels 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:
cancelCertificateAuthorityVersionDeletionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncCancels 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:
cancelCertificateDeletionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncCancels the scheduled deletion of the specified certificate version.- Specified by:
cancelCertificateVersionDeletionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncMoves 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:
changeCaBundleCompartmentin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncMoves 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:
changeCertificateAuthorityCompartmentin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncMoves 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:
changeCertificateCompartmentin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncCreates a new CA bundle according to the details of the request.- Specified by:
createCaBundlein interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncCreates a new certificate according to the details of the request.- Specified by:
createCertificatein interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncCreates a new certificate authority (CA) according to the details of the request.- Specified by:
createCertificateAuthorityin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncDeletes the specified CA bundle.- Specified by:
deleteCaBundlein interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncGets details about the specified association.- Specified by:
getAssociationin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncGets details about the specified CA bundle.- Specified by:
getCaBundlein interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncGets details about the specified certificate.- Specified by:
getCertificatein interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncGets details about the specified certificate authority (CA).- Specified by:
getCertificateAuthorityin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncGets details about the specified certificate authority (CA) version.- Specified by:
getCertificateAuthorityVersionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncGets details about the specified version of a certificate.- Specified by:
getCertificateVersionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncLists all associations that match the query parameters.Optionally, you can use the parameter
FilterByAssociationIdQueryParamto limit the result set to a single item that matches the specified association.- Specified by:
listAssociationsin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncLists all CA bundles that match the query parameters.Optionally, you can use the parameter
FilterByCaBundleIdQueryParamto limit the result set to a single item that matches the specified CA bundle.- Specified by:
listCaBundlesin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncLists all certificate authorities (CAs) in the specified compartment.Optionally, you can use the parameter
FilterByCertificateAuthorityIdQueryParamto limit the results to a single item that matches the specified CA.- Specified by:
listCertificateAuthoritiesin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncLists all versions for the specified certificate authority (CA).Optionally, you can use the parameter
FilterByVersionNumberQueryParamto limit the results to a single item that matches the specified version number.- Specified by:
listCertificateAuthorityVersionsin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncLists all certificate versions for the specified certificate.Optionally, you can use the parameter
FilterByVersionNumberQueryParamto limit the result set to a single item that matches the specified version number.- Specified by:
listCertificateVersionsin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncLists all certificates that match the query parameters.Optionally, you can use the parameter
FilterByCertificateIdQueryParamto limit the result set to a single item that matches the specified certificate.- Specified by:
listCertificatesin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncRevokes a certificate authority (CA) version.- Specified by:
revokeCertificateAuthorityVersionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncRevokes the specified certificate version.- Specified by:
revokeCertificateVersionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncSchedules the deletion of the specified certificate authority (CA).This sets the lifecycle state of the CA to
PENDING_DELETIONand then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by usingGetCertificateAuthority.- Specified by:
scheduleCertificateAuthorityDeletionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncSchedules the deletion of the specified certificate authority (CA) version.This sets the lifecycle state of the CA version to
PENDING_DELETIONand then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by usingGetCertificateAuthorityVersion.- Specified by:
scheduleCertificateAuthorityVersionDeletionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncSchedules the deletion of the specified certificate.This sets the lifecycle state of the certificate to
PENDING_DELETIONand then deletes it after the specified retention period ends. You can subsequently useGetCertificateto determine the current deletion status.- Specified by:
scheduleCertificateDeletionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncSchedules the deletion of the specified certificate version.This sets the lifecycle state of the certificate version to
PENDING_DELETIONand then deletes it after the specified retention period ends. You can only delete a certificate version if the certificate version rotation state is marked asDEPRECATED.You can subsequently use `GetCertificateVersion` to determine the current certificate version deletion status.
- Specified by:
scheduleCertificateVersionDeletionin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncUpdates the properties of a CA bundle.- Specified by:
updateCaBundlein interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncUpdates the properties of a certificate.- Specified by:
updateCertificatein interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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:CertificatesManagementAsyncUpdates the properties of the specified certificate authority (CA).- Specified by:
updateCertificateAuthorityin interfaceCertificatesManagementAsync- Parameters:
request- The request object containing the details to sendhandler- 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()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
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)
-
-