Class UserAgentPolicy
- All Implemented Interfaces:
HttpPipelinePolicy
The format for the "User-Agent" string is outlined in Azure Core: Telemetry policy.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Key forContext
to add a value which will be appended to the User-Agent supplied in this policy in an ad-hoc manner.static final String
Key forContext
to add a value which will override the User-Agent supplied in this policy in an ad-hoc manner. -
Constructor Summary
ConstructorDescriptionCreates aUserAgentPolicy
with a default user agent string.UserAgentPolicy
(String userAgent) Creates a UserAgentPolicy withuserAgent
as the header value.UserAgentPolicy
(String sdkName, String sdkVersion, Configuration configuration, ServiceVersion version) Deprecated.UserAgentPolicy
(String applicationId, String sdkName, String sdkVersion, Configuration configuration) Creates a UserAgentPolicy with thesdkName
andsdkVersion
in the User-Agent header value. -
Method Summary
Modifier and TypeMethodDescriptionprocess
(HttpPipelineCallContext context, HttpPipelineNextPolicy next) Updates the "User-Agent" header with the value supplied in the policy.processSync
(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next) Updates the "User-Agent" header with the value supplied in the 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
-
Field Details
-
OVERRIDE_USER_AGENT_CONTEXT_KEY
Key forContext
to add a value which will override the User-Agent supplied in this policy in an ad-hoc manner.- See Also:
-
APPEND_USER_AGENT_CONTEXT_KEY
Key forContext
to add a value which will be appended to the User-Agent supplied in this policy in an ad-hoc manner.- See Also:
-
-
Constructor Details
-
UserAgentPolicy
public UserAgentPolicy()Creates aUserAgentPolicy
with a default user agent string. -
UserAgentPolicy
Creates a UserAgentPolicy withuserAgent
as the header value. IfuserAgent
isnull
, then the default user agent value is used.- Parameters:
userAgent
- The user agent string to add to request headers.
-
UserAgentPolicy
public UserAgentPolicy(String applicationId, String sdkName, String sdkVersion, Configuration configuration) Creates a UserAgentPolicy with thesdkName
andsdkVersion
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:
applicationId
- User specified application Id.sdkName
- Name of the client library.sdkVersion
- Version of the client library.configuration
- Configuration store that will be checked forConfiguration.PROPERTY_AZURE_TELEMETRY_DISABLED
. Ifnull
is passed theglobal configuration
will be checked.
-
UserAgentPolicy
@Deprecated public UserAgentPolicy(String sdkName, String sdkVersion, Configuration configuration, ServiceVersion version) Deprecated.Creates a UserAgentPolicy with thesdkName
andsdkVersion
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.version
-ServiceVersion
of the service to be used when making requests.configuration
- Configuration store that will be checked forConfiguration.PROPERTY_AZURE_TELEMETRY_DISABLED
. Ifnull
is passed theglobal configuration
will be checked.
-
-
Method Details
-
process
Updates the "User-Agent" header with the value supplied in the policy.The
context
will be checked forOverride-User-Agent
andAppend-User-Agent
.Override-User-Agent
will take precedence over the value supplied in the policy,Append-User-Agent
will be appended to the value supplied in the policy.- Specified by:
process
in interfaceHttpPipelinePolicy
- Parameters:
context
- request contextnext
- The next policy to invoke.- Returns:
- A publisher that initiates the request upon subscription and emits a response on completion.
-
processSync
Updates the "User-Agent" header with the value supplied in the policy synchronously.The
context
will be checked forOverride-User-Agent
andAppend-User-Agent
.Override-User-Agent
will take precedence over the value supplied in the policy,Append-User-Agent
will be appended to the value supplied in the policy.- Specified by:
processSync
in interfaceHttpPipelinePolicy
- Parameters:
context
- request contextnext
- The next policy to invoke.- Returns:
- A response.
-
UserAgentPolicy(String, String, String, Configuration)
instead.