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

Interface Router

public interface Router
Router for server. Router contains routings of various types, so the server can handle each protocol as fast as possible.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Router.Builder
    Builder for a standalone router.
    static interface 
    Router.RouterBuilder<B extends Router.RouterBuilder<B>>
    Generic builder interface used by both Router.Builder and io.helidon.webserver.WebServer.Builder.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    afterStart(WebServer webServer)
    This is called after the server's listeners have successfully started.
    void
    afterStop()
    This is called after server closes ports.
    void
    beforeStart()
    This is called before server opens ports.
    static Router.Builder
    builder()
    Builder for router.
    static Router
    empty()
    Empty router.
    <T extends Routing>
    T
    routing(Class<T> routingType, T defaultValue)
    Get routing of a specific type.
    List<? extends Routing>
    routings()
    List of all conifgured routings.

  • Method Details

    • builder

      static Router.Builder builder()
      Builder for router.
      Returns:
      a new builder

    • empty

      static Router empty()
      Empty router.
      Returns:
      new empty router

    • routing

      <T extends Routing> T routing(Class<T> routingType, T defaultValue)
      Get routing of a specific type.
      Type Parameters:
      T - type of routing
      Parameters:
      routingType - type of the routing
      defaultValue - default value to use if the routing is not defined in this router
      Returns:
      routing defined or default value if not found

    • afterStop

      void afterStop()
      This is called after server closes ports.

    • beforeStart

      void beforeStart()
      This is called before server opens ports.

    • afterStart

      default void afterStart(WebServer webServer)
      This is called after the server's listeners have successfully started.
      Parameters:
      webServer - the WebServer that has successfully started

    • routings

      List<? extends Routing> routings()
      List of all conifgured routings.
      Returns:
      all routings