Apache
/
activemq-artemis
mirror of https://github.com/apache/activemq-artemis.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
activemq-artemis/docs/user-manual/en/wildcard-syntax.md

68 lines
1.8 KiB
Markdown
Raw Normal View History

NO-JIRA review docs for content, style, & format
2018-03-08 15:46:38 -05:00
# Wildcard Syntax
ACTIVEMQ6-9 - port to markdown https://issues.apache.org/jira/browse/ACTIVEMQ6-9 remove the jboss jdocbook build and style and replace using plane markdown
2014-12-04 10:25:29 -05:00
ARTEMIS-4262 clarify wildcard syntax documentation
2023-04-26 13:50:21 -04:00
Apache ActiveMQ Artemis uses a specific syntax for representing
wildcards in security settings, address settings and when creating
consumers.
ACTIVEMQ6-9 - port to markdown https://issues.apache.org/jira/browse/ACTIVEMQ6-9 remove the jboss jdocbook build and style and replace using plane markdown
2014-12-04 10:25:29 -05:00
NO-JIRA fix warnings from w3c/link-checker in docs also update URLs and `s/http/https` in docs wherever possible
2017-12-22 16:25:21 -05:00
The syntax is similar to that used by [AMQP](https://www.amqp.org).
ACTIVEMQ6-9 - port to markdown https://issues.apache.org/jira/browse/ACTIVEMQ6-9 remove the jboss jdocbook build and style and replace using plane markdown
2014-12-04 10:25:29 -05:00
ARTEMIS-4262 clarify wildcard syntax documentation
2023-04-26 13:50:21 -04:00
An Apache ActiveMQ Artemis wildcard expression contains **words
separated by a delimiter**. The default delimiter is `.` (full stop).
ACTIVEMQ6-9 - port to markdown https://issues.apache.org/jira/browse/ACTIVEMQ6-9 remove the jboss jdocbook build and style and replace using plane markdown
2014-12-04 10:25:29 -05:00
ARTEMIS-3657 refactor address docs Mainly refactoring the address docs. This commit has the following changes: - Remove examples for discouraged use-cases (e.g. using anycast and multicast on the same address). - Reword to use configuration terms wherever possible. For example, instead of saying "point-to-point" (which is not a configuration term) say "anycast". References to things like "point-to-point" and "publish-subscribe" are still there since users are familiar with these terms. They're just used much less often. - Remove duplicate explanation of exclusive queues. - Remove duplicate explanation of auto-create and auto-delete elements. - Re-create graphics and include the master SVGs for potential updates later. - Give non-destructive queues its own chapter. - Add details about specifying routing type using a message property. - Update the styling on the user manual's cover page to look better. - Lots of re-wording for clarity's sake. - Re-order sub-sections for clarity's sake. - Break up the address model and the settings documentation. The settings documentation is large and deserves its own chapter. The original anchor link is still available with a link to the new chapter. In general the address-specific documentation should be much more clear, concise, and consistent now.
2022-01-22 01:16:50 -05:00
The special characters `#` and `*` also have special meaning and can
ARTEMIS-4262 clarify wildcard syntax documentation
2023-04-26 13:50:21 -04:00
take the place of a **word**.
To be clear, the wildcard characters cannot be used like wildcards in
a [regular expression](https://en.wikipedia.org/wiki/Regular_expression).
They operate exclusively on **words separated by a delimiter**.
## Matching Any Word
ACTIVEMQ6-9 - port to markdown https://issues.apache.org/jira/browse/ACTIVEMQ6-9 remove the jboss jdocbook build and style and replace using plane markdown
2014-12-04 10:25:29 -05:00
ARTEMIS-3657 refactor address docs Mainly refactoring the address docs. This commit has the following changes: - Remove examples for discouraged use-cases (e.g. using anycast and multicast on the same address). - Reword to use configuration terms wherever possible. For example, instead of saying "point-to-point" (which is not a configuration term) say "anycast". References to things like "point-to-point" and "publish-subscribe" are still there since users are familiar with these terms. They're just used much less often. - Remove duplicate explanation of exclusive queues. - Remove duplicate explanation of auto-create and auto-delete elements. - Re-create graphics and include the master SVGs for potential updates later. - Give non-destructive queues its own chapter. - Add details about specifying routing type using a message property. - Update the styling on the user manual's cover page to look better. - Lots of re-wording for clarity's sake. - Re-order sub-sections for clarity's sake. - Break up the address model and the settings documentation. The settings documentation is large and deserves its own chapter. The original anchor link is still available with a link to the new chapter. In general the address-specific documentation should be much more clear, concise, and consistent now.
2022-01-22 01:16:50 -05:00
The character `#` means "match any sequence of zero or more words".
ACTIVEMQ6-9 - port to markdown https://issues.apache.org/jira/browse/ACTIVEMQ6-9 remove the jboss jdocbook build and style and replace using plane markdown
2014-12-04 10:25:29 -05:00
ARTEMIS-4262 clarify wildcard syntax documentation
2023-04-26 13:50:21 -04:00
So the wildcard `news.europe.#` would match:
- `news.europe`
- `news.europe.sport`
- `news.europe.politics`
- `news.europe.politics.regional`
But `news.europe.#` would _not_ match:
- `news.usa`
- `news.usa.sport`
- `entertainment`
## Matching a Single Word
ARTEMIS-3657 refactor address docs Mainly refactoring the address docs. This commit has the following changes: - Remove examples for discouraged use-cases (e.g. using anycast and multicast on the same address). - Reword to use configuration terms wherever possible. For example, instead of saying "point-to-point" (which is not a configuration term) say "anycast". References to things like "point-to-point" and "publish-subscribe" are still there since users are familiar with these terms. They're just used much less often. - Remove duplicate explanation of exclusive queues. - Remove duplicate explanation of auto-create and auto-delete elements. - Re-create graphics and include the master SVGs for potential updates later. - Give non-destructive queues its own chapter. - Add details about specifying routing type using a message property. - Update the styling on the user manual's cover page to look better. - Lots of re-wording for clarity's sake. - Re-order sub-sections for clarity's sake. - Break up the address model and the settings documentation. The settings documentation is large and deserves its own chapter. The original anchor link is still available with a link to the new chapter. In general the address-specific documentation should be much more clear, concise, and consistent now.
2022-01-22 01:16:50 -05:00
The character `*` means "match a single word".
ACTIVEMQ6-9 - port to markdown https://issues.apache.org/jira/browse/ACTIVEMQ6-9 remove the jboss jdocbook build and style and replace using plane markdown
2014-12-04 10:25:29 -05:00
ARTEMIS-4262 clarify wildcard syntax documentation
2023-04-26 13:50:21 -04:00
The wildcard `news.*` would match:
- `news.europe`
- `news.usa`
But `news.*` would _not_ match:
- `news.europe.sport`
- `news.usa.sport`
- `news.europe.politics.regional`
ACTIVEMQ6-9 - port to markdown https://issues.apache.org/jira/browse/ACTIVEMQ6-9 remove the jboss jdocbook build and style and replace using plane markdown
2014-12-04 10:25:29 -05:00
ARTEMIS-4262 clarify wildcard syntax documentation
2023-04-26 13:50:21 -04:00
The wildcard `news.*.sport` would match:
- `news.europe.sport`
- `news.usa.sport`
ACTIVEMQ6-9 - port to markdown https://issues.apache.org/jira/browse/ACTIVEMQ6-9 remove the jboss jdocbook build and style and replace using plane markdown
2014-12-04 10:25:29 -05:00
ARTEMIS-4262 clarify wildcard syntax documentation
2023-04-26 13:50:21 -04:00
But `news.*.sport` would _not_ match:
- `news.europe.politics`
https://issues.apache.org/jira/browse/ARTEMIS-815 - implement configurable wildcard addresses syntax Rename WildCardConfigurationTest.java to WildcardConfigurationTest.java adjust schema
2016-12-23 06:02:30 -05:00
NO-JIRA review docs for content, style, & format
2018-03-08 15:46:38 -05:00
## Customizing the Syntax
https://issues.apache.org/jira/browse/ARTEMIS-815 - implement configurable wildcard addresses syntax Rename WildCardConfigurationTest.java to WildcardConfigurationTest.java adjust schema
2016-12-23 06:02:30 -05:00
It's possible to further configure the syntax of the wildcard addresses using the broker configuration.
For that, the `<wildcard-addresses>` configuration tag is used.
NO-JIRA review docs for content, style, & format
2018-03-08 15:46:38 -05:00
```xml
<wildcard-addresses>
<routing-enabled>true</routing-enabled>
<delimiter>.</delimiter>
<any-words>#</any-words>
<single-word>*</single-word>
</wildcard-addresses>
```
https://issues.apache.org/jira/browse/ARTEMIS-815 - implement configurable wildcard addresses syntax Rename WildCardConfigurationTest.java to WildcardConfigurationTest.java adjust schema
2016-12-23 06:02:30 -05:00
The example above shows the default configuration.