Class ConsulConfig.AgentConfig

  • Enclosing class:
    ConsulConfig

    public static class ConsulConfig.AgentConfig
    extends Object
    • Field Summary

      Fields 
      Modifier and Type Field Description
      Duration connectionTimeout
      The amount of time to wait when initially establishing a connection before giving up and timing out.
      (package private) InetSocketAddress hostPort
      Consul agent host
      Optional<String> keyPassword
      Password to recover key from KeyStore for SSL client authentication with Consul agent If no value is provided, the key-store-password will be used
      Optional<Path> keyStore
      KeyStore to be used containing the SSL certificate for authentication with Consul agent Can be either a classpath resource or a file system path
      Optional<String> keyStorePassword
      Password of KeyStore to be used containing the SSL certificate for authentication with Consul agent
      Duration readTimeout
      The amount of time to wait for a read on a socket before an exception is thrown.
      (package private) Optional<String> token
      Consul token to be provided when authentication is enabled
      (package private) boolean trustCerts
      When using HTTPS and no keyStore has been specified, whether or not to trust all certificates
      Optional<Path> trustStore
      TrustStore to be used containing the SSL certificate used by Consul agent Can be either a classpath resource or a file system path
      Optional<String> trustStorePassword
      Password of TrustStore to be used containing the SSL certificate used by Consul agent
      (package private) boolean useHttps
      Whether or not to use HTTPS when communicating with the agent
    • Constructor Summary

      Constructors 
      Constructor Description
      AgentConfig()  
    • Field Detail

      • hostPort

        @ConfigItem(defaultValue="localhost:8500")
        InetSocketAddress hostPort
        Consul agent host
      • useHttps

        @ConfigItem(defaultValue="false")
        boolean useHttps
        Whether or not to use HTTPS when communicating with the agent
      • token

        @ConfigItem
        Optional<String> token
        Consul token to be provided when authentication is enabled
      • trustStore

        @ConfigItem
        public Optional<Path> trustStore
        TrustStore to be used containing the SSL certificate used by Consul agent Can be either a classpath resource or a file system path
      • trustStorePassword

        @ConfigItem
        public Optional<String> trustStorePassword
        Password of TrustStore to be used containing the SSL certificate used by Consul agent
      • keyStore

        @ConfigItem
        public Optional<Path> keyStore
        KeyStore to be used containing the SSL certificate for authentication with Consul agent Can be either a classpath resource or a file system path
      • keyStorePassword

        @ConfigItem
        public Optional<String> keyStorePassword
        Password of KeyStore to be used containing the SSL certificate for authentication with Consul agent
      • keyPassword

        @ConfigItem
        public Optional<String> keyPassword
        Password to recover key from KeyStore for SSL client authentication with Consul agent If no value is provided, the key-store-password will be used
      • trustCerts

        @ConfigItem(defaultValue="false")
        boolean trustCerts
        When using HTTPS and no keyStore has been specified, whether or not to trust all certificates
      • connectionTimeout

        @ConfigItem(defaultValue="10S")
        public Duration connectionTimeout
        The amount of time to wait when initially establishing a connection before giving up and timing out.

        Specify `0` to wait indefinitely.

      • readTimeout

        @ConfigItem(defaultValue="60S")
        public Duration readTimeout
        The amount of time to wait for a read on a socket before an exception is thrown.

        Specify `0` to wait indefinitely.

    • Constructor Detail

      • AgentConfig

        public AgentConfig()