Class HttpClientHelper

Namespace

Steeltoe.Common.Http

Assembly

Steeltoe.Common.Http.dll

public static class HttpClientHelper

Inheritance

object

HttpClientHelper

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

SteeltoeUserAgent

public static string SteeltoeUserAgent { get; }

Property Value

string

Methods

ConfigureCertificateValidation(bool, out SecurityProtocolType, out RemoteCertificateValidationCallback)

Disable certificate validation on demand. Has no effect unless IsFullFramework

public static void ConfigureCertificateValidation(bool validateCertificates, out SecurityProtocolType protocolType, out RemoteCertificateValidationCallback prevValidator)

Parameters

validateCertificates bool

Whether or not certificates should be validated

protocolType SecurityProtocolType

SecurityProtocolType

prevValidator RemoteCertificateValidationCallback

Pre-existing certificate validation callback

GetAccessToken(string, string, string, int, bool, HttpClient, ILogger)

public static Task<string> GetAccessToken(string accessTokenUri, string clientId, string clientSecret, int timeout = 10000, bool validateCertificates = true, HttpClient httpClient = null, ILogger logger = null)

Parameters

accessTokenUri string

clientId string

clientSecret string

timeout int

validateCertificates bool

httpClient HttpClient

logger ILogger

Returns

Task<string>

GetAccessToken(Uri, string, string, int, bool, Dictionary<string, string>, HttpClient, ILogger)

public static Task<string> GetAccessToken(Uri accessTokenUri, string clientId, string clientSecret, int timeout = 10000, bool validateCertificates = true, Dictionary<string, string> additionalParams = null, HttpClient httpClient = null, ILogger logger = null)

Parameters

accessTokenUri Uri

clientId string

clientSecret string

timeout int

validateCertificates bool

additionalParams Dictionary<string, string>

httpClient HttpClient

logger ILogger

Returns

Task<string>

GetEncodedUserPassword(string, string)

public static string GetEncodedUserPassword(string user, string password)

Parameters

user string

password string

Returns

string

GetHttpClient(bool, int)

Gets an HttpClient with user agent SteeltoeUserAgent

public static HttpClient GetHttpClient(bool validateCertificates, int timeoutMillis)

Parameters

validateCertificates bool

Whether or not remote certificates should be validated

timeoutMillis int

Timeout in milliseconds

Returns

HttpClient

GetHttpClient(bool, HttpClientHandler, int)

Gets an HttpClient with user agent SteeltoeUserAgent

public static HttpClient GetHttpClient(bool validateCertificates, HttpClientHandler handler, int timeoutMillis)

Parameters

validateCertificates bool

Whether or not remote certificates should be validated

handler HttpClientHandler

A pre-defined HttpClientHandler

timeoutMillis int

Timeout in milliseconds

Returns

HttpClient

GetHttpClient(HttpMessageHandler, int)

Gets an HttpClient with user agent SteeltoeUserAgent

public static HttpClient GetHttpClient(HttpMessageHandler handler, int timeoutMillis = 1500)

Parameters

handler HttpMessageHandler

A pre-defined HttpMessageHandler

timeoutMillis int

Timeout in milliseconds

Returns

HttpClient

GetRequestMessage(HttpMethod, string, Func<string>)

Creates an HttpRequestMessage from the provided information

public static HttpRequestMessage GetRequestMessage(HttpMethod method, string requestUri, Func<string> getAccessToken)

Parameters

method HttpMethod

HttpMethod

requestUri string

The remote Uri

getAccessToken Func<string>

A means of including a bearer token

Returns

HttpRequestMessage

GetRequestMessage(HttpMethod, string, string, string)

Creates an HttpRequestMessage from the provided information

public static HttpRequestMessage GetRequestMessage(HttpMethod method, string requestUri, string userName, string password)

Parameters

method HttpMethod

HttpMethod

requestUri string

The remote Uri

userName string

Optional Basic Auth Username. Not used unless password is not null or empty

password string

Optional Basic Auth Password

Returns

HttpRequestMessage

RestoreCertificateValidation(bool, SecurityProtocolType, RemoteCertificateValidationCallback)

Returns certificate validation to its original state. Has no effect unless IsFullFramework

public static void RestoreCertificateValidation(bool validateCertificates, SecurityProtocolType protocolType, RemoteCertificateValidationCallback prevValidator)

Parameters

validateCertificates bool

Whether or not certificates should be validated

protocolType SecurityProtocolType

SecurityProtocolType

prevValidator RemoteCertificateValidationCallback

Pre-existing certificate validation callback