router: move more options to corresponding class

Author: jknack

jooby/src/main/java/io/jooby/DefaultContext.java

@@ -361,7 +361,9 @@ default long getRequestLength() {
   @Override
   default String getHostAndPort() {
     Optional<String> header =
-        getRouter().isTrustProxy() ? header("X-Forwarded-Host").toOptional() : Optional.empty();
+        getRouter().getRouterOptions().isTrustProxy()
+            ? header("X-Forwarded-Host").toOptional()
+            : Optional.empty();
     var value =
         header.orElseGet(
             () ->

jooby/src/main/java/io/jooby/Jooby.java

@@ -450,11 +450,6 @@ public ServerOptions getServerOptions() {
     return router.getServerOptions();
   }
 
-  @Override
-  public boolean isTrustProxy() {
-    return router.isTrustProxy();
-  }
-
   @Override
   public boolean isStarted() {
     return started.get();
@@ -465,12 +460,6 @@ public boolean isStopped() {
     return stopped.get();
   }
 
-  @NonNull @Override
-  public Jooby setTrustProxy(boolean trustProxy) {
-    this.router.setTrustProxy(trustProxy);
-    return this;
-  }
-
   @NonNull @Override
   public Route.Set domain(@NonNull String domain, @NonNull Router subrouter) {
     return this.router.domain(domain, subrouter);
@@ -863,12 +852,6 @@ public Jooby setCurrentUser(@NonNull Function<Context, Object> provider) {
     return this;
   }
 
-  @NonNull @Override
-  public Jooby setContextAsService(boolean contextAsService) {
-    router.setContextAsService(contextAsService);
-    return this;
-  }
-
   @NonNull @Override
   public Jooby setHiddenMethod(@NonNull String parameterName) {
     router.setHiddenMethod(parameterName);

jooby/src/main/java/io/jooby/Router.java

@@ -204,53 +204,10 @@ default Object execute(@NonNull Context context) {
    */
   @NonNull String getContextPath();
 
-  /**
-   * When true handles X-Forwarded-* headers by updating the values on the current context to match
-   * what was sent in the header(s).
-   *
-   * <p>This should only be installed behind a reverse proxy that has been configured to send the
-   * <code>X-Forwarded-*</code> header, otherwise a remote user can spoof their address by sending a
-   * header with bogus values.
-   *
-   * <p>The headers that are read/set are:
-   *
-   * <ul>
-   *   <li>X-Forwarded-For: Set/update the remote address {@link Context#setRemoteAddress(String)}.
-   *   <li>X-Forwarded-Proto: Set/update request scheme {@link Context#setScheme(String)}.
-   *   <li>X-Forwarded-Host: Set/update the request host {@link Context#setHost(String)}.
-   *   <li>X-Forwarded-Port: Set/update the request port {@link Context#setPort(int)}.
-   * </ul>
-   *
-   * @return True when enabled. Default is false.
-   */
-  boolean isTrustProxy();
-
   boolean isStarted();
 
   boolean isStopped();
 
-  /**
-   * When true handles X-Forwarded-* headers by updating the values on the current context to match
-   * what was sent in the header(s).
-   *
-   * <p>This should only be installed behind a reverse proxy that has been configured to send the
-   * <code>X-Forwarded-*</code> header, otherwise a remote user can spoof their address by sending a
-   * header with bogus values.
-   *
-   * <p>The headers that are read/set are:
-   *
-   * <ul>
-   *   <li>X-Forwarded-For: Set/update the remote address {@link Context#setRemoteAddress(String)}.
-   *   <li>X-Forwarded-Proto: Set/update request scheme {@link Context#setScheme(String)}.
-   *   <li>X-Forwarded-Host: Set/update the request host {@link Context#setHost(String)}.
-   *   <li>X-Forwarded-Port: Set/update the request port {@link Context#setPort(int)}.
-   * </ul>
-   *
-   * @param trustProxy True to enable.
-   * @return This router.
-   */
-  @NonNull Router setTrustProxy(boolean trustProxy);
-
   /**
    * Provides a way to override the current HTTP method. Request must be:
    *
@@ -280,15 +237,6 @@ default Object execute(@NonNull Context context) {
    */
   @NonNull Router setCurrentUser(@NonNull Function<Context, Object> provider);
 
-  /**
-   * If enabled, allows to retrieve the {@link Context} object associated with the current request
-   * via the service registry while the request is being processed.
-   *
-   * @param contextAsService whether to enable or disable this feature
-   * @return This router.
-   */
-  @NonNull Router setContextAsService(boolean contextAsService);
-
   /* ***********************************************************************************************
    * use(Router)
    * ***********************************************************************************************
@@ -304,7 +252,8 @@ default Object execute(@NonNull Context context) {
    * }
    * }</pre>
    *
-   * NOTE: if you run behind a reverse proxy you might to enabled {@link #setTrustProxy(boolean)}.
+   * NOTE: if you run behind a reverse proxy you might to enabled {@link
+   * RouterOptions#setTrustProxy(boolean)}.
    *
    * <p>NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
    *
@@ -328,7 +277,8 @@ default Object execute(@NonNull Context context) {
    * }
    * }</pre>
    *
-   * NOTE: if you run behind a reverse proxy you might to enabled {@link #setTrustProxy(boolean)}.
+   * NOTE: if you run behind a reverse proxy you might to enabled {@link
+   * RouterOptions#setTrustProxy(boolean)}.
    *
    * @param domain Predicate
    * @param body Route action.
@@ -352,7 +302,7 @@ default Object execute(@NonNull Context context) {
    * Imported routes are matched only when predicate pass.
    *
    * <p>NOTE: if you run behind a reverse proxy you might to enabled {@link
-   * #setTrustProxy(boolean)}.
+   * RouterOptions#setTrustProxy(boolean)}.
    *
    * <p>NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
    *
@@ -379,7 +329,8 @@ default Object execute(@NonNull Context context) {
    * }
    * }</pre>
    *
-   * NOTE: if you run behind a reverse proxy you might to enabled {@link #setTrustProxy(boolean)}.
+   * NOTE: if you run behind a reverse proxy you might to enabled {@link
+   * RouterOptions#setTrustProxy(boolean)}.
    *
    * <p>NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
    *
@@ -852,9 +803,7 @@ default Object execute(@NonNull Context context) {
   @NonNull Router setRouterOptions(@NonNull RouterOptions options);
 
   /**
-   * Session store. Default use a cookie ID with a memory storage.
-   *
-   * <p>See {@link SessionStore#memory()}.
+   * Session store. Default is {@link SessionStore#UNSUPPORTED}.
    *
    * @return Session store.
    */

jooby/src/main/java/io/jooby/RouterOptions.java

@@ -5,6 +5,8 @@
  */
 package io.jooby;
 
+import edu.umd.cs.findbugs.annotations.NonNull;
+
 /**
  * Router options:
  *
@@ -38,6 +40,25 @@ public class RouterOptions {
   /** Indicates whenever response headers are clear/reset in case of exception. */
   private boolean resetHeadersOnError;
 
+  /**
+   * When true handles X-Forwarded-* headers by updating the values on the current context to match
+   * what was sent in the header(s).
+   *
+   * <p>This should only be installed behind a reverse proxy that has been configured to send the
+   * <code>X-Forwarded-*</code> header, otherwise a remote user can spoof their address by sending a
+   * header with bogus values.
+   *
+   * <p>The headers that are read/set are:
+   *
+   * <ul>
+   *   <li>X-Forwarded-For: Set/update the remote address {@link Context#setRemoteAddress(String)}.
+   *   <li>X-Forwarded-Proto: Set/update request scheme {@link Context#setScheme(String)}.
+   *   <li>X-Forwarded-Host: Set/update the request host {@link Context#setHost(String)}.
+   *   <li>X-Forwarded-Port: Set/update the request port {@link Context#setPort(int)}.
+   * </ul>
+   */
+  private boolean trustProxy;
+
   /**
    * Indicates whenever routing algorithm does case-sensitive matching on an incoming request path.
    * Default is <code>false (case sensitive)</code>.
@@ -178,4 +199,52 @@ public static RouterOptions defaults() {
   public static RouterOptions caseInsensitive() {
     return new RouterOptions().ignoreCase(true).resetHeaderOnError(true);
   }
+
+  /**
+   * When true handles X-Forwarded-* headers by updating the values on the current context to match
+   * what was sent in the header(s).
+   *
+   * <p>This should only be installed behind a reverse proxy that has been configured to send the
+   * <code>X-Forwarded-*</code> header, otherwise a remote user can spoof their address by sending a
+   * header with bogus values.
+   *
+   * <p>The headers that are read/set are:
+   *
+   * <ul>
+   *   <li>X-Forwarded-For: Set/update the remote address {@link Context#setRemoteAddress(String)}.
+   *   <li>X-Forwarded-Proto: Set/update request scheme {@link Context#setScheme(String)}.
+   *   <li>X-Forwarded-Host: Set/update the request host {@link Context#setHost(String)}.
+   *   <li>X-Forwarded-Port: Set/update the request port {@link Context#setPort(int)}.
+   * </ul>
+   *
+   * @return True when enabled. Default is false.
+   */
+  public boolean isTrustProxy() {
+    return trustProxy;
+  }
+
+  /**
+   * When true handles X-Forwarded-* headers by updating the values on the current context to match
+   * what was sent in the header(s).
+   *
+   * <p>This should only be installed behind a reverse proxy that has been configured to send the
+   * <code>X-Forwarded-*</code> header, otherwise a remote user can spoof their address by sending a
+   * header with bogus values.
+   *
+   * <p>The headers that are read/set are:
+   *
+   * <ul>
+   *   <li>X-Forwarded-For: Set/update the remote address {@link Context#setRemoteAddress(String)}.
+   *   <li>X-Forwarded-Proto: Set/update request scheme {@link Context#setScheme(String)}.
+   *   <li>X-Forwarded-Host: Set/update the request host {@link Context#setHost(String)}.
+   *   <li>X-Forwarded-Port: Set/update the request port {@link Context#setPort(int)}.
+   * </ul>
+   *
+   * @param trustProxy True to enable.
+   * @return This options.
+   */
+  @NonNull public RouterOptions setTrustProxy(boolean trustProxy) {
+    this.trustProxy = trustProxy;
+    return this;
+  }
 }

jooby/src/main/java/io/jooby/internal/RouterImpl.java

@@ -45,7 +45,6 @@
 import io.jooby.output.OutputFactory;
 import io.jooby.problem.ProblemDetailsHandler;
 import io.jooby.value.ValueFactory;
-import jakarta.inject.Provider;
 
 public class RouterImpl implements Router {
 
@@ -159,10 +158,6 @@ public Stack executor(Executor executor) {
 
   private RouterOptions routerOptions = RouterOptions.defaults();
 
-  private boolean trustProxy;
-
-  private boolean contextAsService;
-
   private boolean started;
 
   private boolean stopped;
@@ -232,11 +227,6 @@ public List<Route> getRoutes() {
     return routes;
   }
 
-  @Override
-  public boolean isTrustProxy() {
-    return trustProxy;
-  }
-
   @Override
   public boolean isStarted() {
     return started;
@@ -247,15 +237,12 @@ public boolean isStopped() {
     return stopped;
   }
 
-  @NonNull @Override
-  public Router setTrustProxy(boolean trustProxy) {
-    this.trustProxy = trustProxy;
+  private void configureTrustProxy(boolean trustProxy) {
     if (trustProxy) {
       addPreDispatchInitializer(ContextInitializer.PROXY_PEER_ADDRESS);
     } else {
       removePreDispatchInitializer(ContextInitializer.PROXY_PEER_ADDRESS);
     }
-    return this;
   }
 
   @NonNull @Override
@@ -548,6 +535,8 @@ private void pureAscii(String pattern, Consumer<String> consumer) {
 
   @NonNull public Router start(@NonNull Jooby app, @NonNull Server server) {
     started = true;
+    configureTrustProxy(routerOptions.isTrustProxy());
+    setContextAsService();
     var globalErrHandler = defineGlobalErrorHandler(app);
     if (err == null) {
       err = globalErrHandler;
@@ -812,21 +801,9 @@ public Router setCurrentUser(@NonNull Function<Context, Object> provider) {
     return this;
   }
 
-  @NonNull @Override
-  public Router setContextAsService(boolean contextAsService) {
-    if (this.contextAsService == contextAsService) {
-      return this;
-    }
-
-    this.contextAsService = contextAsService;
-
-    if (contextAsService) {
-      addPostDispatchInitializer(ContextAsServiceInitializer.INSTANCE);
-      getServices().put(Context.class, ContextAsServiceInitializer.INSTANCE);
-    } else {
-      removePostDispatchInitializer(ContextAsServiceInitializer.INSTANCE);
-      getServices().put(Context.class, (Provider<Context>) null);
-    }
+  private Router setContextAsService() {
+    addPostDispatchInitializer(ContextAsServiceInitializer.INSTANCE);
+    getServices().put(Context.class, ContextAsServiceInitializer.INSTANCE);
 
     return this;
   }