Package com.azure.security.keyvault.certificates

Class CertificateClientBuilder

  • All Implemented Interfaces:
    com.azure.core.client.traits.ConfigurationTrait<CertificateClientBuilder>, com.azure.core.client.traits.HttpTrait<CertificateClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<CertificateClientBuilder>
    public final class CertificateClientBuilder
extends Object
implements com.azure.core.client.traits.TokenCredentialTrait<CertificateClientBuilder>, com.azure.core.client.traits.HttpTrait<CertificateClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<CertificateClientBuilder>
    This class provides a fluent builder API to help aid the configuration and instantiation of the certificate async client and certificate sync client, by calling buildAsyncClient and buildClient respectively It constructs an instance of the desired client.

    The minimal configuration options required by CertificateClientBuilder to build CertificateAsyncClient are vaultUrl and credential. 

     CertificateAsyncClient certificateAsyncClient = new CertificateClientBuilder()
     .credential(new DefaultAzureCredentialBuilder().build())
     .vaultUrl("https://myvault.vault.azure.net/")
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .buildAsyncClient();

    The log detail level, multiple custom policies and custom http client can be optionally configured in the CertificateClientBuilder.

     CertificateAsyncClient certificateAsyncClient = new CertificateClientBuilder()
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .vaultUrl("https://myvault.azure.net/")
     .credential(new DefaultAzureCredentialBuilder().build())
     .httpClient(HttpClient.createDefault())
     .buildAsyncClient();

    Alternatively, custom http pipeline with custom HttpPipelinePolicy policies and vaultUrl can be specified. It provides finer control over the construction of CertificateAsyncClient and CertificateClient

     HttpPipeline pipeline = new HttpPipelineBuilder()
     .policies(new KeyVaultCredentialPolicy(new DefaultAzureCredentialBuilder().build()), new RetryPolicy())
     .build();
 CertificateAsyncClient certificateAsyncClient = new CertificateClientBuilder()
     .pipeline(pipeline)
     .vaultUrl("https://myvault.azure.net/")
     .buildAsyncClient();

    The minimal configuration options required by certificateClientBuilder to build CertificateClient are vaultUrl and credential. 

     CertificateClient certificateClient = new CertificateClientBuilder()
     .credential(new DefaultAzureCredentialBuilder().build())
     .vaultUrl("https://myvault.vault.azure.net/")
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .buildClient();
    See Also:
    CertificateAsyncClient, CertificateClient

    • Constructor Detail

      • CertificateClientBuilder

        public CertificateClientBuilder()
        The constructor with defaults.

    • Method Detail

      • credential

        public CertificateClientBuilder credential​(com.azure.core.credential.TokenCredential credential)
        Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.
        Specified by:
        credential in interface com.azure.core.client.traits.TokenCredentialTrait<CertificateClientBuilder>
        Parameters:
        credential - TokenCredential used to authorize requests sent to the service.
        Returns:
        The updated CertificateClientBuilder object.
        Throws:
        NullPointerException - If credential is null.

      • httpLogOptions

        public CertificateClientBuilder httpLogOptions​(com.azure.core.http.policy.HttpLogOptions logOptions)
        Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        Specified by:
        httpLogOptions in interface com.azure.core.client.traits.HttpTrait<CertificateClientBuilder>
        Parameters:
        logOptions - The logging configuration to use when sending and receiving requests to and from the service.
        Returns:
        The updated CertificateClientBuilder object.

      • addPolicy

        public CertificateClientBuilder addPolicy​(com.azure.core.http.policy.HttpPipelinePolicy policy)
        Adds a pipeline policy to apply on each request sent.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        Specified by:
        addPolicy in interface com.azure.core.client.traits.HttpTrait<CertificateClientBuilder>
        Parameters:
        policy - A pipeline policy.
        Returns:
        The updated CertificateClientBuilder object.
        Throws:
        NullPointerException - If policy is null.

      • httpClient

        public CertificateClientBuilder httpClient​(com.azure.core.http.HttpClient client)
        Sets the HttpClient to use for sending and receiving requests to and from the service.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        Specified by:
        httpClient in interface com.azure.core.client.traits.HttpTrait<CertificateClientBuilder>
        Parameters:
        client - The HttpClient to use for requests.
        Returns:
        The updated CertificateClientBuilder object.

      • pipeline

        public CertificateClientBuilder pipeline​(com.azure.core.http.HttpPipeline pipeline)
        Sets the HttpPipeline to use for the service client.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        The vaultUrl is not ignored when pipeline is set.

        Specified by:
        pipeline in interface com.azure.core.client.traits.HttpTrait<CertificateClientBuilder>
        Parameters:
        pipeline - HttpPipeline to use for sending service requests and receiving responses.
        Returns:
        The updated CertificateClientBuilder object.

      • configuration

        public CertificateClientBuilder configuration​(com.azure.core.util.Configuration configuration)
        Sets the configuration store that is used during construction of the service client. The default configuration store is a clone of the global configuration store, use Configuration.NONE to bypass using configuration settings during construction.
        Specified by:
        configuration in interface com.azure.core.client.traits.ConfigurationTrait<CertificateClientBuilder>
        Parameters:
        configuration - The configuration store used to get configuration details.
        Returns:
        The updated CertificateClientBuilder object.

      • serviceVersion

        public CertificateClientBuilder serviceVersion​(CertificateServiceVersion version)
        Sets the CertificateServiceVersion that is used when making API requests.

        If a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version the client library will have the result of potentially moving to a newer service version.

        Parameters:
        version - CertificateServiceVersion of the service to be used when making requests.
        Returns:
        The updated CertificateClientBuilder object.

      • retryPolicy

        public CertificateClientBuilder retryPolicy​(com.azure.core.http.policy.RetryPolicy retryPolicy)
        Sets the RetryPolicy that is used when each request is sent. The default retry policy will be used in the pipeline, if not provided. Setting this is mutually exclusive with using retryOptions(RetryOptions).
        Parameters:
        retryPolicy - user's retry policy applied to each request.
        Returns:
        The updated CertificateClientBuilder object.

      • retryOptions

        public CertificateClientBuilder retryOptions​(com.azure.core.http.policy.RetryOptions retryOptions)
        Sets the RetryOptions for all the requests made through the client.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        Setting this is mutually exclusive with using retryPolicy(RetryPolicy).

        Specified by:
        retryOptions in interface com.azure.core.client.traits.HttpTrait<CertificateClientBuilder>
        Parameters:
        retryOptions - The RetryOptions to use for all the requests made through the client.
        Returns:
        The updated CertificateClientBuilder object.

      • clientOptions

        public CertificateClientBuilder clientOptions​(com.azure.core.util.ClientOptions clientOptions)
        Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

        Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

        Specified by:
        clientOptions in interface com.azure.core.client.traits.HttpTrait<CertificateClientBuilder>
        Parameters:
        clientOptions - A configured instance of HttpClientOptions.
        Returns:
        The updated CertificateClientBuilder object.
        See Also:
        HttpClientOptions