Module io.helidon.common.configurable
Package io.helidon.common.configurable

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

java.lang.Object
io.helidon.common.configurable.AllowListConfig.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>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
AllowListConfig.Builder
Enclosing interface:
AllowListConfig
public abstract static class AllowListConfig.BuilderBase<BUILDER extends AllowListConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends AllowListConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for AllowListConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(AllowListConfig 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(AllowListConfig.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

      @Deprecated public BUILDER config(Config config)
      Deprecated.
      use config(io.helidon.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 AllowListConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends AllowListConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      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 AllowListConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends AllowListConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • allowAll

      public BUILDER allowAll(boolean allowAll)
      Allows all strings to match (subject to "deny" conditions). An allow.all setting of false does not deny all strings but rather represents the absence of a universal match, meaning that other allow and deny settings determine the matching outcomes.
      Parameters:
      allowAll - whether to allow all strings to match (subject to "deny" conditions)
      Returns:
      updated builder instance
      See Also:

    • clearAllowed

      public BUILDER clearAllowed()
      Clear all allowed.
      Returns:
      updated builder instance
      See Also:

    • allowed

      public BUILDER allowed(List<String> allowed)
      Exact strings to allow.
      Parameters:
      allowed - exact strings to allow
      Returns:
      updated builder instance
      See Also:

    • addAllowed

      public BUILDER addAllowed(List<String> allowed)
      Exact strings to allow.
      Parameters:
      allowed - exact strings to allow
      Returns:
      updated builder instance
      See Also:

    • addAllowed

      public BUILDER addAllowed(String allowed)
      Exact strings to allow.
      Parameters:
      allowed - add single exact strings to allow
      Returns:
      updated builder instance
      See Also:

    • clearAllowedPrefixes

      public BUILDER clearAllowedPrefixes()
      Clear all allowedPrefixes.
      Returns:
      updated builder instance
      See Also:

    • allowedPrefixes

      public BUILDER allowedPrefixes(List<String> allowedPrefixes)
      Prefixes specifying strings to allow.
      Parameters:
      allowedPrefixes - prefixes which allow matching
      Returns:
      updated builder instance
      See Also:

    • addAllowedPrefixes

      public BUILDER addAllowedPrefixes(List<String> allowedPrefixes)
      Prefixes specifying strings to allow.
      Parameters:
      allowedPrefixes - prefixes which allow matching
      Returns:
      updated builder instance
      See Also:

    • addAllowedPrefix

      public BUILDER addAllowedPrefix(String allowedPrefix)
      Prefixes specifying strings to allow.
      Parameters:
      allowedPrefix - add single prefixes which allow matching
      Returns:
      updated builder instance
      See Also:

    • clearAllowedSuffixes

      public BUILDER clearAllowedSuffixes()
      Clear all allowedSuffixes.
      Returns:
      updated builder instance
      See Also:

    • allowedSuffixes

      public BUILDER allowedSuffixes(List<String> allowedSuffixes)
      Suffixes specifying strings to allow.
      Parameters:
      allowedSuffixes - suffixes which allow matching
      Returns:
      updated builder instance
      See Also:

    • addAllowedSuffixes

      public BUILDER addAllowedSuffixes(List<String> allowedSuffixes)
      Suffixes specifying strings to allow.
      Parameters:
      allowedSuffixes - suffixes which allow matching
      Returns:
      updated builder instance
      See Also:

    • addAllowedSuffix

      public BUILDER addAllowedSuffix(String allowedSuffix)
      Suffixes specifying strings to allow.
      Parameters:
      allowedSuffix - add single suffixes which allow matching
      Returns:
      updated builder instance
      See Also:

    • clearAllowedPatterns

      public BUILDER clearAllowedPatterns()
      Clear all allowedPatterns.
      Returns:
      updated builder instance
      See Also:

    • allowedPatterns

      public BUILDER allowedPatterns(List<? extends Pattern> allowedPatterns)
      Patterns specifying strings to allow.
      Parameters:
      allowedPatterns - patterns which allow matching
      Returns:
      updated builder instance
      See Also:

    • addAllowedPatterns

      public BUILDER addAllowedPatterns(List<? extends Pattern> allowedPatterns)
      Patterns specifying strings to allow.
      Parameters:
      allowedPatterns - patterns which allow matching
      Returns:
      updated builder instance
      See Also:

    • addAllowedPattern

      public BUILDER addAllowedPattern(Pattern allowedPattern)
      Patterns specifying strings to allow.
      Parameters:
      allowedPattern - add single patterns which allow matching
      Returns:
      updated builder instance
      See Also:

    • clearDenied

      public BUILDER clearDenied()
      Clear all denied.
      Returns:
      updated builder instance
      See Also:

    • denied

      public BUILDER denied(List<String> denied)
      Exact strings to deny.
      Parameters:
      denied - exact strings to deny
      Returns:
      updated builder instance
      See Also:

    • addDenied

      public BUILDER addDenied(List<String> denied)
      Exact strings to deny.
      Parameters:
      denied - exact strings to deny
      Returns:
      updated builder instance
      See Also:

    • addDenied

      public BUILDER addDenied(String denied)
      Exact strings to deny.
      Parameters:
      denied - add single exact strings to deny
      Returns:
      updated builder instance
      See Also:

    • clearDeniedPrefixes

      public BUILDER clearDeniedPrefixes()
      Clear all deniedPrefixes.
      Returns:
      updated builder instance
      See Also:

    • deniedPrefixes

      public BUILDER deniedPrefixes(List<String> deniedPrefixes)
      Prefixes specifying strings to deny.
      Parameters:
      deniedPrefixes - prefixes which deny matching
      Returns:
      updated builder instance
      See Also:

    • addDeniedPrefixes

      public BUILDER addDeniedPrefixes(List<String> deniedPrefixes)
      Prefixes specifying strings to deny.
      Parameters:
      deniedPrefixes - prefixes which deny matching
      Returns:
      updated builder instance
      See Also:

    • addDeniedPrefix

      public BUILDER addDeniedPrefix(String deniedPrefix)
      Prefixes specifying strings to deny.
      Parameters:
      deniedPrefix - add single prefixes which deny matching
      Returns:
      updated builder instance
      See Also:

    • clearDeniedSuffixes

      public BUILDER clearDeniedSuffixes()
      Clear all deniedSuffixes.
      Returns:
      updated builder instance
      See Also:

    • deniedSuffixes

      public BUILDER deniedSuffixes(List<String> deniedSuffixes)
      Suffixes specifying strings to deny.
      Parameters:
      deniedSuffixes - suffixes which deny matching
      Returns:
      updated builder instance
      See Also:

    • addDeniedSuffixes

      public BUILDER addDeniedSuffixes(List<String> deniedSuffixes)
      Suffixes specifying strings to deny.
      Parameters:
      deniedSuffixes - suffixes which deny matching
      Returns:
      updated builder instance
      See Also:

    • addDeniedSuffix

      public BUILDER addDeniedSuffix(String deniedSuffix)
      Suffixes specifying strings to deny.
      Parameters:
      deniedSuffix - add single suffixes which deny matching
      Returns:
      updated builder instance
      See Also:

    • clearDeniedPatterns

      public BUILDER clearDeniedPatterns()
      Clear all deniedPatterns.
      Returns:
      updated builder instance
      See Also:

    • deniedPatterns

      public BUILDER deniedPatterns(List<? extends Pattern> deniedPatterns)
      Patterns specifying strings to deny.
      Parameters:
      deniedPatterns - patterns which deny matching
      Returns:
      updated builder instance
      See Also:

    • addDeniedPatterns

      public BUILDER addDeniedPatterns(List<? extends Pattern> deniedPatterns)
      Patterns specifying strings to deny.
      Parameters:
      deniedPatterns - patterns which deny matching
      Returns:
      updated builder instance
      See Also:

    • addDeniedPattern

      public BUILDER addDeniedPattern(Pattern deniedPattern)
      Patterns specifying strings to deny.
      Parameters:
      deniedPattern - add single patterns which deny matching
      Returns:
      updated builder instance
      See Also:

    • clearAllowedPredicates

      public BUILDER clearAllowedPredicates()
      Clear all allowedPredicates.
      Returns:
      updated builder instance
      See Also:

    • allowedPredicates

      public BUILDER allowedPredicates(List<Predicate<String>> allowedPredicates)
      Allowed predicates.
      Parameters:
      allowedPredicates - predicates to allow
      Returns:
      updated builder instance
      See Also:

    • addAllowedPredicates

      public BUILDER addAllowedPredicates(List<Predicate<String>> allowedPredicates)
      Allowed predicates.
      Parameters:
      allowedPredicates - predicates to allow
      Returns:
      updated builder instance
      See Also:

    • addAllowed

      public BUILDER addAllowed(Predicate<String> allowed)
      Allowed predicates.
      Parameters:
      allowed - add single predicates to allow
      Returns:
      updated builder instance
      See Also:

    • clearDeniedPredicates

      public BUILDER clearDeniedPredicates()
      Clear all deniedPredicates.
      Returns:
      updated builder instance
      See Also:

    • deniedPredicates

      public BUILDER deniedPredicates(List<Predicate<String>> deniedPredicates)
      Deny predicates.
      Parameters:
      deniedPredicates - predicates to deny
      Returns:
      updated builder instance
      See Also:

    • addDeniedPredicates

      public BUILDER addDeniedPredicates(List<Predicate<String>> deniedPredicates)
      Deny predicates.
      Parameters:
      deniedPredicates - predicates to deny
      Returns:
      updated builder instance
      See Also:

    • addDenied

      public BUILDER addDenied(Predicate<String> denied)
      Deny predicates.
      Parameters:
      denied - add single predicates to deny
      Returns:
      updated builder instance
      See Also:

    • allowAll

      public boolean allowAll()
      Allows all strings to match (subject to "deny" conditions). An allow.all setting of false does not deny all strings but rather represents the absence of a universal match, meaning that other allow and deny settings determine the matching outcomes.
      Returns:
      whether to allow all strings to match (subject to "deny" conditions)

    • allowed

      public List<String> allowed()
      Exact strings to allow.
      Returns:
      exact strings to allow

    • allowedPrefixes

      public List<String> allowedPrefixes()
      Prefixes specifying strings to allow.
      Returns:
      prefixes which allow matching

    • allowedSuffixes

      public List<String> allowedSuffixes()
      Suffixes specifying strings to allow.
      Returns:
      suffixes which allow matching

    • allowedPatterns

      public List<Pattern> allowedPatterns()
      Patterns specifying strings to allow.
      Returns:
      patterns which allow matching

    • denied

      public List<String> denied()
      Exact strings to deny.
      Returns:
      exact strings to deny

    • deniedPrefixes

      public List<String> deniedPrefixes()
      Prefixes specifying strings to deny.
      Returns:
      prefixes which deny matching

    • deniedSuffixes

      public List<String> deniedSuffixes()
      Suffixes specifying strings to deny.
      Returns:
      suffixes which deny matching

    • deniedPatterns

      public List<Pattern> deniedPatterns()
      Patterns specifying strings to deny.
      Returns:
      patterns which deny matching

    • allowedPredicates

      public List<Predicate<String>> allowedPredicates()
      Allowed predicates.
      Returns:
      predicates to allow

    • deniedPredicates

      public List<Predicate<String>> deniedPredicates()
      Deny predicates.
      Returns:
      predicates to deny

    • 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