Module io.helidon.webserver.staticcontent
Package io.helidon.webserver.staticcontent

Class StaticContentFeature

java.lang.Object
io.helidon.webserver.staticcontent.StaticContentFeature
All Implemented Interfaces:
RuntimeType.Api<StaticContentConfig>, NamedService, Weighted, ServerFeature, Comparable<Weighted>
public class StaticContentFeature extends Object implements Weighted, ServerFeature, RuntimeType.Api<StaticContentConfig>
WebServer feature to register static content.

  • Method Details

    • create

      public static StaticContentFeature create(Config config)
      Create Access log support configured from Config.
      Parameters:
      config - to configure a new access log support instance
      Returns:
      a new access log support to be registered with WebServer routing

    • builder

      public static StaticContentConfig.Builder builder()
      A new fluent API builder to create Access log support instance.
      Returns:
      a new builder

    • create

      public static StaticContentFeature create(StaticContentConfig config)
      Create a new instance from its configuration.
      Parameters:
      config - configuration
      Returns:
      a new feature

    • create

      public static StaticContentFeature create(Consumer<StaticContentConfig.Builder> builderConsumer)
      Create a new instance customizing its configuration.
      Parameters:
      builderConsumer - consumer of configuration
      Returns:
      a new feature

    • createService

      public static HttpService createService(FileSystemHandlerConfig config)
      Create an Http service for file system based content handler.
      Parameters:
      config - configuration of the content handler
      Returns:
      a new HTTP service ready to be registered

    • createService

      public static HttpService createService(ClasspathHandlerConfig config)
      Create an Http service for classpath based content handler.
      Parameters:
      config - configuration of the content handler
      Returns:
      a new HTTP service ready to be registered

    • prototype

      public StaticContentConfig prototype()
      Description copied from interface: RuntimeType.Api
      The prototype as it was received when creating this runtime object instance.
      Specified by:
      prototype in interface RuntimeType.Api<StaticContentConfig>
      Returns:
      prototype object used to create this instance

    • name

      public String name()
      Description copied from interface: NamedService
      Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
      Specified by:
      name in interface NamedService
      Returns:
      name of this service

    • type

      public String type()
      Description copied from interface: NamedService
      Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.
      Specified by:
      type in interface NamedService
      Returns:
      type of this service

    • weight

      public double weight()
      Description copied from interface: Weighted
      Weight of this class (maybe because it is defined dynamically, so it cannot be defined by an annotation). If not dynamic, you can use the Weight annotation rather than implementing this interface as long as it is supported by the library using this Weighted.
      Specified by:
      weight in interface Weighted
      Returns:
      the weight of this service, must be a non-negative number

    • setup

      public void setup(ServerFeature.ServerFeatureContext featureContext)
      Description copied from interface: ServerFeature
      Set up a server feature. Server features can modify server configuration, right before the server is created. To access listener configuration, or routing, a list of all listeners is provided.
      Specified by:
      setup in interface ServerFeature
      Parameters:
      featureContext - to access builders of webserver, listeners, and routing