[UNDERTOW-2303] Improvements based on PR feedback. Changed copyright notices from 2024 to 2025, fixed typos and javadoc links, mark unused methods as deprecated, remove new unused methods, replaced exception messages with exceptions from UndertowMessages

Author: dirkroets

core/src/main/java/io/undertow/UndertowMessages.java

@@ -661,4 +661,18 @@ public interface UndertowMessages {
     @Message(id = 212, value = "Failed to encode query string '%s' with '%s' encoding.")
     IllegalArgumentException failedToEncodeQueryString(String q, String e);
 
+    @Message(id = 213, value = "Wild cards are only supported at the end of a template path")
+    IllegalArgumentException wildCardsOnlyAtEndOfTemplate();
+
+    @Message(id = 214, value = "Illegal character '%s' is contained in the URL path segment '%s' at position %s")
+    IllegalArgumentException illegalCharacterInPathSegment(char character, String segment, int position);
+
+    @Message(id = 215, value = "updateDefaultTargetFactory cannot be called after having added templates")
+    IllegalStateException defaultTargetUpdatedAfterTemplatesAdded();
+
+    @Message(id = 216, value = "The builder already contains a template with the same pattern for '%s'")
+    IllegalArgumentException duplicateUrlPathTemplate(String template);
+
+    @Message(id = 217, value = "The 'defaultTargetFactory' must be set before calling 'build'")
+    IllegalStateException defaultTargetFactoryMustBeSetBeforeBuild();
 }

core/src/main/java/io/undertow/server/RoutingHandler.java

@@ -1,6 +1,6 @@
 /*
  * JBoss, Home of Professional Open Source.
- * Copyright 2024 Red Hat, Inc., and individual contributors
+ * Copyright 2025 Red Hat, Inc., and individual contributors
  * as indicated by the @author tags.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -230,7 +230,7 @@ public void handleRequest(final HttpServerExchange exchange) throws Exception {
      * @param method The HTTP method.
      * @return The builder.
      */
