Module io.helidon.webserver.context.propagation

Package io.helidon.webserver.context.propagation

Class PropagationRecord.Builder

java.lang.Object

io.helidon.webserver.context.propagation.PropagationRecord.Builder

All Implemented Interfaces:

Builder<PropagationRecord>, Supplier<PropagationRecord>

Enclosing interface:

PropagationRecord

public static class PropagationRecord.Builder
extends Object
implements Builder<PropagationRecord>

Fluent API builder for PropagationRecord.

Method Summary

Modifier and Type	Method	Description
PropagationRecord.Builder	array(boolean isArray)	Whether this value is a String (false), or an array of Strings (true).
PropagationRecord	build()	Build the instance from this builder.
PropagationRecord.Builder	classifier(String classifier)	Classifier of the value to be used with Context.register(Object, Object).
PropagationRecord.Builder	config(Config config)	Update from configuration.
PropagationRecord.Builder	defaultValue(String... defaultValue)	Default value to use, either a single string (any type), or an array of strings (only usable if this is an array).
PropagationRecord.Builder	header(String headerName)	Name of the header expected to contain value to be registered in context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

build

public PropagationRecord build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<PropagationRecord>

Returns:

instance of the built type

config

public PropagationRecord.Builder config(Config config)

Update from configuration.

Parameters:

config - configuration to use

Returns:

updated builder

classifier

public PropagationRecord.Builder classifier(String classifier)

Classifier of the value to be used with Context.register(Object, Object). Uses classifier configuration key, and if not present, uses the header name.

Parameters:

classifier - classifier to use

Returns:

updated builder

header

public PropagationRecord.Builder header(String headerName)

Name of the header expected to contain value to be registered in context. Uses header configuration key, and if not present, uses the classifier.

Parameters:

headerName - name of the header

Returns:

updated builder

defaultValue

public PropagationRecord.Builder defaultValue(String... defaultValue)

Default value to use, either a single string (any type), or an array of strings (only usable if this is an array).

Parameters:

defaultValue - default value to register in case the header is not present in the request

Returns:

updated builder

array

public PropagationRecord.Builder array(boolean isArray)

Whether this value is a String (false), or an array of Strings (true). To read the value from context, you need to use the correct type (e.g. an array cannot be read as a String).

Parameters:

isArray - true to configure this as an array type, reading all values from the header

Returns:

updated builder