Package de.xima.fc.interfaces.config

Interface IRestClientConfig

  • All Superinterfaces:
    Serializable
    public interface IRestClientConfig
extends Serializable
    Interface for global, mostly technical, configuration for the REST client.
    Since:
    8.2.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • connectTimeout

        long connectTimeout()
        Gets the connect timeout for the REST client.
        Returns:
        The connect timeout for the REST client.

      • defaultTransportType

        EHttpClientTransportType defaultTransportType()
        Gets the default HTTP transport type for the REST client, used to send HTTP requests.
        Returns:
        The default HTTP transport type.

      • localBaseUrl

        String localBaseUrl()
        Gets the local base URL for the REST client. This is the URL used by the server to access itself.
        Returns:
        The local base URL for the local REST client.

      • readTimeout

        long readTimeout()
        Gets the read timeout for the REST client.
        Returns:
        The read timeout for the REST client.

      • remoteBaseUrl

        String remoteBaseUrl()
        Gets the remote base URL for the REST client. This is the URL used by clients to access the server.
        Returns:
        The remote base URL for the remote REST client.

      • tempDir

        Path tempDir()
        Gets the temporary directory for the portal frontend application.
        Returns:
        The temporary directory for the portal frontend application.

      • calculateLocalBaseUrl

        String calculateLocalBaseUrl​(javax.servlet.http.HttpServletRequest request)
        Calculates the local rest base URL for the given request.
        Parameters:
        request - The request to calculate the base URL for.
        Returns:
        The base URL for the given request.

      • appendApiPath

        String appendApiPath​(String base)
        Appends the API path to the given base URL.
        Parameters:
        base - The base URL.
        Returns:
        The base URL with the API path appended.

      • pollIntervalUnreadMessagesNumber

        long pollIntervalUnreadMessagesNumber()
        Poll interval for the number of unread messages.
        Returns:
        The poll interval in seconds for the number of unread messages.

      • pollIntervalFormRecordHasChanges

        long pollIntervalFormRecordHasChanges()
        Poll interval for checking if a form record has changes.
        Returns:
        The poll interval in seconds for checking if a form record has changes.

      • pollIntervalFormRecordListHasChanges

        long pollIntervalFormRecordListHasChanges()
        Poll interval for checking if there are new form records in the list.
        Returns:
        The poll interval in seconds for checking if the form record list has changes.

      • maxResultFormRecordSearchLimit

        long maxResultFormRecordSearchLimit()
        Maximum number of results for form record search.
        Returns:
        The maximum number of results for form record search.