Class EthosClientBuilder
Factory used for building Ethos clients. This is the primary means of building the desired Ethos client class. This class supports building clients specified by the various client types.
Inheritance
Namespace: Ellucian.Ethos.Integration.Client
Assembly: Ellucian.Ethos.Integration.dll
Syntax
public class EthosClientBuilder : object
Constructors
EthosClientBuilder(String)
Constructs this class with the given Ethos Integration API key.
Declaration
public EthosClientBuilder(string apiKey)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | apiKey | The API key used to build the access token for the desired Ethos client. |
Fields
apiKey
The API key used to build the access token within the given EthosClient.
Declaration
readonly string apiKey
Field Value
| Type | Description |
|---|---|
| System.String |
builder
Interface used in HttpProtocolClientBuilder.
Declaration
protected IHttpProtocolClientBuilder builder
Field Value
| Type | Description |
|---|---|
| IHttpProtocolClientBuilder |
ConnectionTimeout
The connection timeout for the factory. Specified in seconds.
Declaration
int? ConnectionTimeout
Field Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Methods
BuildEthosConfigurationClient()
Gets an EthosConfigurationClient given the AccessToken.
Declaration
public EthosConfigurationClient BuildEthosConfigurationClient()
Returns
| Type | Description |
|---|---|
| EthosConfigurationClient | A new EthosConfigurationClient using the given apiKey, or null if the apiKey is null. |
BuildEthosErrorsClient()
Gets an EthosErrorsClient that will use the given API key to authenticate.
Declaration
public EthosErrorsClient BuildEthosErrorsClient()
Returns
| Type | Description |
|---|---|
| EthosErrorsClient | A new EthosErrorsClient using the given apiKey, or null if the apiKey is null. |
BuildEthosFilterQueryClient()
Gets an EthosFilterQueryClient that will use the given API key to authenticate.
Declaration
public EthosFilterQueryClient BuildEthosFilterQueryClient()
Returns
| Type | Description |
|---|---|
| EthosFilterQueryClient | An EthosFilterQueryClient using the given apiKey and timeout values. |
BuildEthosMessagesClient()
Gets an EthosMessagesClient given the AccessToken.
Declaration
public EthosMessagesClient BuildEthosMessagesClient()
Returns
| Type | Description |
|---|---|
| EthosMessagesClient | A new EthosMessagesClient using the given apiKey, or null if the apiKey is null. |
BuildEthosProxyClient()
Gets an EthosProxyClient that will use the given API key to authenticate.
Declaration
public EthosProxyClient BuildEthosProxyClient()
Returns
| Type | Description |
|---|---|
| EthosProxyClient | A new EthosProxyClient using the given apiKey, or null if the apiKey is null. |
WithConnectionTimeout(Int32)
Give the client factory a connection timeout so that connections will time out after
connectionTimeout
seconds.
Declaration
public EthosClientBuilder WithConnectionTimeout(int connectionTimeout)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | connectionTimeout | The connection timeout in seconds. |
Returns
| Type | Description |
|---|---|
| EthosClientBuilder | Ethos client builder. |