com.azure.security.keyvault.certificates

Class CertificateClientBuilder

java.lang.Object

com.azure.security.keyvault.certificates.CertificateClientBuilder

public final class CertificateClientBuilder
extends Object

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 Summary

Constructors

Constructor and Description
CertificateClientBuilder() The constructor with defaults.

Method Summary

Modifier and Type	Method and Description
CertificateClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy) Adds a policy to the set of existing policies that are executed after CertificateAsyncClient and CertificateClient required policies.
CertificateAsyncClient	buildAsyncClient() Creates a CertificateAsyncClient based on options set in the builder.
CertificateClient	buildClient() Creates a CertificateClient based on options set in the builder.
CertificateClientBuilder	configuration(com.azure.core.util.Configuration configuration) Sets the configuration store that is used during construction of the service client.
CertificateClientBuilder	credential(com.azure.core.credential.TokenCredential credential) Sets the credential to use when authenticating HTTP requests.
CertificateClientBuilder	httpClient(com.azure.core.http.HttpClient client) Sets the HTTP client to use for sending and receiving requests to and from the service.
CertificateClientBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions) Sets the logging configuration for HTTP requests and responses.
CertificateClientBuilder	pipeline(com.azure.core.http.HttpPipeline pipeline) Sets the HTTP pipeline to use for the service client.
CertificateClientBuilder	retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy) Sets the RetryPolicy that is used when each request is sent.
CertificateClientBuilder	serviceVersion(CertificateServiceVersion version) Sets the CertificateServiceVersion that is used when making API requests.
CertificateClientBuilder	vaultUrl(String vaultUrl) Sets the vault endpoint url to send HTTP requests to.

Methods inherited from class java.lang.Object

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

Constructor Detail

CertificateClientBuilder

public CertificateClientBuilder()

The constructor with defaults.

Method Detail

buildClient

public CertificateClient buildClient()

Creates a CertificateClient based on options set in the builder. Every time buildClient() is called, a new instance of CertificateClient is created.

If pipeline is set, then the pipeline and serviceEndpoint are used to create the client. All other builder settings are ignored. If pipeline is not set, then key vault credential and key vault url are required to build the client.

Returns:

A CertificateClient with the options set from the builder.

Throws:

IllegalStateException - If CertificateClientBuilder.credential(TokenCredential) or CertificateClientBuilder.vaultUrl(String) have not been set.

buildAsyncClient

public CertificateAsyncClient buildAsyncClient()

Creates a CertificateAsyncClient based on options set in the builder. Every time CertificateClientBuilder.buildAsyncClient() is called, a new instance of CertificateAsyncClient is created.

If pipeline is set, then the pipeline and serviceEndpoint are used to create the client. All other builder settings are ignored. If pipeline is not set, then key vault credential and {@link CertificateClientBuilder#vaultUrl(String)} key vault url are required to build the {@link CertificateAsyncClient client}.

Returns:

A CertificateAsyncClient with the options set from the builder.

Throws:

IllegalStateException - If CertificateClientBuilder.credential(TokenCredential) or CertificateClientBuilder.vaultUrl(String) have not been set.

vaultUrl

public CertificateClientBuilder vaultUrl(String vaultUrl)

Sets the vault endpoint url to send HTTP requests to.

Parameters:

vaultUrl - The vault endpoint url is used as destination on Azure to send requests to.

Returns:

the updated ServiceClientBuilder object.

Throws:

IllegalArgumentException - if vaultUrl is null or it cannot be parsed into a valid URL.

credential

public CertificateClientBuilder credential(com.azure.core.credential.TokenCredential credential)

Sets the credential to use when authenticating HTTP requests.

Parameters:

credential - The credential to use for authenticating HTTP requests.

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 for HTTP requests and responses.

If logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

Parameters:

logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.

Returns:

the updated CertificateClientBuilder object.

addPolicy

public CertificateClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)

Adds a policy to the set of existing policies that are executed after CertificateAsyncClient and CertificateClient required policies.

Parameters:

policy - The policy to be added.

Returns:

the updated CertificateClientBuilder object.

Throws:

NullPointerException - if policy is null.

httpClient

public CertificateClientBuilder httpClient(com.azure.core.http.HttpClient client)

Sets the HTTP client to use for sending and receiving requests to and from the service.

Parameters:

client - The HTTP client to use for requests.

Returns:

the updated CertificateClientBuilder object.

Throws:

NullPointerException - If client is null.

pipeline

public CertificateClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)

Sets the HTTP pipeline to use for the service client. If pipeline is set, all other settings are ignored, aside from vaultUrl to build CertificateClient or CertificateAsyncClient.

Parameters:

pipeline - The HTTP pipeline 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.

Parameters:

configuration - The configuration store used to

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.

Parameters:

retryPolicy - user's retry policy applied to each request.

Returns:

The updated CertificateClientBuilder object.

Throws:

NullPointerException - if the specified retryPolicy is null.