com.azure.security.keyvault.secrets

Class SecretClientBuilder

java.lang.Object

com.azure.security.keyvault.secrets.SecretClientBuilder

public final class SecretClientBuilder
extends Object

This class provides a fluent builder API to help aid the configuration and instantiation of the secret async client and secret client, by calling buildAsyncClient and buildClient respectively. It constructs an instance of the desired client.

The minimal configuration options required by secretClientBuilder to build SecretAsyncClient are vaultUrl and credential.

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

Samples to construct the sync client

 SecretClient secretClient = new SecretClientBuilder()
     .credential(new DefaultAzureCredentialBuilder().build())
     .vaultUrl("https://myvault.vault.azure.net/")
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .buildClient();
 

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

 SecretAsyncClient secretAsyncClient = new SecretClientBuilder()
     .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 client

 HttpPipeline pipeline = new HttpPipelineBuilder()
     .policies(new KeyVaultCredentialPolicy(credential), new RetryPolicy())
     .build();
 SecretAsyncClient secretAsyncClient = new SecretClientBuilder()
     .pipeline(pipeline)
     .vaultUrl("https://myvault.azure.net/")
     .buildAsyncClient();
 

See Also:

SecretClient, SecretAsyncClient

Constructor Summary

Constructors

Constructor and Description
SecretClientBuilder() The constructor with defaults.

Method Summary

Modifier and Type	Method and Description
SecretClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy) Adds a policy to the set of existing policies that are executed after SecretAsyncClient or SecretClient required policies.
SecretAsyncClient	buildAsyncClient() Creates a SecretAsyncClient based on options set in the builder.
SecretClient	buildClient() Creates a SecretClient based on options set in the builder.
SecretClientBuilder	configuration(com.azure.core.util.Configuration configuration) Sets the configuration store that is used during construction of the service client.
SecretClientBuilder	credential(com.azure.core.credential.TokenCredential credential) Sets the credential to use when authenticating HTTP requests.
SecretClientBuilder	httpClient(com.azure.core.http.HttpClient client) Sets the HTTP client to use for sending and receiving requests to and from the service.
SecretClientBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions) Sets the logging configuration for HTTP requests and responses.
SecretClientBuilder	pipeline(com.azure.core.http.HttpPipeline pipeline) Sets the HTTP pipeline to use for the service client.
SecretClientBuilder	retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy) Sets the RetryPolicy that is used when each request is sent.
SecretClientBuilder	serviceVersion(SecretServiceVersion version) Sets the SecretServiceVersion that is used when making API requests.
SecretClientBuilder	vaultUrl(String vaultUrl) Sets the vault 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

SecretClientBuilder

public SecretClientBuilder()

The constructor with defaults.

Method Detail

buildClient

public SecretClient buildClient()

Creates a SecretClient based on options set in the builder. Every time buildClient() is called, a new instance of SecretClient 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 SecretClientBuilder.vaultUrl(String) key vault url are required to build the client.

Returns:

A SecretClient with the options set from the builder.

Throws:

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

buildAsyncClient

public SecretAsyncClient buildAsyncClient()

Creates a SecretAsyncClient based on options set in the builder. Every time buildAsyncClient() is called, a new instance of SecretAsyncClient 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 SecretClientBuilder.vaultUrl(String) key vault url are required to build the client.

Returns:

A SecretAsyncClient with the options set from the builder.

Throws:

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

vaultUrl

public SecretClientBuilder vaultUrl(String vaultUrl)

Sets the vault url to send HTTP requests to.

Parameters:

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

Returns:

the updated SecretClientBuilder object.

Throws:

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

credential

public SecretClientBuilder 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 SecretClientBuilder object.

Throws:

NullPointerException - if credential is null.

httpLogOptions

public SecretClientBuilder 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 SecretClientBuilder object.

addPolicy

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

Adds a policy to the set of existing policies that are executed after SecretAsyncClient or SecretClient required policies.

Parameters:

policy - The policy to be added.

Returns:

the updated SecretClientBuilder object.

Throws:

NullPointerException - if policy is null.

httpClient

public SecretClientBuilder 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 SecretClientBuilder object.

Throws:

NullPointerException - If client is null.

pipeline

public SecretClientBuilder 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 SecretAsyncClient or SecretClient.

Parameters:

pipeline - The HTTP pipeline to use for sending service requests and receiving responses.

Returns:

the updated SecretClientBuilder object.

configuration

public SecretClientBuilder 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 SecretClientBuilder object.

serviceVersion

public SecretClientBuilder serviceVersion(SecretServiceVersion version)

Sets the SecretServiceVersion 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 - SecretServiceVersion of the service API used when making requests.

Returns:

The updated SecretClientBuilder object.

retryPolicy

public SecretClientBuilder 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 SecretClientBuilder object.

Throws:

NullPointerException - if the specified retryPolicy is null.