[UNDERTOW-2229] Add priority to PredicateBuilder to override internal…

… predicates with predicate language
undertow-io · Apr 3, 2024 · 443c17c · 443c17c
1 parent ddb4aee
commit 443c17c
Show file tree

Hide file tree

Showing 20 changed files with 105 additions and 0 deletions.
diff --git a/core/src/main/java/io/undertow/predicate/AuthenticationRequiredPredicate.java b/core/src/main/java/io/undertow/predicate/AuthenticationRequiredPredicate.java
@@ -59,5 +59,10 @@ public String defaultParameter() {
         public Predicate build(final Map<String, Object> config) {
             return INSTANCE;
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/ContainsPredicate.java b/core/src/main/java/io/undertow/predicate/ContainsPredicate.java
@@ -106,5 +106,10 @@ public Predicate build(final Map<String, Object> config) {
             ExchangeAttribute values = (ExchangeAttribute) config.get("value");
             return new ContainsPredicate(values, search);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/EqualsPredicate.java b/core/src/main/java/io/undertow/predicate/EqualsPredicate.java
@@ -96,5 +96,10 @@ public Predicate build(final Map<String, Object> config) {
             ExchangeAttribute[] value = (ExchangeAttribute[]) config.get("value");
             return new EqualsPredicate(value);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/ExistsPredicate.java b/core/src/main/java/io/undertow/predicate/ExistsPredicate.java
@@ -82,5 +82,10 @@ public Predicate build(final Map<String, Object> config) {
             ExchangeAttribute value = (ExchangeAttribute) config.get("value");
             return new ExistsPredicate(value);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/IdempotentPredicate.java b/core/src/main/java/io/undertow/predicate/IdempotentPredicate.java
@@ -86,5 +86,10 @@ public String defaultParameter() {
         public Predicate build(Map<String, Object> config) {
             return INSTANCE;
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/MaxContentSizePredicate.java b/core/src/main/java/io/undertow/predicate/MaxContentSizePredicate.java
@@ -83,5 +83,10 @@ public Predicate build(final Map<String, Object> config) {
             Long max = (Long) config.get("value");
             return new MaxContentSizePredicate(max);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/MethodPredicate.java b/core/src/main/java/io/undertow/predicate/MethodPredicate.java
@@ -89,5 +89,10 @@ public Predicate build(final Map<String, Object> config) {
             String[] methods = (String[]) config.get("value");
             return new MethodPredicate(methods);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/MinContentSizePredicate.java b/core/src/main/java/io/undertow/predicate/MinContentSizePredicate.java
@@ -83,5 +83,10 @@ public Predicate build(final Map<String, Object> config) {
             Long max = (Long) config.get("value");
             return new MinContentSizePredicate(max);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/PathMatchPredicate.java b/core/src/main/java/io/undertow/predicate/PathMatchPredicate.java
@@ -98,5 +98,10 @@ public Predicate build(final Map<String, Object> config) {
             String[] path = (String[]) config.get("path");
             return new PathMatchPredicate(path);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/PathPrefixPredicate.java b/core/src/main/java/io/undertow/predicate/PathPrefixPredicate.java
@@ -116,6 +116,11 @@ public Predicate build(final Map<String, Object> config) {
             String[] path = (String[]) config.get("path");
             return new PathPrefixPredicate(path);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 
     public static class PathPrefixMatchRecord {

diff --git a/core/src/main/java/io/undertow/predicate/PathSuffixPredicate.java b/core/src/main/java/io/undertow/predicate/PathSuffixPredicate.java
@@ -82,5 +82,10 @@ public Predicate build(final Map<String, Object> config) {
             String[] path = (String[]) config.get("path");
             return Predicates.suffixes(path);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/PathTemplatePredicate.java b/core/src/main/java/io/undertow/predicate/PathTemplatePredicate.java
@@ -118,6 +118,11 @@ public Predicate build(final Map<String, Object> config) {
             String value = (String) config.get("value");
             return new PathTemplatePredicate(value, match);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 
 }
diff --git a/core/src/main/java/io/undertow/predicate/PredicateBuilder.java b/core/src/main/java/io/undertow/predicate/PredicateBuilder.java
@@ -62,4 +62,14 @@ public interface PredicateBuilder {
      */
     Predicate build(final Map<String, Object> config);
 
+    /**
+     * The priority of the builder. Builders will be tried in priority builder. Built in builders use the priority range 0-100.
+     * Default implementation returns 1 for backwards compatibility.
+     *
+     * @return The priority
+     */
+    default int priority() {
+        return 1;
+    }
+
 }
diff --git a/core/src/main/java/io/undertow/predicate/RegularExpressionPredicate.java b/core/src/main/java/io/undertow/predicate/RegularExpressionPredicate.java
@@ -142,5 +142,10 @@ public Predicate build(final Map<String, Object> config) {
             String pattern = (String) config.get("pattern");
             return new RegularExpressionPredicate(pattern, value, fullMatch == null ? false : fullMatch, caseSensitive == null ? true : caseSensitive);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/RequestLargerThanPredicate.java b/core/src/main/java/io/undertow/predicate/RequestLargerThanPredicate.java
@@ -79,5 +79,10 @@ public Predicate build(final Map<String, Object> config) {
             Long size = (Long) config.get("size");
             return new RequestLargerThanPredicate(size);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/RequestSmallerThanPredicate.java b/core/src/main/java/io/undertow/predicate/RequestSmallerThanPredicate.java
@@ -79,5 +79,10 @@ public Predicate build(final Map<String, Object> config) {
             Long size = (Long) config.get("size");
             return new RequestSmallerThanPredicate(size);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 }
diff --git a/core/src/main/java/io/undertow/predicate/SecurePredicate.java b/core/src/main/java/io/undertow/predicate/SecurePredicate.java
@@ -66,6 +66,11 @@ public String defaultParameter() {
         public Predicate build(Map<String, Object> config) {
             return INSTANCE;
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 
 }
diff --git a/servlet/src/main/java/io/undertow/servlet/predicate/DirectoryPredicate.java b/servlet/src/main/java/io/undertow/servlet/predicate/DirectoryPredicate.java
@@ -105,6 +105,11 @@ public Predicate build(final Map<String, Object> config) {
             }
             return new DirectoryPredicate(value);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 
 }
diff --git a/servlet/src/main/java/io/undertow/servlet/predicate/DispatcherTypePredicate.java b/servlet/src/main/java/io/undertow/servlet/predicate/DispatcherTypePredicate.java
@@ -91,6 +91,11 @@ public Predicate build(final Map<String, Object> config) {
             String value = (String) config.get("value");
             return new DispatcherTypePredicate(DispatcherType.valueOf(value));
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 
 }
diff --git a/servlet/src/main/java/io/undertow/servlet/predicate/FilePredicate.java b/servlet/src/main/java/io/undertow/servlet/predicate/FilePredicate.java
@@ -120,6 +120,11 @@ public Predicate build(final Map<String, Object> config) {
             }
             return new FilePredicate(value, requireContent == null ? false : requireContent);
         }
+
+        @Override
+        public int priority() {
+            return 0;
+        }
     }
 
 }