Class ProxyProtocolConfig.BuilderBase<BUILDER extends ProxyProtocolConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends ProxyProtocolConfig>

java.lang.Object
io.helidon.webserver.ProxyProtocolConfig.BuilderBase<BUILDER, PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER, PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>
Direct Known Subclasses:
ProxyProtocolConfig.Builder
Enclosing interface:
ProxyProtocolConfig
public abstract static class ProxyProtocolConfig.BuilderBase<BUILDER extends ProxyProtocolConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends ProxyProtocolConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>
Fluent API builder base for ProxyProtocolConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(ProxyProtocolConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(ProxyProtocolConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends ProxyProtocolConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends ProxyProtocolConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • enabled

      public BUILDER enabled(boolean enabled)
      Whether PROXY protocol support is enabled.
      Parameters:
      enabled - whether PROXY protocol support is enabled, defaults to true
      Returns:
      updated builder instance
      See Also:

    • clearTrustedProxies

      public BUILDER clearTrustedProxies()
      Clear existing value of trustedProxies.
      Returns:
      updated builder instance
      See Also:

    • trustedProxies

      public BUILDER trustedProxies(AllowList trustedProxies)
      Trusted proxy allow list; required when PROXY protocol support is enabled.

      When PROXY protocol support is enabled, this list must be configured explicitly. Incoming PROXY protocol headers are accepted only from trusted peers.

      Parameters:
      trustedProxies - trusted proxy allow list
      Returns:
      updated builder instance
      See Also:

    • trustedProxies

      public BUILDER trustedProxies(AllowListConfig trustedProxies)
      Trusted proxy allow list; required when PROXY protocol support is enabled.

      When PROXY protocol support is enabled, this list must be configured explicitly. Incoming PROXY protocol headers are accepted only from trusted peers.

      Parameters:
      trustedProxies - prototype of trusted proxy allow list
      Returns:
      updated builder instance
      See Also:

    • trustedProxies

      public BUILDER trustedProxies(Consumer<AllowListConfig.Builder> consumer)
      Trusted proxy allow list; required when PROXY protocol support is enabled.

      When PROXY protocol support is enabled, this list must be configured explicitly. Incoming PROXY protocol headers are accepted only from trusted peers.

      Parameters:
      consumer - consumer of builder of trusted proxy allow list
      Returns:
      updated builder instance
      See Also:

    • trustedProxies

      public BUILDER trustedProxies(Supplier<? extends AllowList> supplier)
      Trusted proxy allow list; required when PROXY protocol support is enabled.

      When PROXY protocol support is enabled, this list must be configured explicitly. Incoming PROXY protocol headers are accepted only from trusted peers.

      Parameters:
      supplier - supplier of trusted proxy allow list
      Returns:
      updated builder instance
      See Also:

    • enabled

      public boolean enabled()
      Whether PROXY protocol support is enabled.
      Returns:
      whether PROXY protocol support is enabled, defaults to true

    • trustedProxies

      public Optional<AllowList> trustedProxies()
      Trusted proxy allow list; required when PROXY protocol support is enabled.

      When PROXY protocol support is enabled, this list must be configured explicitly. Incoming PROXY protocol headers are accepted only from trusted peers.

      Returns:
      trusted proxy allow list

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.

    • config

      protected Optional<Config> config()
      Configuration used to configure this instance.
      Returns:
      config instance