Class PathsConfig.Builder

java.lang.Object

io.helidon.webserver.security.PathsConfig.BuilderBase<PathsConfig.Builder, PathsConfig>

io.helidon.webserver.security.PathsConfig.Builder

All Implemented Interfaces:

Prototype.Builder<PathsConfig.Builder, PathsConfig>, Builder<PathsConfig.Builder, PathsConfig>, ConfigBuilderSupport.ConfiguredBuilder<PathsConfig.Builder, PathsConfig>, Supplier<PathsConfig>

Enclosing interface:

PathsConfig

public static class PathsConfig.Builder
extends PathsConfig.BuilderBase<PathsConfig.Builder, PathsConfig>
implements Builder<PathsConfig.Builder, PathsConfig>

Fluent API builder for PathsConfig.

Nested Class Summary

Nested classes/interfaces inherited from class PathsConfig.BuilderBase

PathsConfig.BuilderBase.PathsConfigImpl

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

Method Summary

Modifier and Type	Method	Description
PathsConfig	build()	Create an instance from this builder.
PathsConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class PathsConfig.BuilderBase

addMethod, addMethods, addSockets, clearMethods, clearSockets, config, config, from, from, handler, handler, handler, handler, methods, methods, path, path, preBuildPrototype, sockets, sockets, toString, validatePrototype

Modifier and Type	Method	Description
PathsConfig.Builder	addMethod(Method method)	HTTP methods to match exactly when applying this configured path; non-uppercase known methods also match their uppercase names and log a warning that this compatibility will be removed in a future major version.
PathsConfig.Builder	addMethods(List<? extends Method> methods)	HTTP methods to match exactly when applying this configured path; non-uppercase known methods also match their uppercase names and log a warning that this compatibility will be removed in a future major version.
PathsConfig.Builder	addSockets(List<String> sockets)	Named listeners that should be secured, defaults to the default listener.
PathsConfig.Builder	clearMethods()	Clear all methods.
PathsConfig.Builder	clearSockets()	Clear all sockets.
protected Optional<Config>	config()	Configuration used to configure this instance.
PathsConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
PathsConfig.Builder	from(PathsConfig prototype)	Update this builder from an existing prototype instance.
PathsConfig.Builder	from(PathsConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<SecurityHandler>	handler()	Security handler configuration for this protected path.
PathsConfig.Builder	handler(SecurityHandler handler)	Security handler configuration for this protected path.
PathsConfig.Builder	handler(SecurityHandlerConfig handler)	Security handler configuration for this protected path.
PathsConfig.Builder	handler(Consumer<SecurityHandlerConfig.Builder> consumer)	Security handler configuration for this protected path.
List<Method>	methods()	HTTP methods to match exactly when applying this configured path; non-uppercase known methods also match their uppercase names and log a warning that this compatibility will be removed in a future major version.
PathsConfig.Builder	methods(List<? extends Method> methods)	HTTP methods to match exactly when applying this configured path; non-uppercase known methods also match their uppercase names and log a warning that this compatibility will be removed in a future major version.
Optional<String>	path()	Path to secure.
PathsConfig.Builder	path(String path)	Path to secure.
protected void	preBuildPrototype()	Handles providers and decorators.
List<String>	sockets()	Named listeners that should be secured, defaults to the default listener.
PathsConfig.Builder	sockets(List<String> sockets)	Named listeners that should be secured, defaults to the default listener.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default PathsConfig	get()
default PathsConfig.Builder	identity()	Instance of this builder as the correct type.
default PathsConfig.Builder	update(Consumer<PathsConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default PathsConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public PathsConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<PathsConfig.Builder, PathsConfig>

Returns:

an instance of the setup object created from this builder

build

public PathsConfig build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<PathsConfig.Builder, PathsConfig>

Returns:

instance of the built type