Package com.azure.core.http.policy
Class AzureKeyCredentialPolicy
java.lang.Object
com.azure.core.http.policy.KeyCredentialPolicy
com.azure.core.http.policy.AzureKeyCredentialPolicy
- All Implemented Interfaces:
HttpPipelinePolicy
Pipeline policy that uses an
AzureKeyCredential
to set the authorization key for a request.
Requests sent with this pipeline policy are required to use HTTPS
. If the request isn't using HTTPS
an exception will be thrown to prevent leaking the key.
-
Constructor Summary
ConstructorDescriptionAzureKeyCredentialPolicy
(String name, AzureKeyCredential credential) Creates a policy that uses the passedAzureKeyCredential
to set the specified header name.AzureKeyCredentialPolicy
(String name, AzureKeyCredential credential, String prefix) Creates a policy that uses the passedAzureKeyCredential
to set the specified header name. -
Method Summary
Methods inherited from class com.azure.core.http.policy.KeyCredentialPolicy
process, processSync
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.azure.core.http.policy.HttpPipelinePolicy
getPipelinePosition
-
Constructor Details
-
AzureKeyCredentialPolicy
Creates a policy that uses the passedAzureKeyCredential
to set the specified header name.- Parameters:
name
- The name of the key header that will be set toKeyCredential.getKey()
.credential
- TheAzureKeyCredential
containing the authorization key to use.- Throws:
NullPointerException
- Ifname
orcredential
isnull
.IllegalArgumentException
- Ifname
is empty.
-
AzureKeyCredentialPolicy
Creates a policy that uses the passedAzureKeyCredential
to set the specified header name.The
prefix
will be applied before theKeyCredential.getKey()
when setting the header. A space will be inserted betweenprefix
and credential.- Parameters:
name
- The name of the key header that will be set toKeyCredential.getKey()
.credential
- TheAzureKeyCredential
containing the authorization key to use.prefix
- The prefix to apply before the credential, for example "SharedAccessKey credential".- Throws:
NullPointerException
- Ifname
orcredential
isnull
.IllegalArgumentException
- Ifname
is empty.
-