Module io.helidon.http

Package io.helidon.http

Class RequestedUriDiscoveryContext.Builder

java.lang.Object

io.helidon.http.RequestedUriDiscoveryContext.Builder

All Implemented Interfaces:

Builder<RequestedUriDiscoveryContext.Builder,RequestedUriDiscoveryContext>, Supplier<RequestedUriDiscoveryContext>

Enclosing interface:

RequestedUriDiscoveryContext

public static final class RequestedUriDiscoveryContext.Builder
extends Object
implements Builder<RequestedUriDiscoveryContext.Builder,RequestedUriDiscoveryContext>

Builder for RequestedUriDiscoveryContext.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REQUESTED_URI_DISCOVERY_CONFIG_KEY	Config key prefix for requested URI discovery settings.

Method Summary

Modifier and Type	Method	Description
RequestedUriDiscoveryContext.Builder	addDiscoveryType(RequestedUriDiscoveryContext.RequestedUriDiscoveryType discoveryType)	Adds a discovery type for requested URI discovery for requests arriving on the socket.
RequestedUriDiscoveryContext	build()	Build the instance from this builder.
RequestedUriDiscoveryContext.Builder	config(Config requestedUriDiscoveryConfig)	Update the settings from the "requested-uri-discovery" Config node within the socket configuration.
RequestedUriDiscoveryContext.Builder	discoveryTypes(List<RequestedUriDiscoveryContext.RequestedUriDiscoveryType> discoveryTypes)	Deprecated, for removal: This API element is subject to removal in a future version. Use types(java.util.List) instead
RequestedUriDiscoveryContext.Builder	enabled(boolean value)	Sets whether requested URI discovery is enabled for requestes arriving on the socket.
RequestedUriDiscoveryContext.Builder	socketId(String socketId)	Sets the socket identifier to which the discovery context applies.
RequestedUriDiscoveryContext.Builder	trustedProxies(AllowList trustedProxies)	Sets the trusted proxies for requested URI discovery for requests arriving on the socket.
RequestedUriDiscoveryContext.Builder	types(List<RequestedUriDiscoveryContext.RequestedUriDiscoveryType> discoveryTypes)	Sets the discovery types for requested URI discovery for requests arriving on the socket.

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, identity, update

Field Details

REQUESTED_URI_DISCOVERY_CONFIG_KEY

public static final String REQUESTED_URI_DISCOVERY_CONFIG_KEY

Config key prefix for requested URI discovery settings.

See Also:

• Constant Field Values

Method Details

build

public RequestedUriDiscoveryContext build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<RequestedUriDiscoveryContext.Builder,RequestedUriDiscoveryContext>

Returns:

instance of the built type

config

public RequestedUriDiscoveryContext.Builder config(Config requestedUriDiscoveryConfig)

Update the settings from the "requested-uri-discovery" Config node within the socket configuration.

Parameters:

requestedUriDiscoveryConfig - requested URI discovery configuration node

Returns:

updated builder instance

enabled

public RequestedUriDiscoveryContext.Builder enabled(boolean value)

Sets whether requested URI discovery is enabled for requestes arriving on the socket.

Parameters:

value - new enabled state

Returns:

updated builder

trustedProxies

public RequestedUriDiscoveryContext.Builder trustedProxies(AllowList trustedProxies)

Sets the trusted proxies for requested URI discovery for requests arriving on the socket.

Parameters:

trustedProxies - the AllowList represented trusted proxies

Returns:

updated builder

types

public RequestedUriDiscoveryContext.Builder types(List<RequestedUriDiscoveryContext.RequestedUriDiscoveryType> discoveryTypes)

Sets the discovery types for requested URI discovery for requests arriving on the socket.

Parameters:

discoveryTypes - discovery types to use

Returns:

updated builder

discoveryTypes

@Deprecated(since="4.0.6",
            forRemoval=true)
public RequestedUriDiscoveryContext.Builder discoveryTypes(List<RequestedUriDiscoveryContext.RequestedUriDiscoveryType> discoveryTypes)

Deprecated, for removal: This API element is subject to removal in a future version.

Use types(java.util.List) instead

Sets the discovery types for requested URI discovery for requests arriving on the socket.

Parameters:

discoveryTypes - discovery types to use

Returns:

updated builder

addDiscoveryType

public RequestedUriDiscoveryContext.Builder addDiscoveryType(RequestedUriDiscoveryContext.RequestedUriDiscoveryType discoveryType)

Adds a discovery type for requested URI discovery for requests arriving on the socket.

Parameters:

discoveryType - the RequestedUriDiscoveryContext.RequestedUriDiscoveryType to add

Returns:

updated builder

socketId

public RequestedUriDiscoveryContext.Builder socketId(String socketId)

Sets the socket identifier to which the discovery context applies.

Parameters:

socketId - socket identifier (used in logging)

Returns:

updated builder