Module io.helidon.webserver

Package io.helidon.webserver

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

java.lang.Object

io.helidon.webserver.ErrorHandling.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:

ErrorHandling.Builder

Enclosing interface:

ErrorHandling

public abstract static class ErrorHandling.BuilderBase<BUILDER extends ErrorHandling.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ErrorHandling>
extends Object
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for ErrorHandling.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ErrorHandling.BuilderBase.ErrorHandlingImpl	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
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(ErrorHandling prototype)	Update this builder from an existing prototype instance.
BUILDER	from(ErrorHandling.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
boolean	includeEntity()	Whether to include a response entity when mapping a RequestException using a DirectHandler.
BUILDER	includeEntity(boolean includeEntity)	Whether to include a response entity when mapping a RequestException using a DirectHandler.
boolean	logAllMessages()	Whether to log all messages in a RequestException or not.
BUILDER	logAllMessages(boolean logAllMessages)	Whether to log all messages in a RequestException or not.
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(ErrorHandling 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(ErrorHandling.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 ErrorHandling.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ErrorHandling>

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 ErrorHandling.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ErrorHandling>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

includeEntity

public BUILDER includeEntity(boolean includeEntity)

Whether to include a response entity when mapping a RequestException using a DirectHandler. Response entities may include data that is reflected back from the original request, albeit escaped to prevent potential attacks.

Parameters:

includeEntity - include entity flag

Returns:

updated builder instance

See Also:

• includeEntity()

logAllMessages

public BUILDER logAllMessages(boolean logAllMessages)

Whether to log all messages in a RequestException or not. If set to false, only those that return true for RequestException.safeMessage() are logged.

Parameters:

logAllMessages -

Returns:

updated builder instance

See Also:

• logAllMessages()

includeEntity

public boolean includeEntity()

Whether to include a response entity when mapping a RequestException using a DirectHandler. Response entities may include data that is reflected back from the original request, albeit escaped to prevent potential attacks.

Returns:

the include entity

logAllMessages

public boolean logAllMessages()

Whether to log all messages in a RequestException or not. If set to false, only those that return true for RequestException.safeMessage() are logged.

Returns:

the log all messages

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.