Class HttpProtocolClientBuilder
Builds an
Inheritance
Implements
Namespace: Ellucian.Ethos.Integration.Client
Assembly: Ellucian.Ethos.Integration.dll
Syntax
public class HttpProtocolClientBuilder : object, IHttpProtocolClientBuilder
Constructors
HttpProtocolClientBuilder(HttpClient, Nullable<Int32>)
Instantiates a new Http client builder service and initializes it with default configurations for the SslProtocols, ClientCertificateOptions and DefaultRequestHeaders.
Declaration
public HttpProtocolClientBuilder(HttpClient client, int? connectionTimeOut = null)
Parameters
| Type | Name | Description |
|---|---|---|
| HttpClient | client | Instance of |
| System.Nullable<System.Int32> | connectionTimeOut | Time in seconds to allow an http connection to time out. Default is 300 seconds (5 minutes). |
Fields
CLIENT_NAME
Declaration
const string CLIENT_NAME = null
Field Value
| Type | Description |
|---|---|
| System.String |
CONNECTION_TIMEOUT
Time in seconds to allow an http connection to time out. Default is 300 seconds (5 minutes).
Declaration
static int CONNECTION_TIMEOUT
Field Value
| Type | Description |
|---|---|
| System.Int32 |
PROTOCOL
Declaration
const SslProtocols PROTOCOL = null
Field Value
| Type | Description |
|---|---|
| SslProtocols |
Properties
Client
Declaration
public HttpClient Client { get; }
Property Value
| Type | Description |
|---|---|
| HttpClient |
Methods
BuildHttpClient()
Creates instance of
Declaration
public HttpClient BuildHttpClient()
Returns
| Type | Description |
|---|---|
| HttpClient | Returns instance of HttpClient with a default timeout. |
BuildHttpClient(Nullable<Int32>)
Creates instance of
Declaration
public HttpClient BuildHttpClient(int? connectionTimeout)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int32> | connectionTimeout | An optional parameter indicating the amount of seconds before the client request should time out. |
Returns
| Type | Description |
|---|---|
| HttpClient | Returns instance of HttpClient. |