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

public class KeyCredentialPolicy
extends Object
implements HttpPipelinePolicy

The KeyCredentialPolicy class is an implementation of the HttpPipelinePolicy interface. This policy uses a KeyCredential to set the authorization key for a request in the form of a header.

This class is useful when you need to authorize requests with a key. It ensures that the requests are sent over HTTPS to prevent the key from being leaked. The key is set in the header of the HTTP request.

Code sample:

In this example, a KeyCredentialPolicy is created with a key and a header name. The policy can then be added to the pipeline. The request sent by the pipeline will then include the specified header with the key as its value.

 KeyCredential credential = new KeyCredential("my_key");
 KeyCredentialPolicy policy = new KeyCredentialPolicy("my_header", credential);
 

See Also:

• com.azure.core.http.policy
• HttpPipelinePolicy
• KeyCredential
• HttpPipeline
• HttpRequest
• HttpResponse
• HttpHeaders

Constructor Summary

Constructors

Constructor	Description
KeyCredentialPolicy(String name, KeyCredential credential)	Creates a policy that uses the passed KeyCredential to set the specified header name.
KeyCredentialPolicy(String name, KeyCredential credential, String prefix)	Creates a policy that uses the passed KeyCredential to set the specified header name.

Method Summary

Modifier and Type	Method	Description
Mono<HttpResponse>	process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)	Processes provided request context and invokes the next policy.
HttpResponse	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

public KeyCredentialPolicy(String name,
 KeyCredential credential)

Creates a policy that uses the passed KeyCredential to set the specified header name.

Parameters:

name - The name of the key header that will be set to KeyCredential.getKey().

credential - The KeyCredential containing the authorization key to use.

Throws:

NullPointerException - If name or credential is null.

IllegalArgumentException - If name is empty.

KeyCredentialPolicy

public KeyCredentialPolicy(String name,
 KeyCredential credential,
 String prefix)

Creates a policy that uses the passed KeyCredential to set the specified header name.

The prefix will be applied before the KeyCredential.getKey() when setting the header. A space will be inserted between prefix and credential.

Parameters:

name - The name of the key header that will be set to KeyCredential.getKey().

credential - The KeyCredential containing the authorization key to use.

prefix - The prefix to apply before the credential, for example "SharedAccessKey credential".

Throws:

NullPointerException - If name or credential is null.

IllegalArgumentException - If name is empty.

Method Details

process

public Mono<HttpResponse> process(HttpPipelineCallContext context,
 HttpPipelineNextPolicy next)

Description copied from interface: HttpPipelinePolicy

Processes provided request context and invokes the next policy.

Specified by:

process in interface HttpPipelinePolicy

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

public HttpResponse processSync(HttpPipelineCallContext context,
 HttpPipelineNextSyncPolicy next)

Description copied from interface: HttpPipelinePolicy

Processes provided request context and invokes the next policy synchronously.

Specified by:

processSync in interface HttpPipelinePolicy

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.