com.microsoft.rest.v2.policy

Class UserAgentPolicyFactory

java.lang.Object

com.microsoft.rest.v2.policy.UserAgentPolicyFactory

All Implemented Interfaces:

RequestPolicyFactory

public final class UserAgentPolicyFactory
extends Object
implements RequestPolicyFactory

Adds a 'User-Agent' header to a request.

Constructor Summary

Constructors

Constructor and Description
UserAgentPolicyFactory() Creates a UserAgentPolicyFactory with a default user agent string.
UserAgentPolicyFactory(String userAgent) Creates a UserAgentPolicyFactory with the given user agent string.

Method Summary

Modifier and Type	Method and Description
RequestPolicy	create(RequestPolicy next, RequestPolicyOptions options) Creates RequestPolicy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserAgentPolicyFactory

public UserAgentPolicyFactory(String userAgent)

Creates a UserAgentPolicyFactory with the given user agent string.

Parameters:

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

UserAgentPolicyFactory

public UserAgentPolicyFactory()

Creates a UserAgentPolicyFactory with a default user agent string.

Method Detail

create

public RequestPolicy create(RequestPolicy next,
                            RequestPolicyOptions options)

Description copied from interface: RequestPolicyFactory

Creates RequestPolicy.

Specified by:

create in interface RequestPolicyFactory

Parameters:

next - the next RequestPolicy in the request-response pipeline.

options - The optional arguments that can be passed to a RequestPolicy.

Returns:

the created RequestPolicy