Package com.oracle.bmc.certificatesmanagement

Interface CertificatesManagementAsync

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the serice.

      • getEndpoint

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

      • setRegion

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

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

        Parameters:
        region - The region of the service.

      • setRegion

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

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

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

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

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

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

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

      • cancelCertificateDeletion

        Future<CancelCertificateDeletionResponse> cancelCertificateDeletion​(CancelCertificateDeletionRequest request,
                                                                    AsyncHandler<CancelCertificateDeletionRequest,​CancelCertificateDeletionResponse> handler)
        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.

        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

        Future<CreateCaBundleResponse> createCaBundle​(CreateCaBundleRequest request,
                                              AsyncHandler<CreateCaBundleRequest,​CreateCaBundleResponse> handler)
        Creates a new CA bundle according to the details of the request.
        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

        Future<CreateCertificateResponse> createCertificate​(CreateCertificateRequest request,
                                                    AsyncHandler<CreateCertificateRequest,​CreateCertificateResponse> handler)
        Creates a new certificate according to the details of the request.
        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

        Future<DeleteCaBundleResponse> deleteCaBundle​(DeleteCaBundleRequest request,
                                              AsyncHandler<DeleteCaBundleRequest,​DeleteCaBundleResponse> handler)
        Deletes the specified CA bundle.
        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

        Future<GetAssociationResponse> getAssociation​(GetAssociationRequest request,
                                              AsyncHandler<GetAssociationRequest,​GetAssociationResponse> handler)
        Gets details about the specified association.
        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

        Future<GetCaBundleResponse> getCaBundle​(GetCaBundleRequest request,
                                        AsyncHandler<GetCaBundleRequest,​GetCaBundleResponse> handler)
        Gets details about the specified CA bundle.
        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

        Future<GetCertificateResponse> getCertificate​(GetCertificateRequest request,
                                              AsyncHandler<GetCertificateRequest,​GetCertificateResponse> handler)
        Gets details about the specified certificate.
        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

        Future<GetCertificateAuthorityResponse> getCertificateAuthority​(GetCertificateAuthorityRequest request,
                                                                AsyncHandler<GetCertificateAuthorityRequest,​GetCertificateAuthorityResponse> handler)
        Gets details about the specified certificate authority (CA).
        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

        Future<GetCertificateVersionResponse> getCertificateVersion​(GetCertificateVersionRequest request,
                                                            AsyncHandler<GetCertificateVersionRequest,​GetCertificateVersionResponse> handler)
        Gets details about the specified version of a certificate.
        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

        Future<ListAssociationsResponse> listAssociations​(ListAssociationsRequest request,
                                                  AsyncHandler<ListAssociationsRequest,​ListAssociationsResponse> handler)
        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.

        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

        Future<ListCaBundlesResponse> listCaBundles​(ListCaBundlesRequest request,
                                            AsyncHandler<ListCaBundlesRequest,​ListCaBundlesResponse> handler)
        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.

        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

        Future<ListCertificateAuthoritiesResponse> listCertificateAuthorities​(ListCertificateAuthoritiesRequest request,
                                                                      AsyncHandler<ListCertificateAuthoritiesRequest,​ListCertificateAuthoritiesResponse> handler)
        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.

        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

        Future<ListCertificateAuthorityVersionsResponse> listCertificateAuthorityVersions​(ListCertificateAuthorityVersionsRequest request,
                                                                                  AsyncHandler<ListCertificateAuthorityVersionsRequest,​ListCertificateAuthorityVersionsResponse> handler)
        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.

        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

        Future<ListCertificateVersionsResponse> listCertificateVersions​(ListCertificateVersionsRequest request,
                                                                AsyncHandler<ListCertificateVersionsRequest,​ListCertificateVersionsResponse> handler)
        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.

        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

        Future<ListCertificatesResponse> listCertificates​(ListCertificatesRequest request,
                                                  AsyncHandler<ListCertificatesRequest,​ListCertificatesResponse> handler)
        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.

        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

        Future<ScheduleCertificateAuthorityDeletionResponse> scheduleCertificateAuthorityDeletion​(ScheduleCertificateAuthorityDeletionRequest request,
                                                                                          AsyncHandler<ScheduleCertificateAuthorityDeletionRequest,​ScheduleCertificateAuthorityDeletionResponse> handler)
        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.

        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

        Future<ScheduleCertificateDeletionResponse> scheduleCertificateDeletion​(ScheduleCertificateDeletionRequest request,
                                                                        AsyncHandler<ScheduleCertificateDeletionRequest,​ScheduleCertificateDeletionResponse> handler)
        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.

        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

        Future<ScheduleCertificateVersionDeletionResponse> scheduleCertificateVersionDeletion​(ScheduleCertificateVersionDeletionRequest request,
                                                                                      AsyncHandler<ScheduleCertificateVersionDeletionRequest,​ScheduleCertificateVersionDeletionResponse> handler)
        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.

        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

        Future<UpdateCaBundleResponse> updateCaBundle​(UpdateCaBundleRequest request,
                                              AsyncHandler<UpdateCaBundleRequest,​UpdateCaBundleResponse> handler)
        Updates the properties of a CA bundle.
        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

        Future<UpdateCertificateResponse> updateCertificate​(UpdateCertificateRequest request,
                                                    AsyncHandler<UpdateCertificateRequest,​UpdateCertificateResponse> handler)
        Updates the properties of a certificate.
        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.