This is an automated email from the ASF dual-hosted git repository.
tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/artemis.git
The following commit(s) were added to refs/heads/main by this push:
new 0812f20b71 ARTEMIS-5826 improve filter doc
0812f20b71 is described below
commit 0812f20b71003a748503d8c60b8f7735167d09d1
Author: Justin Bertram <[email protected]>
AuthorDate: Wed Dec 17 14:47:45 2025 -0600
ARTEMIS-5826 improve filter doc
---
.../activemq/artemis/selector/SelectorTest.java | 18 ++++++++++----
docs/user-manual/filter-expressions.adoc | 29 ++++++++++++++--------
2 files changed, 31 insertions(+), 16 deletions(-)
diff --git
a/artemis-selector/src/test/java/org/apache/activemq/artemis/selector/SelectorTest.java
b/artemis-selector/src/test/java/org/apache/activemq/artemis/selector/SelectorTest.java
index 4e693edb05..eaccfd02fa 100755
---
a/artemis-selector/src/test/java/org/apache/activemq/artemis/selector/SelectorTest.java
+++
b/artemis-selector/src/test/java/org/apache/activemq/artemis/selector/SelectorTest.java
@@ -104,12 +104,20 @@ public class SelectorTest {
@Test
public void testDottedProperty() throws Exception {
- MockMessage message = createMessage();
- message.setJMSType("selector-test");
- message.setStringProperty("a.test", "value");
- message.setJMSMessageID("id:test:1:1:1:1");
+ testQuotedProperty('.');
+ }
- assertSelector(message, "\"a.test\" = 'value'", true);
+ @Test
+ public void testHyphenatedProperty() throws Exception {
+ testQuotedProperty('-');
+ }
+
+ private void testQuotedProperty(char c) throws Exception {
+ final String value = "value";
+ final String key = "a" + c + "test";
+ MockMessage message = createMessage();
+ message.setStringProperty(key, value);
+ assertSelector(message, "\"" + key + "\" = '" + value + "'", true);
}
@Test
diff --git a/docs/user-manual/filter-expressions.adoc
b/docs/user-manual/filter-expressions.adoc
index c826058ad5..a42614ac49 100644
--- a/docs/user-manual/filter-expressions.adoc
+++ b/docs/user-manual/filter-expressions.adoc
@@ -57,24 +57,31 @@ The value is an integer.
Any other identifiers used in core filter expressions will be assumed to be
properties of the message.
-The JMS and Jakarta Messaging specs state that a String property should not
get converted to a numeric when used in a selector.
-So for example, if a message has the `age` property set to `String` `21` then
the following selector should not match it: `age > 18`.
-STOMP clients, for example, can only send messages with string properties,
which is a bit limiting.
-Therefore, if you want your filter expressions to auto-convert `String`
properties to the appropriate number type, just prefix it with
`convert_string_expressions:`.
-If you changed the filter expression in the previous example to be
`convert_string_expressions:age > 18`, then it would match the aforementioned
message.
+== Property Identifier Constraints
-The JMS and Jakarta Messaging specs also state that property identifiers (and
therefore the identifiers which are valid for use in a filter expression) are
an:
+The JMS and Jakarta Messaging specs state that property identifiers (and
therefore the identifiers which are valid for use in a filter expression) are
an:
____
unlimited-length sequence of letters and digits, the first of which must be a
letter.
-A letter is any character for which the method `Character.isJavaLetter`
returns `true`.
+A letter is any character for which the method
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html#isJavaLetter(char)[`Character.isJavaLetter`]
returns `true`.
This includes `_` and `$`.
-A letter or digit is any character for which the method
`Character.isJavaLetterOrDigit` returns `true`.
+A letter or digit is any character for which the method
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html#isJavaLetterOrDigit(char)[`Character.isJavaLetterOrDigit`]
returns `true`.
____
-This constraint means that hyphens (i.e. `-`) cannot be used.
-However, this constraint can be overcome by using the `hyphenated_props:`
prefix.
-For example, if a message had the `foo-bar` property set to `0` then the
filter expression `hyphenated_props:foo-bar = 0` would match it.
+=== Working Around These Constraints
+
+These constraints mean that characters like `.` (dot) and `-` (hyphen) cannot
be used within property identifiers.
+However, if you want to work around these constraints, you can surround the
identifier with quotation marks in the filter expression.
+For example, if a message had a property named `foo-bar` set to `0` then the
filter expression `"foo-bar" = 0` would match it, whereas `foo-bar = 0` would
*not* match.
+
+== Property Value Conversion
+
+The JMS and Jakarta Messaging specs also state that a `String` property should
not get converted to a numeric value when used in a selector.
+So for example, if a message has the `age` property set to the `String` "21"
then the following selector should not match it: `age > 18`.
+
+However, some protocols (e.g. STOMP) can only send messages with `String`
properties, which is a bit limiting.
+Therefore, if you want your filter expressions to auto-convert `String`
properties to the appropriate number type, just prefix it with
`convert_string_expressions:`.
+If you changed the filter expression in the previous example to be
`convert_string_expressions:age > 18`, then it would match the aforementioned
message.
== XPath
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
