Class KeyEncryptionKeyClientBuilder
- All Implemented Interfaces:
com.azure.core.client.traits.ConfigurationTrait<KeyEncryptionKeyClientBuilder>
,com.azure.core.client.traits.HttpTrait<KeyEncryptionKeyClientBuilder>
,com.azure.core.client.traits.TokenCredentialTrait<KeyEncryptionKeyClientBuilder>
,com.azure.core.cryptography.AsyncKeyEncryptionKeyResolver
,com.azure.core.cryptography.KeyEncryptionKeyResolver
KeyEncryptionKey async client
and
KeyEncryptionKey sync client
, by calling
buildAsyncKeyEncryptionKey(String)
and
buildKeyEncryptionKey(String)
respectively. It constructs an instance of the
desired client.
The minimal configuration options required by KeyEncryptionKeyClientBuilder
to build
AsyncKeyEncryptionKey
are jsonWebKey
or Azure Key Vault key identifier
and credential
.
The log detail level
, multiple custom policies
and custom
http client
can be optionally configured in the KeyEncryptionKeyClientBuilder
.
Alternatively, a custom http pipeline
with custom HttpPipelinePolicy
policies
can be specified. It provides finer control over the construction of AsyncKeyEncryptionKey
and
KeyEncryptionKey
The minimal configuration options required by keyEncryptionKeyClientBuilder
to build KeyEncryptionKey
are jsonWebKey
or
Azure Key Vault key identifier
and credential
.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddPolicy
(com.azure.core.http.policy.HttpPipelinePolicy policy) Adds apipeline policy
to apply on each request sent.Mono<? extends com.azure.core.cryptography.AsyncKeyEncryptionKey>
Creates a localKeyEncryptionKeyAsyncClient
based on options set in the builder.Mono<? extends com.azure.core.cryptography.AsyncKeyEncryptionKey>
buildAsyncKeyEncryptionKey
(String keyId) Creates aKeyEncryptionKeyAsyncClient
based on options set in the builder.com.azure.core.cryptography.KeyEncryptionKey
Creates a localKeyEncryptionKeyClient
for a given JSON Web Key.com.azure.core.cryptography.KeyEncryptionKey
buildKeyEncryptionKey
(String keyId) Creates aKeyEncryptionKey
based on options set in the builder.clientOptions
(com.azure.core.util.ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.configuration
(com.azure.core.util.Configuration configuration) Sets the configuration store that is used during construction of the service client.credential
(com.azure.core.credential.TokenCredential credential) Sets theTokenCredential
used to authorize requests sent to the service.Disables verifying if the authentication challenge resource matches the Key Vault or Managed HSM domain.httpClient
(com.azure.core.http.HttpClient client) Sets theHttpClient
to use for sending and receiving requests to and from the service.httpLogOptions
(com.azure.core.http.policy.HttpLogOptions logOptions) Sets thelogging configuration
to use when sending and receiving requests to and from the service.pipeline
(com.azure.core.http.HttpPipeline pipeline) Sets theHttpPipeline
to use for the service client.retryOptions
(com.azure.core.http.policy.RetryOptions retryOptions) Sets theRetryOptions
for all the requests made through the client.retryPolicy
(com.azure.core.http.policy.RetryPolicy retryPolicy) Sets theRetryPolicy
that is used when each request is sent.serviceVersion
(CryptographyServiceVersion version) Sets theCryptographyServiceVersion
that is used when making API requests.
-
Constructor Details
-
KeyEncryptionKeyClientBuilder
public KeyEncryptionKeyClientBuilder()The constructor with defaults.
-
-
Method Details
-
buildKeyEncryptionKey
Creates aKeyEncryptionKey
based on options set in the builder. Every timebuildKeyEncryptionKey(String)
is called, a new instance ofKeyEncryptionKey
is created.If
pipeline
is set, then thepipeline
andkeyId
are used to create theclient
. All other builder settings are ignored. Ifpipeline
is not set, then anAzure Key Vault credential
andkeyId
are required to build theclient
.- Specified by:
buildKeyEncryptionKey
in interfacecom.azure.core.cryptography.KeyEncryptionKeyResolver
- Returns:
- A
KeyEncryptionKeyClient
with the options set from the builder. - Throws:
IllegalStateException
- Ifcredential(TokenCredential)
orkeyId
have not been set.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
buildKeyEncryptionKey
Creates a localKeyEncryptionKeyClient
for a given JSON Web Key. Every timebuildKeyEncryptionKey(JsonWebKey)
is called, a new instance ofKeyEncryptionKey
is created. For local clients, all other builder settings are ignored.The
key
is required to build theclient
.- Parameters:
key
- TheJsonWebKey
to be used for cryptography operations.- Returns:
- A
KeyEncryptionKeyClient
with the options set from the builder. - Throws:
IllegalStateException
- If {key
is not set.
-
buildAsyncKeyEncryptionKey
public Mono<? extends com.azure.core.cryptography.AsyncKeyEncryptionKey> buildAsyncKeyEncryptionKey(String keyId) Creates aKeyEncryptionKeyAsyncClient
based on options set in the builder. Every timebuildAsyncKeyEncryptionKey(String)
is called, a new instance ofKeyEncryptionKeyAsyncClient
is created.If
pipeline
is set, then thepipeline
andkeyId
are used to create theasync client
. All other builder settings are ignored. Ifpipeline
is not set, then anAzure Key Vault credentials
andkeyId
are required to build theasync client
.- Specified by:
buildAsyncKeyEncryptionKey
in interfacecom.azure.core.cryptography.AsyncKeyEncryptionKeyResolver
- Parameters:
keyId
- The Azure Key Vault key identifier of the JSON Web Key stored in the key vault. You should validate that this URL references a valid Key Vault or Managed HSM resource. Refer to the following documentation for details.- Returns:
- A
KeyEncryptionKeyAsyncClient
with the options set from the builder. - Throws:
IllegalStateException
- Ifcredential(TokenCredential)
isnull
orkeyId
is empty ornull
.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
buildAsyncKeyEncryptionKey
public Mono<? extends com.azure.core.cryptography.AsyncKeyEncryptionKey> buildAsyncKeyEncryptionKey(JsonWebKey key) Creates a localKeyEncryptionKeyAsyncClient
based on options set in the builder. Every timebuildAsyncKeyEncryptionKey(String)
is called, a new instance ofKeyEncryptionKeyAsyncClient
is created. For local clients, all other builder settings are ignored.The
key
is required to build theclient
.- Parameters:
key
- The key to be used for cryptography operations.- Returns:
- A
KeyEncryptionKeyAsyncClient
with the options set from the builder. - Throws:
IllegalArgumentException
- Ifkey
has no id.IllegalStateException
- Ifkey
isnull
.
-
credential
public KeyEncryptionKeyClientBuilder credential(com.azure.core.credential.TokenCredential credential) Sets theTokenCredential
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 theTokenCredential
type.- Specified by:
credential
in interfacecom.azure.core.client.traits.TokenCredentialTrait<KeyEncryptionKeyClientBuilder>
- Parameters:
credential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object. - Throws:
NullPointerException
- Ifcredential
isnull
.
-
httpLogOptions
public KeyEncryptionKeyClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions) Sets thelogging configuration
to use when sending and receiving requests to and from the service. If alogLevel
is not provided, default value ofHttpLogDetailLevel.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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<KeyEncryptionKeyClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object.
-
addPolicy
public KeyEncryptionKeyClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy) Adds apipeline 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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<KeyEncryptionKeyClientBuilder>
- Parameters:
policy
- Apipeline policy
.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object. - Throws:
NullPointerException
- Ifpolicy
isnull
.
-
httpClient
Sets theHttpClient
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<KeyEncryptionKeyClientBuilder>
- Parameters:
client
- TheHttpClient
to use for requests.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object.
-
pipeline
Sets theHttpPipeline
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 noHttpPipeline
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 anHttpPipeline
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:
pipeline
in interfacecom.azure.core.client.traits.HttpTrait<KeyEncryptionKeyClientBuilder>
- Parameters:
pipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object.
-
configuration
Sets the configuration store that is used during construction of the service client. The default configuration store is a clone of theglobal configuration store
, useConfiguration.NONE
to bypass using configuration settings during construction.- Specified by:
configuration
in interfacecom.azure.core.client.traits.ConfigurationTrait<KeyEncryptionKeyClientBuilder>
- Parameters:
configuration
- The configuration store used to get configuration details.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object.
-
serviceVersion
Sets theCryptographyServiceVersion
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
-CryptographyServiceVersion
of the service to be used when making requests.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object.
-
retryPolicy
public KeyEncryptionKeyClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy) Sets theRetryPolicy
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 usingretryOptions(RetryOptions)
.- Parameters:
retryPolicy
- User's retry policy applied to each request.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object.
-
retryOptions
public KeyEncryptionKeyClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions) Sets theRetryOptions
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<KeyEncryptionKeyClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object.
-
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 theHttpClientOptions
class (a subclass of theClientOptions
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<KeyEncryptionKeyClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object. - See Also:
-
HttpClientOptions
-
disableChallengeResourceVerification
Disables verifying if the authentication challenge resource matches the Key Vault or Managed HSM domain. This verification is performed by default.- Returns:
- The updated
KeyEncryptionKeyClientBuilder
object.
-