-    private PathTemplateRouterFactory.Builder<RoutingMatchBuilder, RoutingMatch> getOrAddMethodRouterBuiler(
+    private PathTemplateRouterFactory.Builder<RoutingMatchBuilder, RoutingMatch> getOrAddMethodRouterBuilder(
             final HttpString method
     ) {
         Objects.requireNonNull(method);
@@ -259,7 +259,7 @@ private RoutingMatchBuilder getOrAddMethodRoutingMatchBuilder(
         Objects.requireNonNull(template);
 
         final PathTemplateRouterFactory.Builder<RoutingMatchBuilder, RoutingMatch> routeBuilder
-                = getOrAddMethodRouterBuiler(method);
+                = getOrAddMethodRouterBuilder(method);
         final PathTemplateParser.PathTemplate<RoutingMatchBuilder> parsedTemplate = PathTemplateParser.parseTemplate(
                 template, new RoutingMatchBuilder()
         );
@@ -425,12 +425,12 @@ public synchronized RoutingHandler addAll(RoutingHandler routingHandler) {
         its configuration (templates etc) are mutated.  Mutating via the original RoutingHandler would - after
         having called this method - also result in the router being out of sync with the router builder.
         For these reasons, this has been changed to a deep copy.  Arguably, developers won't expect to end up with
-        two RoutingHandlers that are implicitely linked after having called this method anyway. */
+        two RoutingHandlers that are implicitly linked after having called this method anyway. */
         synchronized (routingHandler) {
             for (final Entry<HttpString, PathTemplateRouterFactory.Builder<RoutingMatchBuilder, RoutingMatch>> outer
                     : routingHandler.methodRouterBuilders.entrySet()) {
                 final PathTemplateRouterFactory.Builder<RoutingMatchBuilder, RoutingMatch> builder
-                        = getOrAddMethodRouterBuiler(outer.getKey());
+                        = getOrAddMethodRouterBuilder(outer.getKey());
                 for (final Entry<PathTemplateParser.PathTemplatePatternEqualsAdapter<PathTemplateParser.PathTemplate<RoutingMatchBuilder>>, RoutingMatchBuilder> inner
                         : outer.getValue().getTemplates().entrySet()) {
                     builder.addTemplate(
@@ -490,7 +490,10 @@ public synchronized RoutingHandler remove(final HttpString method, final String
      * @param path the path template to remove
      *
      * @return this handler
+     *
+     * @deprecated Not used. Will be removed in future releases.
      */
+    @Deprecated(forRemoval = true)
     public synchronized RoutingHandler remove(final String path) {
         Objects.requireNonNull(path);
 
@@ -505,7 +508,10 @@ public synchronized RoutingHandler remove(final String path) {
 
     /**
      * @return Handler called when no match was found and invalid method handler can't be invoked.
+     *
+     * @deprecated Not used. Will be removed in future releases.
      */
+    @Deprecated(forRemoval = true)
     public HttpHandler getFallbackHandler() {
         return fallbackHandler;
     }
@@ -514,15 +520,21 @@ public HttpHandler getFallbackHandler() {
      * @param fallbackHandler Handler that will be called when no match was found and invalid method handler can't be invoked.
      *
      * @return This instance.
+     *
+     * @deprecated Not used. Will be removed in future releases.
      */
+    @Deprecated(forRemoval = true)
     public RoutingHandler setFallbackHandler(HttpHandler fallbackHandler) {
         this.fallbackHandler = fallbackHandler;
         return this;
     }
 
     /**
      * @return Handler called when this instance can not match the http method but can match another http method.
+     *
+     * @deprecated Not used. Will be removed in future releases.
      */
+    @Deprecated(forRemoval = true)
     public HttpHandler getInvalidMethodHandler() {
         return invalidMethodHandler;
     }
@@ -536,7 +548,10 @@ public HttpHandler getInvalidMethodHandler() {
      * another http method.
      *
      * @return This instance.
+     *
+     * @deprecated Not used. Will be removed in future releases.
      */
+    @Deprecated(forRemoval = true)
     public RoutingHandler setInvalidMethodHandler(HttpHandler invalidMethodHandler) {
         this.invalidMethodHandler = invalidMethodHandler;
         return this;

core/src/main/java/io/undertow/server/handlers/PathTemplateHandler.java

@@ -1,6 +1,6 @@
 /*
  * JBoss, Home of Professional Open Source.
- * Copyright 2024 Red Hat, Inc., and individual contributors
+ * Copyright 2025 Red Hat, Inc., and individual contributors
  * as indicated by the @author tags.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");

core/src/main/java/io/undertow/server/handlers/PathTemplateRouterHandler.java

@@ -1,6 +1,6 @@
 /*
  * JBoss, Home of Professional Open Source.
- * Copyright 2024 Red Hat, Inc., and individual contributors
+ * Copyright 2025 Red Hat, Inc., and individual contributors
  * as indicated by the @author tags.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");

core/src/main/java/io/undertow/util/PathTemplateParser.java

@@ -1,6 +1,6 @@
 /*
  * JBoss, Home of Professional Open Source.
- * Copyright 2024 Red Hat, Inc., and individual contributors
+ * Copyright 2025 Red Hat, Inc., and individual contributors
  * as indicated by the @author tags.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,6 +17,7 @@
  */
 package io.undertow.util;
 
+import io.undertow.UndertowMessages;
 import static io.undertow.util.PathTemplateUtil.pathWithForwardSlash;
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -126,7 +127,7 @@ public class PathTemplateParser {
      * <p>
      * In the above mentioned example the {@link #hashCode() } method may return different values for the two templates and
      * {@link #equals(java.lang.Object) } will return 'false'. The {@link #patternHashCode() } will return the same values for
-     * the two templates and {@link #patternEquals(io.undertow.util.PathTemplatePattern) } will return 'true'.</p>
+     * the two templates and {@link #patternEquals(io.undertow.util.PathTemplateParser.PathTemplatePattern) } will return 'true'.</p>
      */
     public abstract static class PathTemplatePattern {
 
@@ -611,7 +612,7 @@ private static void validWildCardOrNotAWildCard(final String pathTemplate) {
         }
 
         if (idx != (pathTemplate.length() - 1)) {
-            throw new IllegalArgumentException("Wild cards are only supported at the end of a template path");
+            throw UndertowMessages.MESSAGES.wildCardsOnlyAtEndOfTemplate();
         }
     }
 
@@ -659,8 +660,7 @@ private static String validSegment(
             valid = valid || c == '_' || c == '-';
 
             if (!valid) {
-                throw new IllegalArgumentException("Illegal character '"
-                        + c + "' is contained in the segment '" + value + "' at position " + i);
+                throw UndertowMessages.MESSAGES.illegalCharacterInPathSegment(c, value, i);
             }
         }
 

core/src/main/java/io/undertow/util/PathTemplateRouteResult.java

@@ -1,6 +1,6 @@
 /*
  * JBoss, Home of Professional Open Source.
- * Copyright 2024 Red Hat, Inc., and individual contributors
+ * Copyright 2025 Red Hat, Inc., and individual contributors
  * as indicated by the @author tags.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");

core/src/main/java/io/undertow/util/PathTemplateRouter.java

@@ -1,6 +1,6 @@
 /*
  * JBoss, Home of Professional Open Source.
- * Copyright 2024 Red Hat, Inc., and individual contributors
+ * Copyright 2025 Red Hat, Inc., and individual contributors
  * as indicated by the @author tags.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -99,11 +99,6 @@
  */
 public interface PathTemplateRouter<T> {
 
-    /**
-     * @return The default target for requests that do not match any specific routes.
-     */
-    T getDefaultTarget();
-
     /**
      * Routes the requested URL path to the best available target from the set of underlying URL path templates.
      *