Package de.interactive_instruments.etf.client

Interface EtfValidatorClient

  • All Known Subinterfaces:
    EtfValidatorClientWithExecutorService
    public interface EtfValidatorClient
    EtfValidatorClient is used to initialize a connection to an ETF instance and to create EtfEndpoint objects. The EtfEndpoint objects are thread safe and cache certain responses to ensure a fast connection and avoid unnecessary data exchange. The client using this library should hold the returned EtfEndpoint instance for its own lifetime.

    • Method Detail

      • create

        static EtfValidatorClient create()
        Create a new builder object for the Endpoint configuration
        Returns:
        builder object

      • url

        EtfValidatorClient url​(java.net.URL url)
        Set the URL to the validator
        Parameters:
        url - URL to use
        Returns:
        builder object

      • authenticator

        EtfValidatorClient authenticator​(java.net.Authenticator authenticator)
        Set the authenticator for the ETF validator
        Parameters:
        authenticator - Authenticator to use for authentication
        Returns:
        builder object
        See Also:
        HttpBasicAuthentication

      • locale

        EtfValidatorClient locale​(java.util.Locale locale)
        Set the locale so that the messages from the tests are translated into the desired language. This only works if the test developer has provided a language file for that language. English is used as fallback or, if not available, the first language found.
        Parameters:
        locale - language for messages
        Returns:
        builder object

      • timeout

        EtfValidatorClient timeout​(java.time.Duration duration)
        Overrides the default timeout for requests, which is 3 minutes. If the response is not received within the specified timeout then an RemoteInvocationException is thrown.
        Parameters:
        duration - the timeout duration
        Returns:
        builder object
        Since:
        1.1

      • floatFormat

        EtfValidatorClient floatFormat​(java.text.DecimalFormat format)
        Set the formatting of floating point numbers that occur in messages. Example: new DecimalFormat("0.000", new DecimalFormatSymbols(Locale.ENGLISH))
        Parameters:
        format - DecimalFormat for formatting floating point numbers in messages
        Returns:
        builder object
        Since:
        1.6

      • init

        EtfEndpoint init()
        Finalize the Configuration and return an Endpoint object
        Returns:
        new Endpoint object