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

java.lang.Object
io.helidon.webserver.security.PathsConfig.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>
Direct Known Subclasses:
PathsConfig.Builder
Enclosing interface:
PathsConfig
public abstract static class PathsConfig.BuilderBase<BUILDER extends PathsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends PathsConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>
Fluent API builder base for PathsConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(PathsConfig 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(PathsConfig.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

      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 PathsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends PathsConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • clearMethods

      public BUILDER clearMethods()
      Clear all methods.
      Returns:
      updated builder instance
      See Also:

    • methods

      public 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. 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.
      Parameters:
      methods - list of methods to secure
      Returns:
      updated builder instance
      See Also:

    • addMethods

      public 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. 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.
      Parameters:
      methods - list of methods to secure
      Returns:
      updated builder instance
      See Also:

    • addMethod

      public 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. 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.
      Parameters:
      method - add single list of methods to secure
      Returns:
      updated builder instance
      See Also:

    • path

      public BUILDER path(String path)
      Path to secure. Uses the same rules as Helidon WebServer.
      Parameters:
      path - path to secure
      Returns:
      updated builder instance
      See Also:

    • clearSockets

      public BUILDER clearSockets()
      Clear all sockets.
      Returns:
      updated builder instance
      See Also:

    • sockets

      public BUILDER sockets(List<String> sockets)
      Named listeners that should be secured, defaults to the default listener.
      Parameters:
      sockets - sockets to secure
      Returns:
      updated builder instance
      See Also:

    • addSockets

      public BUILDER addSockets(List<String> sockets)
      Named listeners that should be secured, defaults to the default listener.
      Parameters:
      sockets - sockets to secure
      Returns:
      updated builder instance
      See Also:

    • handler

      public BUILDER handler(SecurityHandler handler)
      Security handler configuration for this protected path.
      Parameters:
      handler - security handler
      Returns:
      updated builder instance
      See Also:

    • handler

      public BUILDER handler(SecurityHandlerConfig handler)
      Security handler configuration for this protected path.
      Parameters:
      handler - prototype of security handler
      Returns:
      updated builder instance
      See Also:

    • handler

      public BUILDER handler(Consumer<SecurityHandlerConfig.Builder> consumer)
      Security handler configuration for this protected path.
      Parameters:
      consumer - consumer of builder of security handler
      Returns:
      updated builder instance
      See Also:

    • methods

      public 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

      public Optional<String> path()
      Path to secure. Uses the same rules as Helidon WebServer.
      Returns:
      path to secure

    • sockets

      public List<String> sockets()
      Named listeners that should be secured, defaults to the default listener.
      Returns:
      sockets to secure

    • handler

      public Optional<SecurityHandler> handler()
      Security handler configuration for this protected path.
      Returns:
      security handler

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.

    • config

      protected Optional<Config> config()
      Configuration used to configure this instance.
      Returns:
      config instance