Package com.azure.core.http.policy
Class KeyCredentialPolicy
java.lang.Object
com.azure.core.http.policy.KeyCredentialPolicy
- All Implemented Interfaces:
HttpPipelinePolicy
- Direct Known Subclasses:
AzureKeyCredentialPolicy
Pipeline policy that uses an
KeyCredential
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
ConstructorDescriptionKeyCredentialPolicy
(String name, KeyCredential credential) Creates a policy that uses the passedKeyCredential
to set the specified header name.KeyCredentialPolicy
(String name, KeyCredential credential, String prefix) Creates a policy that uses the passedKeyCredential
to set the specified header name. -
Method Summary
Modifier and TypeMethodDescriptionprocess
(HttpPipelineCallContext context, HttpPipelineNextPolicy next) Processes provided request context and invokes the next policy.processSync
(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next) Processes provided request context and invokes the next policy synchronously.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
-
KeyCredentialPolicy
Creates a policy that uses the passedKeyCredential
to set the specified header name.- Parameters:
name
- The name of the key header that will be set toKeyCredential.getKey()
.credential
- TheKeyCredential
containing the authorization key to use.- Throws:
NullPointerException
- Ifname
orcredential
isnull
.IllegalArgumentException
- Ifname
is empty.
-
KeyCredentialPolicy
Creates a policy that uses the passedKeyCredential
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
- TheKeyCredential
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.
-
-
Method Details
-
process
Description copied from interface:HttpPipelinePolicy
Processes provided request context and invokes the next policy.- Specified by:
process
in interfaceHttpPipelinePolicy
- Parameters:
context
- The request context.next
- The next policy to invoke.- Returns:
- A publisher that initiates the request upon subscription and emits a response on completion.
-
processSync
Description copied from interface:HttpPipelinePolicy
Processes provided request context and invokes the next policy synchronously.- Specified by:
processSync
in interfaceHttpPipelinePolicy
- Parameters:
context
- The request context.next
- The next policy to invoke.- Returns:
- A publisher that initiates the request upon subscription and emits a response on completion.
-