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>

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 AllowList.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AllowListConfig.BuilderBase.AllowListConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	addAllowed(String allowed)	Exact strings to allow.
BUILDER	addAllowed(Predicate<String> allowed)	Allowed predicates.
BUILDER	addAllowed(List<String> allowed)	Exact strings to allow.
BUILDER	addAllowedPattern(Pattern allowedPattern)	Patterns specifying strings to allow.
BUILDER	addAllowedPatterns(List<? extends Pattern> allowedPatterns)	Patterns specifying strings to allow.
BUILDER	addAllowedPredicates(List<Predicate<String>> allowedPredicates)	Allowed predicates.
BUILDER	addAllowedPrefix(String allowedPrefix)	Prefixes specifying strings to allow.
BUILDER	addAllowedPrefixes(List<String> allowedPrefixes)	Prefixes specifying strings to allow.
BUILDER	addAllowedSuffix(String allowedSuffix)	Suffixes specifying strings to allow.
BUILDER	addAllowedSuffixes(List<String> allowedSuffixes)	Suffixes specifying strings to allow.
BUILDER	addDenied(String denied)	Exact strings to deny.
BUILDER	addDenied(Predicate<String> denied)	Deny predicates.
BUILDER	addDenied(List<String> denied)	Exact strings to deny.
BUILDER	addDeniedPattern(Pattern deniedPattern)	Patterns specifying strings to deny.
BUILDER	addDeniedPatterns(List<? extends Pattern> deniedPatterns)	Patterns specifying strings to deny.
BUILDER	addDeniedPredicates(List<Predicate<String>> deniedPredicates)	Deny predicates.
BUILDER	addDeniedPrefix(String deniedPrefix)	Prefixes specifying strings to deny.
BUILDER	addDeniedPrefixes(List<String> deniedPrefixes)	Prefixes specifying strings to deny.
BUILDER	addDeniedSuffix(String deniedSuffix)	Suffixes specifying strings to deny.
BUILDER	addDeniedSuffixes(List<String> deniedSuffixes)	Suffixes specifying strings to deny.
boolean	allowAll()	Allows all strings to match (subject to "deny" conditions).
BUILDER	allowAll(boolean allowAll)	Allows all strings to match (subject to "deny" conditions).
List<String>	allowed()	Exact strings to allow.
BUILDER	allowed(List<String> allowed)	Exact strings to allow.
List<Pattern>	allowedPatterns()	Patterns specifying strings to allow.
BUILDER	allowedPatterns(List<? extends Pattern> allowedPatterns)	Patterns specifying strings to allow.
List<Predicate<String>>	allowedPredicates()	Allowed predicates.
BUILDER	allowedPredicates(List<Predicate<String>> allowedPredicates)	Allowed predicates.
List<String>	allowedPrefixes()	Prefixes specifying strings to allow.
BUILDER	allowedPrefixes(List<String> allowedPrefixes)	Prefixes specifying strings to allow.
List<String>	allowedSuffixes()	Suffixes specifying strings to allow.
BUILDER	allowedSuffixes(List<String> allowedSuffixes)	Suffixes specifying strings to allow.
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Update builder from configuration (node of this type).
List<String>	denied()	Exact strings to deny.
BUILDER	denied(List<String> denied)	Exact strings to deny.
List<Pattern>	deniedPatterns()	Patterns specifying strings to deny.
BUILDER	deniedPatterns(List<? extends Pattern> deniedPatterns)	Patterns specifying strings to deny.
List<Predicate<String>>	deniedPredicates()	Deny predicates.
BUILDER	deniedPredicates(List<Predicate<String>> deniedPredicates)	Deny predicates.
List<String>	deniedPrefixes()	Prefixes specifying strings to deny.
BUILDER	deniedPrefixes(List<String> deniedPrefixes)	Prefixes specifying strings to deny.
List<String>	deniedSuffixes()	Suffixes specifying strings to deny.
BUILDER	deniedSuffixes(List<String> deniedSuffixes)	Suffixes specifying strings to deny.
BUILDER	from(AllowListConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(AllowListConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

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

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:

• allowAll()

allowed

public BUILDER allowed(List<String> allowed)

Exact strings to allow.

Parameters:

allowed - exact strings to allow

Returns:

updated builder instance

See Also:

• allowed()

addAllowed

public BUILDER addAllowed(List<String> allowed)

Exact strings to allow.

Parameters:

allowed - exact strings to allow

Returns:

updated builder instance

See Also:

• allowed()

addAllowed

public BUILDER addAllowed(String allowed)

Exact strings to allow.

Parameters:

allowed - exact strings to allow

Returns:

updated builder instance

See Also:

• allowed()

allowedPrefixes

public BUILDER allowedPrefixes(List<String> allowedPrefixes)

Prefixes specifying strings to allow.

Parameters:

allowedPrefixes - prefixes which allow matching

Returns:

updated builder instance

See Also:

• allowedPrefixes()

addAllowedPrefixes

public BUILDER addAllowedPrefixes(List<String> allowedPrefixes)

Prefixes specifying strings to allow.

Parameters:

allowedPrefixes - prefixes which allow matching

Returns:

updated builder instance

See Also:

• allowedPrefixes()

addAllowedPrefix

public BUILDER addAllowedPrefix(String allowedPrefix)

Prefixes specifying strings to allow.

Parameters:

allowedPrefix - prefixes which allow matching

Returns:

updated builder instance

See Also:

• allowedPrefixes()

allowedSuffixes

public BUILDER allowedSuffixes(List<String> allowedSuffixes)

Suffixes specifying strings to allow.

Parameters:

allowedSuffixes - suffixes which allow matching

Returns:

updated builder instance

See Also:

• allowedSuffixes()

addAllowedSuffixes

public BUILDER addAllowedSuffixes(List<String> allowedSuffixes)

Suffixes specifying strings to allow.

Parameters:

allowedSuffixes - suffixes which allow matching

Returns:

updated builder instance

See Also:

• allowedSuffixes()

addAllowedSuffix

public BUILDER addAllowedSuffix(String allowedSuffix)

Suffixes specifying strings to allow.

Parameters:

allowedSuffix - suffixes which allow matching

Returns:

updated builder instance

See Also:

• allowedSuffixes()

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:

• allowedPatterns()

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:

• allowedPatterns()

addAllowedPattern

public BUILDER addAllowedPattern(Pattern allowedPattern)

Patterns specifying strings to allow.

Parameters:

allowedPattern - patterns which allow matching

Returns:

updated builder instance

See Also:

• allowedPatterns()

denied

public BUILDER denied(List<String> denied)

Exact strings to deny.

Parameters:

denied - exact strings to deny

Returns:

updated builder instance

See Also:

• denied()

addDenied

public BUILDER addDenied(List<String> denied)

Exact strings to deny.

Parameters:

denied - exact strings to deny

Returns:

updated builder instance

See Also:

• denied()

addDenied

public BUILDER addDenied(String denied)

Exact strings to deny.

Parameters:

denied - exact strings to deny

Returns:

updated builder instance

See Also:

• denied()

deniedPrefixes

public BUILDER deniedPrefixes(List<String> deniedPrefixes)

Prefixes specifying strings to deny.

Parameters:

deniedPrefixes - prefixes which deny matching

Returns:

updated builder instance

See Also:

• deniedPrefixes()

addDeniedPrefixes

public BUILDER addDeniedPrefixes(List<String> deniedPrefixes)

Prefixes specifying strings to deny.

Parameters:

deniedPrefixes - prefixes which deny matching

Returns:

updated builder instance

See Also:

• deniedPrefixes()

addDeniedPrefix

public BUILDER addDeniedPrefix(String deniedPrefix)

Prefixes specifying strings to deny.

Parameters:

deniedPrefix - prefixes which deny matching

Returns:

updated builder instance

See Also:

• deniedPrefixes()

deniedSuffixes

public BUILDER deniedSuffixes(List<String> deniedSuffixes)

Suffixes specifying strings to deny.

Parameters:

deniedSuffixes - suffixes which deny matching

Returns:

updated builder instance

See Also:

• deniedSuffixes()

addDeniedSuffixes

public BUILDER addDeniedSuffixes(List<String> deniedSuffixes)

Suffixes specifying strings to deny.

Parameters:

deniedSuffixes - suffixes which deny matching

Returns:

updated builder instance

See Also:

• deniedSuffixes()

addDeniedSuffix

public BUILDER addDeniedSuffix(String deniedSuffix)

Suffixes specifying strings to deny.

Parameters:

deniedSuffix - suffixes which deny matching

Returns:

updated builder instance

See Also:

• deniedSuffixes()

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:

• deniedPatterns()

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:

• deniedPatterns()

addDeniedPattern

public BUILDER addDeniedPattern(Pattern deniedPattern)

Patterns specifying strings to deny.

Parameters:

deniedPattern - patterns which deny matching

Returns:

updated builder instance

See Also:

• deniedPatterns()

allowedPredicates

public BUILDER allowedPredicates(List<Predicate<String>> allowedPredicates)

Allowed predicates.

Parameters:

allowedPredicates - predicates to allow

Returns:

updated builder instance

See Also:

• allowedPredicates()

addAllowedPredicates

public BUILDER addAllowedPredicates(List<Predicate<String>> allowedPredicates)

Allowed predicates.

Parameters:

allowedPredicates - predicates to allow

Returns:

updated builder instance

See Also:

• allowedPredicates()

addAllowed

public BUILDER addAllowed(Predicate<String> allowed)

Allowed predicates.

Parameters:

allowed - predicates to allow

Returns:

updated builder instance

See Also:

• allowedPredicates()

deniedPredicates

public BUILDER deniedPredicates(List<Predicate<String>> deniedPredicates)

Deny predicates.

Parameters:

deniedPredicates - predicates to deny

Returns:

updated builder instance

See Also:

• deniedPredicates()

addDeniedPredicates

public BUILDER addDeniedPredicates(List<Predicate<String>> deniedPredicates)

Deny predicates.

Parameters:

deniedPredicates - predicates to deny

Returns:

updated builder instance

See Also:

• deniedPredicates()

addDenied

public BUILDER addDenied(Predicate<String> denied)

Deny predicates.

Parameters:

denied - predicates to deny

Returns:

updated builder instance

See Also:

• deniedPredicates()

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:

the allow all

allowed

public List<String> allowed()

Exact strings to allow.

Returns:

the allowed

allowedPrefixes

public List<String> allowedPrefixes()

Prefixes specifying strings to allow.

Returns:

the allowed prefixes

allowedSuffixes

public List<String> allowedSuffixes()

Suffixes specifying strings to allow.

Returns:

the allowed suffixes

allowedPatterns

public List<Pattern> allowedPatterns()

Patterns specifying strings to allow.

Returns:

the allowed patterns

denied

public List<String> denied()

Exact strings to deny.

Returns:

the denied

deniedPrefixes

public List<String> deniedPrefixes()

Prefixes specifying strings to deny.

Returns:

the denied prefixes

deniedSuffixes

public List<String> deniedSuffixes()

Suffixes specifying strings to deny.

Returns:

the denied suffixes

deniedPatterns

public List<Pattern> deniedPatterns()

Patterns specifying strings to deny.

Returns:

the denied patterns

allowedPredicates

public List<Predicate<String>> allowedPredicates()

Allowed predicates.

Returns:

the allowed predicates

deniedPredicates

public List<Predicate<String>> deniedPredicates()

Deny predicates.

Returns:

the denied predicates

config

public Optional<Config> config()

If this instance was configured, this would be the config instance used.

Returns:

config node used to configure this builder, or empty if not configured

toString

public String toString()

Overrides:

toString in class Object

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

validatePrototype

protected void validatePrototype()

Validates required properties.