Interface IPromptConnectionConfig_ConnectTimeout

public interface IPromptConnectionConfig_ConnectTimeout
Mixin for a prompt query configuration model that allows the user to configure the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider) to be established.

Use of this mixin is optional, but ensures a consistent name for the property. When different prompt service handlers use the same property name, switching between different prompt service handlers preserves the configured data.

See also the <xp:connectTimeout/> Faces component from the http://www.xima.de/taglib/xfc/prompt namespace, which provides a user interface for editing the data defined by this mixin.

Since:
8.5.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTR_CONNECT_TIMEOUT
    The name of connection timeout attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    Duration
    getConnectTimeout()
    Gets the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider) to be established.
    void
    setConnectTimeout(Duration connectionTimeout)
    Sets the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider) to be established.

  • Field Details

    • ATTR_CONNECT_TIMEOUT

      static final String ATTR_CONNECT_TIMEOUT
      The name of connection timeout attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
      See Also:

  • Method Details

    • getConnectTimeout

      Duration getConnectTimeout()
      Gets the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider) to be established.
      Returns:
      The connection timeout.

    • setConnectTimeout

      void setConnectTimeout(Duration connectionTimeout)
      Sets the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider) to be established.
      Parameters:
      connectionTimeout - The connection timeout to set.