Interface PathsConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

PathsConfig.BuilderBase.PathsConfigImpl

public interface PathsConfig
extends Prototype.Api

Configuration of a single path security setup.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PathsConfig.Builder	Fluent API builder for PathsConfig.
static class	PathsConfig.BuilderBase<BUILDER extends PathsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends PathsConfig>	Fluent API builder base for PathsConfig.

Method Summary

Modifier and Type	Method	Description
static PathsConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static PathsConfig.Builder	builder(PathsConfig instance)	Create a new fluent API builder from an existing instance.
static PathsConfig	create(Config config)	Create a new instance from configuration.
SecurityHandler	handler()	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.
String	path()	Path to secure.
List<String>	sockets()	Named listeners that should be secured, defaults to the default listener.

Method Details

builder

static PathsConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static PathsConfig.Builder builder(PathsConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static PathsConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

methods

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. Configuration retains each exact method name and also matches its uppercase form when that form is a known HTTP method. For example, configured get matches both get and GET, but not Get. Custom methods such as Follow remain case-sensitive. Non-uppercase known methods produce a warning: automatic uppercasing will be removed in a future major version. Use uppercase names for known methods in configuration. Programmatically supplied methods are matched exactly.

Returns:

list of methods to secure

path

String path()

Path to secure. Uses the same rules as Helidon WebServer.

Returns:

path to secure

sockets

List<String> sockets()

Named listeners that should be secured, defaults to the default listener.

Returns:

sockets to secure

handler

SecurityHandler handler()

Security handler configuration for this protected path.

Returns:

security handler