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

java.lang.Object
io.helidon.webserver.websocket.WsConfig.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>, Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
WsConfig.Builder
Enclosing interface:
WsConfig

public abstract static class WsConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WsConfig> extends Object implements Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for WsConfig.
  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.
  • Method Details

    • from

      public BUILDER from(WsConfig 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(WsConfig.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 Prototype.ConfiguredBuilder<BUILDER extends WsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WsConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance
    • origins

      public BUILDER origins(Set<? extends String> origins)
      WebSocket origins.
      Parameters:
      origins - origins
      Returns:
      updated builder instance
      See Also:
    • addOrigins

      public BUILDER addOrigins(Set<? extends String> origins)
      WebSocket origins.
      Parameters:
      origins - origins
      Returns:
      updated builder instance
      See Also:
    • addOrigin

      public BUILDER addOrigin(String origin)
      WebSocket origins.
      Parameters:
      origin - origins
      Returns:
      updated builder instance
      See Also:
    • name

      public BUILDER name(String name)
      Name of this configuration.
      Parameters:
      name - configuration name
      Returns:
      updated builder instance
      See Also:
    • maxFrameLength

      public BUILDER maxFrameLength(int maxFrameLength)
      Max WebSocket frame size supported by the server on a read operation. Default is 1 MB.
      Parameters:
      maxFrameLength - max frame size to read
      Returns:
      updated builder instance
      See Also:
    • origins

      public Set<String> origins()
      WebSocket origins.
      Returns:
      the origins
    • name

      public String name()
      Name of this configuration.
      Returns:
      the name
    • maxFrameLength

      public int maxFrameLength()
      Max WebSocket frame size supported by the server on a read operation. Default is 1 MB.
      Returns:
      the max frame length
    • 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.