Package io.micronaut.discovery.consul.client.v1.blockingqueries

Class BlockingQueriesConfiguration

java.lang.Object
io.micronaut.http.client.HttpClientConfiguration
io.micronaut.discovery.consul.client.v1.blockingqueries.BlockingQueriesConfiguration
@RequiresConsul @ConfigurationProperties("consul.client.blocking-queries") public class BlockingQueriesConfiguration extends io.micronaut.http.client.HttpClientConfiguration
Configuration for Consul Blocking Queries.
Since:
4.6.0
Author:
LE GALL Benoît

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.micronaut.http.client.HttpClientConfiguration

    io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration, io.micronaut.http.client.HttpClientConfiguration.DnsResolutionMode, io.micronaut.http.client.HttpClientConfiguration.Http2ClientConfiguration, io.micronaut.http.client.HttpClientConfiguration.WebSocketCompressionConfiguration

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final long
    DEFAULT_DELAY_DURATION_MILLISECONDS
    The default delay duration in milliseconds.
    static final String
    DEFAULT_MAX_WAIT_DURATION_MINUTES
    The default max wait duration in minutes.
    static final String
    PREFIX
    The prefix to use for all Consul's blocked queries settings.

    Fields inherited from class io.micronaut.http.client.HttpClientConfiguration

    DEFAULT_ALLOW_BLOCK_EVENT_LOOP, DEFAULT_CONNECTION_POOL_IDLE_TIMEOUT_SECONDS, DEFAULT_DNS_RESOLUTION_MODE, DEFAULT_EXCEPTION_ON_ERROR_STATUS, DEFAULT_FOLLOW_REDIRECTS, DEFAULT_MAX_CONTENT_LENGTH, DEFAULT_READ_IDLE_TIMEOUT_MINUTES, DEFAULT_READ_TIMEOUT_SECONDS, DEFAULT_SHUTDOWN_QUIET_PERIOD_MILLISECONDS, DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS

  • Constructor Summary

    Constructors
    Constructor
    Description
    BlockingQueriesConfiguration(ConsulConfiguration consulConfiguration, io.micronaut.core.convert.ConversionService conversionService)
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration
    getConnectionPoolConfiguration()
     
    @NonNull Duration
    getDelayDuration()
     
    @Nullable String
    getMaxWaitDuration()
     
    Optional<Duration>
    getReadTimeout()
     
    void
    setDelayDuration(Duration delayDuration)
    Sets the delay before each call to avoid flooding.
    void
    setMaxWaitDuration(@Nullable String maxWaitDuration)
    Specify the maximum duration for the blocking request.

    Methods inherited from class io.micronaut.http.client.HttpClientConfiguration

    getAddressResolverGroupName, getAlpnModes, getChannelOptions, getConnectionPoolIdleTimeout, getConnectTimeout, getConnectTtl, getDefaultCharset, getDnsResolutionMode, getEventLoopGroup, getHttp2Configuration, getHttpVersion, getLoggerName, getLogLevel, getMaxContentLength, getNumOfThreads, getPcapLoggingPathPattern, getPlaintextMode, getProxyAddress, getProxyPassword, getProxySelector, getProxyType, getProxyUsername, getReadIdleTimeout, getRequestTimeout, getShutdownQuietPeriod, getShutdownTimeout, getSslConfiguration, getThreadFactory, getWebSocketCompressionConfiguration, isAllowBlockEventLoop, isExceptionOnErrorStatus, isFollowRedirects, resolveProxy, setAddressResolverGroupName, setAllowBlockEventLoop, setAlpnModes, setChannelOptions, setConnectionPoolIdleTimeout, setConnectTimeout, setConnectTtl, setDefaultCharset, setDnsResolutionMode, setEventLoopGroup, setExceptionOnErrorStatus, setFollowRedirects, setHttpVersion, setLoggerName, setLogLevel, setMaxContentLength, setNumOfThreads, setPcapLoggingPathPattern, setPlaintextMode, setProxyAddress, setProxyPassword, setProxySelector, setProxyType, setProxyUsername, setReadIdleTimeout, setReadTimeout, setRequestTimeout, setShutdownQuietPeriod, setShutdownTimeout, setSslConfiguration, setThreadFactory

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • PREFIX

      public static final String PREFIX
      The prefix to use for all Consul's blocked queries settings.
      See Also:

    • DEFAULT_MAX_WAIT_DURATION_MINUTES

      public static final String DEFAULT_MAX_WAIT_DURATION_MINUTES
      The default max wait duration in minutes.
      See Also:

    • DEFAULT_DELAY_DURATION_MILLISECONDS

      public static final long DEFAULT_DELAY_DURATION_MILLISECONDS
      The default delay duration in milliseconds.
      See Also:

  • Constructor Details

    • BlockingQueriesConfiguration

      public BlockingQueriesConfiguration(ConsulConfiguration consulConfiguration, io.micronaut.core.convert.ConversionService conversionService)
      Default constructor.
      Parameters:
      consulConfiguration - ConsulConfiguration used as base.
      conversionService - Use to calculate the readTimeout from the maxWaitDuration.
      See Also:

  • Method Details

    • getConnectionPoolConfiguration

      public io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration getConnectionPoolConfiguration()
      Specified by:
      getConnectionPoolConfiguration in class io.micronaut.http.client.HttpClientConfiguration

    • getReadTimeout

      public Optional<Duration> getReadTimeout()
      Overrides:
      getReadTimeout in class io.micronaut.http.client.HttpClientConfiguration
      Returns:
      The read timeout, depending on the maxWaitDuration value.

    • getMaxWaitDuration

      @Nullable public @Nullable String getMaxWaitDuration()
      Returns:
      The max wait duration. Defaults to "10m".

    • setMaxWaitDuration

      public void setMaxWaitDuration(@Nullable @Nullable String maxWaitDuration)
      Specify the maximum duration for the blocking request. Default value ("10m").
      Parameters:
      maxWaitDuration - The wait timeout

    • getDelayDuration

      @NonNull public @NonNull Duration getDelayDuration()
      Returns:
      The delay duration. Defaults to 50L milliseconds.

    • setDelayDuration

      public void setDelayDuration(Duration delayDuration)
      Sets the delay before each call to avoid flooding. Default value (50L milliseconds).
      Parameters:
      delayDuration - The watch delay