com.azure.core.http.policy

Class UserAgentPolicy

java.lang.Object

com.azure.core.http.policy.UserAgentPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class UserAgentPolicy
extends Object
implements HttpPipelinePolicy

Pipeline policy that adds 'User-Agent' header to a request. Format for User-Agent policy is outlined in https://azuresdkspecs.z5.web.core.windows.net/JavaSpec.html under "Client Library Usage Telemetry".

Constructor Summary

Constructors

Constructor and Description
UserAgentPolicy() Creates a UserAgentPolicy with a default user agent string.
UserAgentPolicy(String userAgent) Creates a UserAgentPolicy with userAgent as the header value.
UserAgentPolicy(String sdkName, String sdkVersion, Configuration configuration) Creates a UserAgentPolicy with the sdkName and sdkVersion in the User-Agent header value.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<HttpResponse>	process(HttpPipelineCallContext context, HttpPipelineNextPolicy next) Process 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

Constructor Detail

UserAgentPolicy

public UserAgentPolicy()

Creates a UserAgentPolicy with a default user agent string.

UserAgentPolicy

public UserAgentPolicy(String userAgent)

Creates a UserAgentPolicy with userAgent as the header value. If userAgent is null, then the default user agent value is used.

Parameters:

userAgent - The user agent string to add to request headers.

UserAgentPolicy

public UserAgentPolicy(String sdkName,
                       String sdkVersion,
                       Configuration configuration)

Creates a UserAgentPolicy with the sdkName and sdkVersion in the User-Agent header value. If the passed configuration contains true for AZURE_TELEMETRY_DISABLED the platform information won't be included in the user agent.

Parameters:

sdkName - Name of the client library.

sdkVersion - Version of the client library.

configuration - Configuration store that will be checked for the AZURE_TELEMETRY_DISABLED.

Method Detail

process

public reactor.core.publisher.Mono<HttpResponse> process(HttpPipelineCallContext context,
                                                         HttpPipelineNextPolicy next)

Description copied from interface: HttpPipelinePolicy

Process provided request context and invokes the next policy.

Specified by:

process in interface HttpPipelinePolicy

Parameters:

context - request context

next - the next policy to invoke

Returns:

publisher that initiate the request upon subscription and emits response on completion.