Package com.azure.messaging.webpubsub

Class WebPubSubAuthenticationPolicy

java.lang.Object

com.azure.messaging.webpubsub.WebPubSubAuthenticationPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public final class WebPubSubAuthenticationPolicy
extends Object
implements HttpPipelinePolicy

An HttpPipelinePolicy for authenticating against the Azure Web Pub Sub service. Used in the default HTTP pipeline when built using the WebPubSubServiceClientBuilder, but available here in case an HTTP pipeline is built outside of the WebPubSubServiceClientBuilder.

See Also:

• WebPubSubServiceClientBuilder

Constructor Summary

Constructors

Constructor	Description
WebPubSubAuthenticationPolicy(AzureKeyCredential credential)	Creates a new instance of the WebPubSubAuthenticationPolicy, where it will make use of the provided AzureKeyCredential whenever a HTTP request is made to apply the appropriate modifications to the HTTP request to gain access to the Azure Web Pub Sub service.

Method Summary

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

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, processSync

Constructor Details

WebPubSubAuthenticationPolicy

public WebPubSubAuthenticationPolicy(AzureKeyCredential credential)

Creates a new instance of the WebPubSubAuthenticationPolicy, where it will make use of the provided AzureKeyCredential whenever a HTTP request is made to apply the appropriate modifications to the HTTP request to gain access to the Azure Web Pub Sub service.

Note that whilst the credential passed into the constructor is immutable within this policy, the key contained within the credential is not, and as such can be updated by calling AzureKeyCredential.update(String) as appropriate.

Parameters:

credential - The AzureKeyCredential that will be used for all outgoing HTTP requests to the Azure Web Pub Sub service.

Method Details

process

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

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.