Package com.azure.core.http.policy

Class AddHeadersFromContextPolicy

java.lang.Object
com.azure.core.http.policy.AddHeadersFromContextPolicy
All Implemented Interfaces:
HttpPipelinePolicy
public class AddHeadersFromContextPolicy extends Object implements HttpPipelinePolicy
The pipeline policy that override or add HttpHeaders in HttpRequest by reading values from Context with key 'azure-http-headers-key'. The value for this key should be of type HttpHeaders for it to be added in HttpRequest.

Code Sample: Add multiple HttpHeader in Context and call client

 // Create ConfigurationClient for example
 ConfigurationClient configurationClient = new ConfigurationClientBuilder()
       .connectionString("endpoint={endpoint_value};id={id_value};secret={secret_value}")
       .buildClient();
 // Add your headers
 HttpHeaders headers = new HttpHeaders();
 headers.put("my-header1", "my-header1-value");
 headers.put("my-header2", "my-header2-value");
 headers.put("my-header3", "my-header3-value");
 // Call API by passing headers in Context.
 configurationClient.addConfigurationSettingWithResponse(
       new ConfigurationSetting().setKey("key").setValue("value"),
       new Context(AddHeadersFromContextPolicy.AZURE_REQUEST_HTTP_HEADERS_KEY, headers));
 // Above three HttpHeader will be added in outgoing HttpRequest.

  • Field Details

    • AZURE_REQUEST_HTTP_HEADERS_KEY

      public static final String AZURE_REQUEST_HTTP_HEADERS_KEY
      Key used to override headers in HttpRequest. The Value for this key should be HttpHeaders.
      See Also:

  • Constructor Details

    • AddHeadersFromContextPolicy

      public AddHeadersFromContextPolicy()

  • Method Details