Package com.ellucian.ethos.integration.client

Class EthosClientBuilder

  • public class EthosClientBuilder
extends Object
    Builder 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, using a builder pattern.

    • Constructor Detail

      • EthosClientBuilder

        public EthosClientBuilder​(String apiKey)
        Constructs this class with the given apiKey.
        Parameters:
        apiKey - The API key used to build the access token for the desired Ethos client.

    • Method Detail

      • withConnectionTimeout

        public EthosClientBuilder withConnectionTimeout​(Integer connectionTimeout)
        Sets the connection timeout value to be used. Can be a null value.
        Parameters:
        connectionTimeout - The connection timeout value to use, can be null.
        Returns:
        This builder with the connection timeout value set.

      • withConnectionRequestTimeout

        public EthosClientBuilder withConnectionRequestTimeout​(Integer connectionRequestTimeout)
        Sets the connection request timeout value to be used. Can be a null value.
        Parameters:
        connectionRequestTimeout - The connection request timeout value to use, can be null.
        Returns:
        This builder with the connection request timeout value set.

      • withSocketTimeout

        public EthosClientBuilder withSocketTimeout​(Integer socketTimeout)
        Sets the socket timeout value to be used. Can be a null value.
        Parameters:
        socketTimeout - The socket timeout value to use, can be null.
        Returns:
        This builder with the socket timeout value set.

      • buildEthosErrorsClient

        public EthosErrorsClient buildEthosErrorsClient()
        Builds an EthosErrorsClient that will use the given API key to authenticate, and the specified timeout values to connect with.
        Returns:
        an EthosErrorsClient using the given apiKey and timeout values.

      • buildEthosConfigurationClient

        public EthosConfigurationClient buildEthosConfigurationClient()
        Builds an EthosConfigurationClient that will use the given API key to authenticate, and the specified timeout values to connect with.
        Returns:
        an EthosConfigurationClient using the given apiKey and timeout values.

      • buildEthosProxyClient

        public EthosProxyClient buildEthosProxyClient()
        Builds an EthosProxyClient that will use the given API key to authenticate, and the specified timeout values to connect with.
        Returns:
        an EthosProxyClient using the given apiKey and timeout values.

      • buildEthosProxyAsyncClient

        public EthosProxyClientAsync buildEthosProxyAsyncClient()
        Builds an EthosProxyClientAsync that will use the given API key to authenticate, and the specified timeout values to connect with. This client can perform all of the operations that EthosProxyClient can. Additionally, it can also perform paging operations wrapped in CompletableFuture CompletableFutures for asynchronous paging.
        Returns:
        an EthosProxyClient using the given apiKey and timeout values.

      • buildEthosMessagesClient

        public EthosMessagesClient buildEthosMessagesClient()
        Builds an EthosMessagesClient that will use the given API key to authenticate, and the specified timeout values to connect with.
        Returns:
        an EthosMessagesClient using the given apiKey and timeout values.

      • buildEthosFilterQueryClient

        public EthosFilterQueryClient buildEthosFilterQueryClient()
        Builds an EthosFilterQueryClient that will use the given API key to authenticate, and the specified timeout values to connect with.
        Returns:
        an EthosFilterQueryClient using the given apiKey and timeout values.