Package com.azure.messaging.webpubsub

Class WebPubSubAuthenticationPolicy

java.lang.Object
com.azure.messaging.webpubsub.WebPubSubAuthenticationPolicy
All Implemented Interfaces:
com.azure.core.http.policy.HttpPipelinePolicy
public final class WebPubSubAuthenticationPolicy extends Object implements com.azure.core.http.policy.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 the WebPubSubServiceClientBuilder.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    WebPubSubAuthenticationPolicy(com.azure.core.credential.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<com.azure.core.http.HttpResponse>
    process(com.azure.core.http.HttpPipelineCallContext context, com.azure.core.http.HttpPipelineNextPolicy next)

    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(com.azure.core.credential.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<com.azure.core.http.HttpResponse> process(com.azure.core.http.HttpPipelineCallContext context, com.azure.core.http.HttpPipelineNextPolicy next)
      Specified by:
      process in interface com.azure.core.http.policy.HttpPipelinePolicy