ARTEMIS-1562 Refactor example documentation This commit contains these changes: * Change example documentation to use markdown * Generate HTML doc based on markdown during release * Fix XML formatting in some examples * Repair out-of-date documentation
Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/b77cdaf7 Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/b77cdaf7 Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/b77cdaf7 Branch: refs/heads/master Commit: b77cdaf773de853ad1594918044968a11c26d467 Parents: 4ad05e1 Author: Justin Bertram <[email protected]> Authored: Tue Oct 24 14:20:37 2017 -0500 Committer: Martyn Taylor <[email protected]> Committed: Fri Dec 15 14:54:16 2017 +0000 ---------------------------------------------------------------------- .gitignore | 1 + artemis-distribution/src/main/assembly/dep.xml | 1 + examples/common/footer.html | 2 + examples/common/header.html | 27 ++ .../client-side-load-balancing/pom.xml | 18 +- .../client-side-load-balancing/readme.html | 49 --- .../client-side-load-balancing/readme.md | 15 + .../clustered-durable-subscription/pom.xml | 20 +- .../clustered-durable-subscription/readme.html | 65 ---- .../clustered-durable-subscription/readme.md | 25 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../clustered/clustered-grouping/pom.xml | 22 +- .../clustered/clustered-grouping/readme.html | 79 ---- .../clustered/clustered-grouping/readme.md | 48 +++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../main/resources/activemq/server2/broker.xml | 8 +- .../clustered/clustered-jgroups/pom.xml | 18 +- .../clustered/clustered-jgroups/readme.html | 67 ---- .../clustered/clustered-jgroups/readme.md | 34 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../features/clustered/clustered-queue/pom.xml | 20 +- .../clustered/clustered-queue/readme.html | 55 --- .../clustered/clustered-queue/readme.md | 26 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../clustered-static-discovery-uri/pom.xml | 20 +- .../clustered-static-discovery-uri/readme.html | 57 --- .../clustered-static-discovery-uri/readme.md | 28 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../main/resources/activemq/server2/broker.xml | 8 +- .../main/resources/activemq/server3/broker.xml | 8 +- .../clustered-static-discovery/pom.xml | 20 +- .../clustered-static-discovery/readme.html | 57 --- .../clustered-static-discovery/readme.md | 28 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../main/resources/activemq/server2/broker.xml | 8 +- .../main/resources/activemq/server3/broker.xml | 8 +- .../clustered/clustered-static-oneway/pom.xml | 19 +- .../clustered-static-oneway/readme.html | 63 ---- .../clustered/clustered-static-oneway/readme.md | 30 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../main/resources/activemq/server2/broker.xml | 8 +- .../clustered/clustered-topic-uri/pom.xml | 21 +- .../clustered/clustered-topic-uri/readme.html | 46 --- .../clustered/clustered-topic-uri/readme.md | 21 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../features/clustered/clustered-topic/pom.xml | 19 +- .../clustered/clustered-topic/readme.html | 54 --- .../clustered/clustered-topic/readme.md | 25 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../queue-message-redistribution/pom.xml | 20 +- .../queue-message-redistribution/readme.html | 61 ---- .../queue-message-redistribution/readme.md | 23 ++ .../main/resources/activemq/server0/broker.xml | 12 +- .../main/resources/activemq/server1/broker.xml | 12 +- .../clustered/symmetric-cluster/pom.xml | 18 +- .../clustered/symmetric-cluster/readme.html | 73 ---- .../clustered/symmetric-cluster/readme.md | 38 ++ .../jms/example/SymmetricClusterExample.java | 2 +- .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../main/resources/activemq/server2/broker.xml | 8 +- .../main/resources/activemq/server3/broker.xml | 8 +- .../main/resources/activemq/server4/broker.xml | 8 +- .../main/resources/activemq/server5/broker.xml | 8 +- .../ha/application-layer-failover/pom.xml | 18 +- .../ha/application-layer-failover/readme.html | 169 --------- .../ha/application-layer-failover/readme.md | 17 + .../ha/client-side-failoverlistener/pom.xml | 24 +- .../ha/client-side-failoverlistener/readme.html | 37 -- .../ha/client-side-failoverlistener/readme.md | 7 + .../ha/colocated-failover-scale-down/pom.xml | 20 +- .../colocated-failover-scale-down/readme.html | 65 ---- .../ha/colocated-failover-scale-down/readme.md | 31 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- examples/features/ha/colocated-failover/pom.xml | 19 +- .../features/ha/colocated-failover/readme.html | 56 --- .../features/ha/colocated-failover/readme.md | 27 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../features/ha/ha-policy-autobackup/pom.xml | 20 +- .../main/resources/activemq/server0/broker.xml | 9 +- .../main/resources/activemq/server1/broker.xml | 9 +- .../ha/multiple-failover-failback/pom.xml | 20 +- examples/features/ha/multiple-failover/pom.xml | 20 +- .../ha/non-transaction-failover/pom.xml | 20 +- .../ha/non-transaction-failover/readme.html | 157 -------- .../ha/non-transaction-failover/readme.md | 13 + .../ha/replicated-failback-static/pom.xml | 19 +- .../ha/replicated-failback-static/readme.html | 38 -- .../ha/replicated-failback-static/readme.md | 7 + .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../features/ha/replicated-failback/pom.xml | 17 + .../features/ha/replicated-failback/readme.html | 38 -- .../features/ha/replicated-failback/readme.md | 7 + .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../ha/replicated-multiple-failover/pom.xml | 20 +- .../ha/replicated-multiple-failover/readme.html | 45 --- .../ha/replicated-multiple-failover/readme.md | 7 + .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../main/resources/activemq/server2/broker.xml | 8 +- .../ha/replicated-transaction-failover/pom.xml | 19 +- .../replicated-transaction-failover/readme.html | 148 -------- .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- examples/features/ha/scale-down/pom.xml | 20 +- examples/features/ha/scale-down/readme.html | 51 --- .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../features/ha/stop-server-failover/pom.xml | 20 +- .../ha/stop-server-failover/readme.html | 44 --- .../features/ha/transaction-failover/pom.xml | 20 +- .../ha/transaction-failover/readme.html | 46 --- .../main/resources/activemq/server0/broker.xml | 8 +- .../main/resources/activemq/server1/broker.xml | 8 +- examples/features/perf/perf/pom.xml | 21 +- examples/features/perf/perf/readme.html | 39 -- examples/features/perf/soak/README | 85 ----- examples/features/perf/soak/pom.xml | 21 +- examples/features/perf/soak/readme.md | 70 ++++ examples/features/perf/soak/server0/broker.xml | 6 +- examples/features/standard/README.md | 2 +- examples/features/standard/bridge/pom.xml | 18 +- examples/features/standard/bridge/readme.html | 74 ---- examples/features/standard/bridge/readme.md | 38 ++ .../main/resources/activemq/server0/broker.xml | 5 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../features/standard/broker-plugin/pom.xml | 18 +- .../features/standard/broker-plugin/readme.html | 34 -- .../features/standard/broker-plugin/readme.md | 5 + examples/features/standard/browser/pom.xml | 20 +- examples/features/standard/browser/readme.html | 40 -- examples/features/standard/browser/readme.md | 11 + examples/features/standard/cdi/readme.md | 2 +- .../features/standard/client-kickoff/pom.xml | 20 +- .../standard/client-kickoff/readme.html | 54 --- .../features/standard/client-kickoff/readme.md | 22 ++ .../main/resources/activemq/server0/broker.xml | 7 +- .../standard/consumer-rate-limit/pom.xml | 20 +- .../standard/consumer-rate-limit/readme.html | 47 --- .../standard/consumer-rate-limit/readme.md | 17 + examples/features/standard/dead-letter/pom.xml | 20 +- .../features/standard/dead-letter/readme.html | 66 ---- .../features/standard/dead-letter/readme.md | 32 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../standard/delayed-redelivery/pom.xml | 18 +- .../standard/delayed-redelivery/readme.html | 56 --- .../standard/delayed-redelivery/readme.md | 23 ++ .../jms/example/DelayedRedeliveryExample.java | 2 +- .../main/resources/activemq/server0/broker.xml | 8 +- examples/features/standard/divert/pom.xml | 20 +- examples/features/standard/divert/readme.html | 119 ------ examples/features/standard/divert/readme.md | 82 +++++ .../artemis/jms/example/DivertExample.java | 2 +- .../main/resources/activemq/server0/broker.xml | 15 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../standard/durable-subscription/pom.xml | 20 +- .../standard/durable-subscription/readme.html | 39 -- .../standard/durable-subscription/readme.md | 9 + .../main/resources/activemq/server0/broker.xml | 8 +- .../features/standard/embedded-simple/pom.xml | 20 +- .../standard/embedded-simple/readme.html | 35 -- .../features/standard/embedded-simple/readme.md | 9 + .../src/main/resources/broker.xml | 5 +- examples/features/standard/embedded/pom.xml | 20 +- examples/features/standard/embedded/readme.html | 36 -- examples/features/standard/embedded/readme.md | 9 + examples/features/standard/expiry/pom.xml | 20 +- examples/features/standard/expiry/readme.html | 61 ---- examples/features/standard/expiry/readme.md | 17 + .../main/resources/activemq/server0/broker.xml | 8 +- .../features/standard/http-transport/pom.xml | 20 +- .../standard/http-transport/readme.html | 52 --- .../features/standard/http-transport/readme.md | 9 + .../jms/example/HttpTransportExample.java | 23 +- .../main/resources/activemq/server0/broker.xml | 8 +- .../src/main/resources/jndi.properties | 20 + .../instantiate-connection-factory/pom.xml | 20 +- .../instantiate-connection-factory/readme.html | 49 --- .../features/standard/interceptor-amqp/pom.xml | 137 +++++++ .../standard/interceptor-amqp/readme.md | 21 ++ .../amqp/example/InterceptorExample.java | 47 +++ .../amqp/example/SimpleAmqpInterceptor.java | 37 ++ .../main/resources/activemq/server0/broker.xml | 53 +++ .../standard/interceptor-client-amqp/pom.xml | 121 ------- .../interceptor-client-amqp/readme.html | 71 ---- .../amqp/example/InterceptorExample.java | 47 --- .../amqp/example/SimpleAmqpInterceptor.java | 37 -- .../main/resources/activemq/server0/broker.xml | 176 --------- .../standard/interceptor-client-mqtt/pom.xml | 120 ------ .../interceptor-client-mqtt/readme.html | 71 ---- .../mqtt/example/InterceptorExample.java | 62 ---- .../mqtt/example/SimpleMQTTInterceptor.java | 68 ---- .../main/resources/activemq/server0/broker.xml | 180 --------- .../standard/interceptor-client/pom.xml | 22 +- .../standard/interceptor-client/readme.html | 72 ---- .../standard/interceptor-client/readme.md | 13 + .../artemis/jms/example/InterceptorExample.java | 2 +- .../features/standard/interceptor-mqtt/pom.xml | 136 +++++++ .../standard/interceptor-mqtt/readme.md | 21 ++ .../mqtt/example/InterceptorExample.java | 62 ++++ .../mqtt/example/SimpleMQTTInterceptor.java | 63 ++++ .../main/resources/activemq/server0/broker.xml | 56 +++ examples/features/standard/interceptor/pom.xml | 20 +- .../features/standard/interceptor/readme.html | 72 ---- .../features/standard/interceptor/readme.md | 21 ++ .../main/resources/activemq/server0/broker.xml | 9 +- .../standard/jms-auto-closeable/pom.xml | 20 +- .../standard/jms-auto-closeable/readme.html | 96 ----- .../standard/jms-auto-closeable/readme.md | 7 + examples/features/standard/jms-bridge/pom.xml | 20 +- .../features/standard/jms-bridge/readme.html | 246 ------------- examples/features/standard/jms-bridge/readme.md | 24 ++ .../artemis/jms/example/JMSBridgeExample.java | 2 +- .../main/resources/activemq/server0/broker.xml | 10 +- .../main/resources/activemq/server1/broker.xml | 8 +- .../standard/jms-completion-listener/pom.xml | 20 +- .../jms-completion-listener/readme.html | 112 ------ .../standard/jms-completion-listener/readme.md | 5 + examples/features/standard/jms-context/pom.xml | 20 +- .../features/standard/jms-context/readme.html | 35 -- .../features/standard/jms-context/readme.md | 7 + .../standard/jms-shared-consumer/pom.xml | 20 +- .../standard/jms-shared-consumer/readme.html | 119 ------ .../standard/jms-shared-consumer/readme.md | 5 + .../main/resources/activemq/server0/broker.xml | 8 +- examples/features/standard/jmx-ssl/pom.xml | 20 +- examples/features/standard/jmx-ssl/readme.html | 176 --------- examples/features/standard/jmx-ssl/readme.md | 23 ++ .../main/resources/activemq/server0/broker.xml | 8 +- examples/features/standard/jmx/pom.xml | 20 +- examples/features/standard/jmx/readme.html | 176 --------- examples/features/standard/jmx/readme.md | 9 + .../main/resources/activemq/server0/broker.xml | 8 +- .../features/standard/large-message/pom.xml | 20 +- .../features/standard/large-message/readme.html | 200 ---------- .../features/standard/large-message/readme.md | 25 ++ .../features/standard/last-value-queue/pom.xml | 20 +- .../standard/last-value-queue/readme.html | 162 --------- .../standard/last-value-queue/readme.md | 15 + .../main/resources/activemq/server0/broker.xml | 8 +- .../standard/management-notifications/pom.xml | 20 +- .../management-notifications/readme.html | 215 ----------- .../standard/management-notifications/readme.md | 26 ++ .../main/resources/activemq/server0/broker.xml | 8 +- examples/features/standard/management/pom.xml | 20 +- .../features/standard/management/readme.html | 208 ----------- examples/features/standard/management/readme.md | 19 + .../main/resources/activemq/server0/broker.xml | 8 +- .../features/standard/message-counters/pom.xml | 20 +- .../standard/message-counters/readme.html | 197 ---------- .../standard/message-counters/readme.md | 23 ++ .../main/resources/activemq/server0/broker.xml | 8 +- .../features/standard/message-group/pom.xml | 20 +- .../features/standard/message-group/readme.html | 152 -------- .../features/standard/message-group/readme.md | 14 + .../features/standard/message-group2/pom.xml | 20 +- .../standard/message-group2/readme.html | 161 --------- .../features/standard/message-group2/readme.md | 14 + .../features/standard/message-priority/pom.xml | 20 +- .../standard/message-priority/readme.html | 159 -------- .../standard/message-priority/readme.md | 9 + .../standard/no-consumer-buffering/pom.xml | 19 +- .../standard/no-consumer-buffering/readme.html | 205 ----------- .../standard/no-consumer-buffering/readme.md | 29 ++ examples/features/standard/paging/pom.xml | 20 +- examples/features/standard/paging/readme.html | 187 ---------- examples/features/standard/paging/readme.md | 11 + .../main/resources/activemq/server0/broker.xml | 8 +- examples/features/standard/pom.xml | 8 +- .../features/standard/pre-acknowledge/pom.xml | 20 +- .../standard/pre-acknowledge/readme.html | 154 -------- .../features/standard/pre-acknowledge/readme.md | 15 + .../jms/example/PreacknowledgeExample.java | 2 +- .../main/resources/activemq/server0/broker.xml | 8 +- .../standard/producer-rate-limit/pom.xml | 20 +- .../standard/producer-rate-limit/readme.html | 176 --------- .../standard/producer-rate-limit/readme.md | 15 + .../features/standard/queue-requestor/pom.xml | 20 +- .../standard/queue-requestor/readme.html | 46 --- .../features/standard/queue-requestor/readme.md | 14 + .../main/resources/activemq/server0/broker.xml | 8 +- .../features/standard/queue-selector/pom.xml | 20 +- .../standard/queue-selector/readme.html | 52 --- .../features/standard/queue-selector/readme.md | 11 + examples/features/standard/queue/pom.xml | 20 +- examples/features/standard/queue/readme.html | 38 -- examples/features/standard/queue/readme.md | 11 + .../features/standard/reattach-node/pom.xml | 20 +- .../features/standard/reattach-node/readme.html | 55 --- .../features/standard/reattach-node/readme.md | 19 + .../main/resources/activemq/server0/broker.xml | 8 +- .../features/standard/request-reply/pom.xml | 19 +- .../features/standard/request-reply/readme.html | 180 --------- .../features/standard/request-reply/readme.md | 9 + .../features/standard/rest/dup-send/README.txt | 41 --- .../features/standard/rest/dup-send/pom.xml | 119 +++--- .../features/standard/rest/dup-send/readme.md | 41 +++ .../rest/dup-send/src/main/resources/broker.xml | 6 +- .../standard/rest/javascript-chat/README.txt | 16 - .../standard/rest/javascript-chat/pom.xml | 119 +++--- .../standard/rest/javascript-chat/readme.md | 15 + .../src/main/resources/broker.xml | 6 +- .../standard/rest/jms-to-rest/README.txt | 49 --- .../features/standard/rest/jms-to-rest/pom.xml | 117 +++--- .../standard/rest/jms-to-rest/readme.md | 49 +++ .../jms-to-rest/src/main/resources/broker.xml | 6 +- examples/features/standard/rest/push/README.txt | 32 -- examples/features/standard/rest/push/pom.xml | 122 ++++--- examples/features/standard/rest/push/readme.md | 32 ++ .../rest/push/src/main/resources/broker.xml | 8 +- .../features/standard/scheduled-message/pom.xml | 20 +- .../standard/scheduled-message/readme.html | 134 ------- .../standard/scheduled-message/readme.md | 9 + .../features/standard/security-ldap/pom.xml | 20 +- .../features/standard/security-ldap/readme.html | 361 ------------------- .../features/standard/security-ldap/readme.md | 121 +++++++ .../main/resources/activemq/server0/broker.xml | 8 +- examples/features/standard/security/pom.xml | 20 +- examples/features/standard/security/readme.html | 315 ---------------- examples/features/standard/security/readme.md | 68 ++++ .../main/resources/activemq/server0/broker.xml | 5 +- .../standard/send-acknowledgements/pom.xml | 20 +- .../standard/send-acknowledgements/readme.html | 140 ------- .../standard/send-acknowledgements/readme.md | 9 + .../example/SendAcknowledgementsExample.java | 2 +- .../standard/spring-integration/pom.xml | 20 +- .../standard/spring-integration/readme.html | 36 -- .../standard/spring-integration/readme.md | 5 + .../src/main/resources/broker.xml | 8 +- .../ssl-enabled-dual-authentication/pom.xml | 20 +- .../ssl-enabled-dual-authentication/readme.html | 75 ---- .../ssl-enabled-dual-authentication/readme.md | 26 ++ .../main/resources/activemq/server0/broker.xml | 10 +- examples/features/standard/ssl-enabled/pom.xml | 20 +- .../features/standard/ssl-enabled/readme.html | 56 --- .../features/standard/ssl-enabled/readme.md | 15 + .../activemq/server0/activemq.example.keystore | Bin 1273 -> 2251 bytes .../server0/activemq.example.truststore | Bin 866 -> 963 bytes .../main/resources/activemq/server0/broker.xml | 11 +- .../features/standard/static-selector/pom.xml | 20 +- .../standard/static-selector/readme.html | 60 --- .../features/standard/static-selector/readme.md | 11 + .../main/resources/activemq/server0/broker.xml | 8 +- examples/features/standard/temp-queue/pom.xml | 18 +- .../features/standard/temp-queue/readme.html | 40 -- examples/features/standard/temp-queue/readme.md | 7 + .../main/resources/activemq/server0/broker.xml | 8 +- .../features/standard/topic-hierarchies/pom.xml | 20 +- .../standard/topic-hierarchies/readme.html | 42 --- .../standard/topic-hierarchies/readme.md | 11 + .../jms/example/TopicHierarchyExample.java | 2 +- .../standard/topic-selector-example1/pom.xml | 20 +- .../topic-selector-example1/readme.html | 38 -- .../standard/topic-selector-example1/readme.md | 9 + .../main/resources/activemq/server0/broker.xml | 8 +- .../standard/topic-selector-example2/pom.xml | 20 +- .../topic-selector-example2/readme.html | 47 --- .../standard/topic-selector-example2/readme.md | 9 + .../main/resources/activemq/server0/broker.xml | 8 +- examples/features/standard/topic/pom.xml | 19 +- examples/features/standard/topic/readme.html | 36 -- examples/features/standard/topic/readme.md | 9 + .../main/resources/activemq/server0/broker.xml | 8 +- .../features/standard/transactional/pom.xml | 20 +- .../features/standard/transactional/readme.html | 40 -- .../features/standard/transactional/readme.md | 9 + examples/features/standard/xa-heuristic/pom.xml | 20 +- .../features/standard/xa-heuristic/readme.html | 48 --- .../features/standard/xa-heuristic/readme.md | 11 + examples/features/standard/xa-receive/pom.xml | 20 +- .../features/standard/xa-receive/readme.html | 48 --- examples/features/standard/xa-receive/readme.md | 9 + examples/features/standard/xa-send/pom.xml | 20 +- examples/features/standard/xa-send/readme.html | 215 ----------- examples/features/standard/xa-send/readme.md | 9 + .../features/sub-modules/artemis-ra-rar/pom.xml | 20 +- .../artemis-jms-bridge/README.md | 147 -------- .../artemis-jms-bridge/pom.xml | 20 +- .../artemis-jms-bridge/readme.md | 147 ++++++++ examples/perf/jmeter/README.md | 45 --- examples/perf/jmeter/readme.md | 33 ++ examples/pom.xml | 47 +++ .../protocols/amqp/proton-clustered-cpp/pom.xml | 21 +- .../amqp/proton-clustered-cpp/readme.html | 61 ---- .../amqp/proton-clustered-cpp/readme.md | 32 ++ .../artemis/jms/example/ProtonCPPExample.java | 2 +- .../main/resources/activemq/server0/broker.xml | 5 +- .../main/resources/activemq/server1/broker.xml | 5 +- examples/protocols/amqp/proton-cpp/pom.xml | 20 +- examples/protocols/amqp/proton-cpp/readme.html | 120 ------ examples/protocols/amqp/proton-cpp/readme.md | 80 ++++ .../artemis/jms/example/ProtonCPPExample.java | 2 +- examples/protocols/amqp/proton-ruby/pom.xml | 20 +- examples/protocols/amqp/proton-ruby/readme.html | 51 --- examples/protocols/amqp/proton-ruby/readme.md | 25 ++ .../main/resources/activemq/server0/broker.xml | 8 +- examples/protocols/amqp/queue/pom.xml | 20 +- examples/protocols/amqp/queue/readme.html | 46 --- examples/protocols/amqp/queue/readme.md | 17 + examples/protocols/mqtt/basic-pubsub/pom.xml | 20 +- .../protocols/mqtt/basic-pubsub/readme.html | 136 ------- examples/protocols/mqtt/basic-pubsub/readme.md | 69 ++++ .../protocols/mqtt/clustered-queue-mqtt/pom.xml | 20 +- .../mqtt/clustered-queue-mqtt/readme.html | 55 --- .../mqtt/clustered-queue-mqtt/readme.md | 11 + .../jms/example/ClusteredQueueMQTTExample.java | 3 +- .../main/resources/activemq/server0/broker.xml | 3 +- .../main/resources/activemq/server1/broker.xml | 3 +- examples/protocols/openwire/chat/pom.xml | 21 ++ examples/protocols/openwire/chat/readme.html | 53 --- examples/protocols/openwire/chat/readme.md | 33 ++ .../protocols/openwire/message-listener/pom.xml | 20 +- .../openwire/message-listener/readme.html | 35 -- .../openwire/message-listener/readme.md | 5 + .../protocols/openwire/message-recovery/pom.xml | 20 +- .../openwire/message-recovery/readme.html | 35 -- .../openwire/message-recovery/readme.md | 5 + examples/protocols/openwire/queue/pom.xml | 20 +- examples/protocols/openwire/queue/readme.html | 39 -- examples/protocols/openwire/queue/readme.md | 13 + examples/protocols/stomp/pom.xml | 2 + .../stomp/stomp-dual-authentication/pom.xml | 24 +- .../stomp/stomp-dual-authentication/readme.html | 51 --- .../stomp/stomp-dual-authentication/readme.md | 14 + .../main/resources/activemq/server0/broker.xml | 8 +- .../stomp/stomp-embedded-interceptor/pom.xml | 20 +- .../stomp-embedded-interceptor/readme.html | 37 -- .../stomp/stomp-embedded-interceptor/readme.md | 7 + .../main/resources/activemq/server0/broker.xml | 8 +- examples/protocols/stomp/stomp-jms/pom.xml | 20 +- examples/protocols/stomp/stomp-jms/readme.html | 37 -- examples/protocols/stomp/stomp-jms/readme.md | 5 + .../protocols/stomp/stomp-websockets/pom.xml | 20 +- .../stomp/stomp-websockets/readme.html | 55 --- .../protocols/stomp/stomp-websockets/readme.md | 17 + examples/protocols/stomp/stomp/pom.xml | 22 +- examples/protocols/stomp/stomp/readme.html | 38 -- examples/protocols/stomp/stomp/readme.md | 7 + examples/protocols/stomp/stomp1.1/pom.xml | 22 +- examples/protocols/stomp/stomp1.1/readme.html | 38 -- examples/protocols/stomp/stomp1.1/readme.md | 7 + examples/protocols/stomp/stomp1.2/pom.xml | 22 +- examples/protocols/stomp/stomp1.2/readme.html | 38 -- examples/protocols/stomp/stomp1.2/readme.md | 7 + pom.xml | 1 + 458 files changed, 5449 insertions(+), 11008 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/.gitignore ---------------------------------------------------------------------- diff --git a/.gitignore b/.gitignore index 9661e9c..3727d45 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,7 @@ ratReport.txt .factorypath **/.editorconfig **/derby.log +examples/**/readme.html # for native build CMakeCache.txt http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/artemis-distribution/src/main/assembly/dep.xml ---------------------------------------------------------------------- diff --git a/artemis-distribution/src/main/assembly/dep.xml b/artemis-distribution/src/main/assembly/dep.xml index 229017f..6670582 100644 --- a/artemis-distribution/src/main/assembly/dep.xml +++ b/artemis-distribution/src/main/assembly/dep.xml @@ -220,6 +220,7 @@ <exclude>**/target/**</exclude> <exclude>**/**/*.iml</exclude> <exclude>**/**/*.dat</exclude> + <exclude>**/**/*.md</exclude> </excludes> </fileSet> <!-- Include license and notice files --> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/common/footer.html ---------------------------------------------------------------------- diff --git a/examples/common/footer.html b/examples/common/footer.html new file mode 100644 index 0000000..691287b --- /dev/null +++ b/examples/common/footer.html @@ -0,0 +1,2 @@ +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/common/header.html ---------------------------------------------------------------------- diff --git a/examples/common/header.html b/examples/common/header.html new file mode 100644 index 0000000..f2229f5 --- /dev/null +++ b/examples/common/header.html @@ -0,0 +1,27 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +<html> +<head> + <title>ActiveMQ Artemis Example</title> + <link rel="stylesheet" type="text/css" href="../../../common/common.css" /> + <link rel="stylesheet" type="text/css" href="../../../common/prettify.css" /> + <script type="text/javascript" src="../../../common/prettify.js"></script> +</head> +<body onload="prettyPrint()"> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/client-side-load-balancing/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/client-side-load-balancing/pom.xml b/examples/features/clustered/client-side-load-balancing/pom.xml index 14b8715..b352321 100644 --- a/examples/features/clustered/client-side-load-balancing/pom.xml +++ b/examples/features/clustered/client-side-load-balancing/pom.xml @@ -197,7 +197,23 @@ under the License. </dependency> </dependencies> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-clean-plugin</artifactId> + </plugin> </plugins> </build> - + <profiles> + <profile> + <id>release</id> + <build> + <plugins> + <plugin> + <groupId>com.vladsch.flexmark</groupId> + <artifactId>markdown-page-generator-plugin</artifactId> + </plugin> + </plugins> + </build> + </profile> + </profiles> </project> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/client-side-load-balancing/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/clustered/client-side-load-balancing/readme.html b/examples/features/clustered/client-side-load-balancing/readme.html deleted file mode 100644 index 9d3aba5..0000000 --- a/examples/features/clustered/client-side-load-balancing/readme.html +++ /dev/null @@ -1,49 +0,0 @@ -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -<html> - <head> - <title>ActiveMQ Artemis JMS Client-Side Load-Balancing Example</title> - <link rel="stylesheet" type="text/css" href="../../../common/common.css" /> - <link rel="stylesheet" type="text/css" href="../../../common/prettify.css" /> - <script type="text/javascript" src="../../../common/prettify.js"></script> - </head> - <body onload="prettyPrint()"> - <h1>JMS Client-Side Load-Balancing Example</h1> - <pre>To run the example, simply type <b>mvn verify</b> from this directory, <br>or <b>mvn -PnoServer verify</b> if you want to start and create the server manually.</pre> - - <p>This example demonstrates how connnections created from a single JMS Connection factory can be created - to different nodes of the cluster. In other words it demonstrates how ActiveMQ Artemis does <b>client side load balancing</b> of - connections across the cluster.</p> - <p>The particular load-balancing policy can be chosen to be random, round-robin or user-defined. Please see the user - guide for more details of how to configure the specific load-balancing policy. In this example we will use - the default round-robin load balancing policy.</p> - <p>The list of servers over which ActiveMQ Artemis will round-robin the connections can either be specified explicitly - in the connection factory when instantiating it directly, when configuring it on the server or configured - to use UDP discovery to discover the list of servers over which to round-robin. This example will use UDP - discovery to obtain the list.</p> - <p>This example starts three servers which all broadcast their location using UDP discovery. The UDP broadcast configuration - can be seen in the <code>broker.xml</code> file.</p> - <p>A JMS ConnectionFactory is deployed on each server specifying the discovery group that will be used by that - connection factory.</p> - <p>For more information on ActiveMQ Artemis load balancing, and clustering in general, please see the clustering - section of the user manual.</p> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/client-side-load-balancing/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/clustered/client-side-load-balancing/readme.md b/examples/features/clustered/client-side-load-balancing/readme.md new file mode 100644 index 0000000..6b66fbd --- /dev/null +++ b/examples/features/clustered/client-side-load-balancing/readme.md @@ -0,0 +1,15 @@ +# JMS Client-Side Load-Balancing Example + +To run the example, simply type **mvn verify** from this directory, or **mvn -PnoServer verify** if you want to create and start the broker manually. + +This example demonstrates how connections created from a single JMS Connection factory can be created to different nodes of the cluster. In other words it demonstrates how ActiveMQ Artemis does **client side load balancing** of connections across the cluster. + +The particular load-balancing policy can be chosen to be random, round-robin or user-defined. Please see the user guide for more details of how to configure the specific load-balancing policy. In this example we will use the default round-robin load balancing policy. + +The list of servers over which ActiveMQ Artemis will round-robin the connections can either be specified explicitly in the connection factory when instantiating it directly, when configuring it on the broker or configured to use UDP discovery to discover the list of servers over which to round-robin. This example will use UDP discovery to obtain the list. + +This example starts three servers which all broadcast their location using UDP discovery. The UDP broadcast configuration can be seen in the `broker.xml` file. + +A JMS ConnectionFactory is deployed on each broker specifying the discovery group that will be used by that connection factory. + +For more information on ActiveMQ Artemis load balancing, and clustering in general, please see the clustering section of the user manual. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-durable-subscription/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-durable-subscription/pom.xml b/examples/features/clustered/clustered-durable-subscription/pom.xml index 4dfdb3d..3a2b628 100644 --- a/examples/features/clustered/clustered-durable-subscription/pom.xml +++ b/examples/features/clustered/clustered-durable-subscription/pom.xml @@ -155,7 +155,23 @@ under the License. </dependency> </dependencies> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-clean-plugin</artifactId> + </plugin> </plugins> </build> - -</project> + <profiles> + <profile> + <id>release</id> + <build> + <plugins> + <plugin> + <groupId>com.vladsch.flexmark</groupId> + <artifactId>markdown-page-generator-plugin</artifactId> + </plugin> + </plugins> + </build> + </profile> + </profiles> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-durable-subscription/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-durable-subscription/readme.html b/examples/features/clustered/clustered-durable-subscription/readme.html deleted file mode 100644 index c0a7b2e..0000000 --- a/examples/features/clustered/clustered-durable-subscription/readme.html +++ /dev/null @@ -1,65 +0,0 @@ -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -<html> - <head> - <title>ActiveMQ Artemis JMS Durable Subscription Example</title> - <link rel="stylesheet" type="text/css" href="../../../common/common.css" /> - <link rel="stylesheet" type="text/css" href="../../../common/prettify.css" /> - <script type="text/javascript" src="../../../common/prettify.js"></script> - </head> - <body onload="prettyPrint()"> - <h1>JMS Durable Subscription Example</h1> - - <pre>To run the example, simply type <b>mvn verify</b> from this directory, <br>or <b>mvn -PnoServer verify</b> if you want to start and create the server manually.</pre> - - <p>This example demonstrates a clustered JMS durable subscription. - Normally durable subscriptions exist on a single node and can only have one subscriber at any one time, - however, with ActiveMQ Artemis it's possible to create durable subscription instances with the same name and client-id - on different nodes of the cluster, and consume from them simultaneously. - This allows the work of processing messages from a durable subscription to be spread across the cluster in - a similar way to how JMS Queues can be load balanced across the cluster - </p> - <p>In this example we first configure the two nodes to form a cluster, then we then create a durable subscriber - with the same name and client-id on both nodes, and we create a producer on only one of the nodes.</p> - <p>We then send some messages via the producer, and we verify that the messages are round robin'd between - the two subscription instances. Note that each durable subscription instance with the same name and client-id - <b>does not</b> receive its own copy of the messages. This is because the instances on different nodes form a - single "logical" durable subscription, in the same way multiple JMS Queue instances on different nodes - form a single "local" JMS Queue</p> - <p>This example uses JNDI to lookup the JMS Queue and ConnectionFactory objects. If you prefer not to use - JNDI, these could be instantiated directly. - <p>Here's the relevant snippet from the server configuration, which tells the server to form a cluster between the two nodes - and to load balance the messages between the nodes.</p> - <p>The cli create method will define this section by default if you use --clustered as a parameter</p> - <pre class="prettyprint"> - <code><cluster-connection name="my-cluster"> - <retry-interval>500</retry-interval> - <use-duplicate-detection>true</use-duplicate-detection> - <message-load-balancing>STRICT</message-load-balancing> - <max-hops>1</max-hops> - <discovery-group-ref discovery-group-name="my-discovery-group"/> - </cluster-connection> - </code> - </pre> - <p>For more information on ActiveMQ Artemis load balancing, and clustering in general, please see the clustering - section of the user manual.</p> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-durable-subscription/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-durable-subscription/readme.md b/examples/features/clustered/clustered-durable-subscription/readme.md new file mode 100644 index 0000000..dd82ec7 --- /dev/null +++ b/examples/features/clustered/clustered-durable-subscription/readme.md @@ -0,0 +1,25 @@ +# JMS Clustered Durable Subscription Example + +To run the example, simply type **mvn verify** from this directory, or **mvn -PnoServer verify** if you want to start and create the broker manually. + +This example demonstrates a clustered JMS durable subscription. Normally durable subscriptions exist on a single node and can only have one subscriber at any one time, however, with ActiveMQ Artemis it's possible to create durable subscription instances with the same name and client-id on different nodes of the cluster, and consume from them simultaneously. This allows the work of processing messages from a durable subscription to be spread across the cluster in a similar way to how JMS Queues can be load balanced across the cluster + +In this example we first configure the two nodes to form a cluster, then we then create a durable subscriber with the same name and client-id on both nodes, and we create a producer on only one of the nodes. + +We then send some messages via the producer, and we verify that the messages are round robin'd between the two subscription instances. Note that each durable subscription instance with the same name and client-id **does not** receive its own copy of the messages. This is because the instances on different nodes form a single "logical" durable subscription, in the same way multiple JMS Queue instances on different nodes form a single "local" JMS Queue + +This example uses JNDI to lookup the JMS Queue and ConnectionFactory objects. If you prefer not to use JNDI, these could be instantiated directly. + +Here's the relevant snippet from the broker configuration, which tells the broker to form a cluster between the two nodes and to load balance the messages between the nodes. + +The cli create method will define a similar section by default if you use `--clustered` as a parameter + + <cluster-connection name="my-cluster"> + <retry-interval>500</retry-interval> + <use-duplicate-detection>true</use-duplicate-detection> + <message-load-balancing>STRICT</message-load-balancing> + <max-hops>1</max-hops> + <discovery-group-ref discovery-group-name="my-discovery-group"/> + </cluster-connection> + +For more information on ActiveMQ Artemis load balancing, and clustering in general, please see the "Clusters" chapter of the user manual. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-durable-subscription/src/main/resources/activemq/server0/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-durable-subscription/src/main/resources/activemq/server0/broker.xml b/examples/features/clustered/clustered-durable-subscription/src/main/resources/activemq/server0/broker.xml index 42464b5..4b86dad 100644 --- a/examples/features/clustered/clustered-durable-subscription/src/main/resources/activemq/server0/broker.xml +++ b/examples/features/clustered/clustered-durable-subscription/src/main/resources/activemq/server0/broker.xml @@ -16,10 +16,8 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---><configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - - - +--> +<configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> <core xmlns="urn:activemq:core"> <bindings-directory>./data/bindings</bindings-directory> @@ -84,7 +82,7 @@ under the License. </security-setting> </security-settings> - <addresses> + <addresses> <address name="exampleTopic"> <multicast/> </address> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-durable-subscription/src/main/resources/activemq/server1/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-durable-subscription/src/main/resources/activemq/server1/broker.xml b/examples/features/clustered/clustered-durable-subscription/src/main/resources/activemq/server1/broker.xml index 969a7a2..e22a8ce 100644 --- a/examples/features/clustered/clustered-durable-subscription/src/main/resources/activemq/server1/broker.xml +++ b/examples/features/clustered/clustered-durable-subscription/src/main/resources/activemq/server1/broker.xml @@ -16,10 +16,8 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---><configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - - - +--> +<configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> <core xmlns="urn:activemq:core"> <bindings-directory>./data/bindings</bindings-directory> @@ -84,7 +82,7 @@ under the License. </security-settings> - <addresses> + <addresses> <address name="exampleTopic"> <multicast/> </address> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-grouping/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-grouping/pom.xml b/examples/features/clustered/clustered-grouping/pom.xml index 61293f9..aa02e52 100644 --- a/examples/features/clustered/clustered-grouping/pom.xml +++ b/examples/features/clustered/clustered-grouping/pom.xml @@ -29,7 +29,7 @@ under the License. <artifactId>clustered-grouping</artifactId> <packaging>jar</packaging> - <name>ActiveMQ Artemis JMS CLustered Grouping Example</name> + <name>ActiveMQ Artemis JMS Clustered Grouping Example</name> <properties> <activemq.basedir>${project.basedir}/../../../..</activemq.basedir> @@ -193,7 +193,23 @@ under the License. </dependency> </dependencies> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-clean-plugin</artifactId> + </plugin> </plugins> </build> - -</project> + <profiles> + <profile> + <id>release</id> + <build> + <plugins> + <plugin> + <groupId>com.vladsch.flexmark</groupId> + <artifactId>markdown-page-generator-plugin</artifactId> + </plugin> + </plugins> + </build> + </profile> + </profiles> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-grouping/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-grouping/readme.html b/examples/features/clustered/clustered-grouping/readme.html deleted file mode 100644 index e066ca9..0000000 --- a/examples/features/clustered/clustered-grouping/readme.html +++ /dev/null @@ -1,79 +0,0 @@ -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -<html> - <head> - <title>ActiveMQ Artemis JMS Clustered Grouping Example</title> - <link rel="stylesheet" type="text/css" href="../../../common/common.css"> - </head> - <body> - <h1>JMS Clustered Grouping Example</h1> - - <pre>To run the example, simply type <b>mvn verify</b> from this directory, <br>or <b>mvn -PnoServer verify</b> if you want to start and create the server manually.</pre> - - <p>This example demonstrates how to ensure strict ordering across a cluster using clustered message grouping</p> - <p>We create 3 nodes each with a grouping message handler, one with a Local handler and 2 with a Remote handler.</p> - <p>The local handler acts as an arbitrator for the 2 remote handlers, holding the information on routes and communicating - the routing info with the remote handlers on the other 2 nodes</p> - <p>We then send some messages to each node with the same group id set and ensure the same consumer receives all of them</p> - <p>Here's the relevant snippet from the server configuration that has the local handler</p> - <pre> - <code> - <cluster-connections> - <cluster-connection name="my-cluster"> - <connector-ref>netty-connector</connector-ref> - <retry-interval>500</retry-interval> - <use-duplicate-detection>true</use-duplicate-detection> - <message-load-balancing>STRICT</message-load-balancing> - <max-hops>1</max-hops> - <discovery-group-ref discovery-group-name="my-discovery-group"/> - </cluster-connection> - </cluster-connections> - - <grouping-handler name="my-grouping-handler"> - <type>LOCAL</type> - <address>jms</address> - <timeout>5000</timeout> - </grouping-handler> - </code> - </pre> - - <p>Here's the relevant snippet from the server configuration that has the remote handlers</p> - <pre> - <code> - <cluster-connections> - <cluster-connection name="my-cluster"> - <retry-interval>500</retry-interval> - <use-duplicate-detection>true</use-duplicate-detection> - <message-load-balancing>STRICT</message-load-balancing> - <max-hops>1</max-hops> - <discovery-group-ref discovery-group-name="my-discovery-group"/> - </cluster-connection> - </cluster-connections> - - <grouping-handler name="my-grouping-handler"> - <type>REMOTE</type> - <address>jms</address> - <timeout>5000</timeout> - </grouping-handler> - </code> - </pre> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-grouping/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-grouping/readme.md b/examples/features/clustered/clustered-grouping/readme.md new file mode 100644 index 0000000..e8eb9d0 --- /dev/null +++ b/examples/features/clustered/clustered-grouping/readme.md @@ -0,0 +1,48 @@ +# JMS Clustered Grouping Example + +To run the example, simply type **mvn verify** from this directory, or **mvn -PnoServer verify** if you want to start and create the broker manually. + +This example demonstrates how to ensure strict ordering across a cluster using clustered message grouping + +We create 3 nodes each with a grouping message handler, one with a Local handler and 2 with a Remote handler. + +The local handler acts as an arbitrator for the 2 remote handlers, holding the information on routes and communicating the routing info with the remote handlers on the other 2 nodes + +We then send some messages to each node with the same group id set and ensure the same consumer receives all of them + +Here's the relevant snippet from the broker configuration that has the local handler + + <cluster-connections> + <cluster-connection name="my-cluster"> + <connector-ref>netty-connector</connector-ref> + <retry-interval>500</retry-interval> + <use-duplicate-detection>true</use-duplicate-detection> + <message-load-balancing>STRICT</message-load-balancing> + <max-hops>1</max-hops> + <discovery-group-ref discovery-group-name="my-discovery-group"/> + </cluster-connection> + </cluster-connections> + + <grouping-handler name="my-grouping-handler"> + <type>LOCAL</type> + <address>jms</address> + <timeout>5000</timeout> + </grouping-handler> + +Here's the relevant snippet from the broker configuration that has the remote handlers + + <cluster-connections> + <cluster-connection name="my-cluster"> + <retry-interval>500</retry-interval> + <use-duplicate-detection>true</use-duplicate-detection> + <message-load-balancing>STRICT</message-load-balancing> + <max-hops>1</max-hops> + <discovery-group-ref discovery-group-name="my-discovery-group"/> + </cluster-connection> + </cluster-connections> + + <grouping-handler name="my-grouping-handler"> + <type>REMOTE</type> + <address>jms</address> + <timeout>5000</timeout> + </grouping-handler> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server0/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server0/broker.xml b/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server0/broker.xml index 26c8467..9ee69f5 100644 --- a/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server0/broker.xml +++ b/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server0/broker.xml @@ -16,10 +16,8 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---><configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - - - +--> +<configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> <core xmlns="urn:activemq:core"> <bindings-directory>./data/bindings</bindings-directory> @@ -93,7 +91,7 @@ under the License. </security-setting> </security-settings> - <addresses> + <addresses> <address name="exampleQueue"> <anycast> <queue name="exampleQueue"/> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server1/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server1/broker.xml b/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server1/broker.xml index 3641e8e..fa926f7 100644 --- a/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server1/broker.xml +++ b/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server1/broker.xml @@ -16,10 +16,8 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---><configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - - - +--> +<configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> <core xmlns="urn:activemq:core"> <bindings-directory>./data/bindings</bindings-directory> @@ -90,7 +88,7 @@ under the License. </security-setting> </security-settings> - <addresses> + <addresses> <address name="exampleQueue"> <anycast> <queue name="exampleQueue"/> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server2/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server2/broker.xml b/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server2/broker.xml index 864c240..e0494d8 100644 --- a/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server2/broker.xml +++ b/examples/features/clustered/clustered-grouping/src/main/resources/activemq/server2/broker.xml @@ -16,10 +16,8 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---><configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - - - +--> +<configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> <core xmlns="urn:activemq:core"> <bindings-directory>./data/bindings</bindings-directory> @@ -90,7 +88,7 @@ under the License. </security-setting> </security-settings> - <addresses> + <addresses> <address name="exampleQueue"> <anycast> <queue name="exampleQueue"/> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-jgroups/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-jgroups/pom.xml b/examples/features/clustered/clustered-jgroups/pom.xml index 8a8a1c2..1e0c6eb 100644 --- a/examples/features/clustered/clustered-jgroups/pom.xml +++ b/examples/features/clustered/clustered-jgroups/pom.xml @@ -158,7 +158,23 @@ under the License. </dependency> </dependencies> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-clean-plugin</artifactId> + </plugin> </plugins> </build> - + <profiles> + <profile> + <id>release</id> + <build> + <plugins> + <plugin> + <groupId>com.vladsch.flexmark</groupId> + <artifactId>markdown-page-generator-plugin</artifactId> + </plugin> + </plugins> + </build> + </profile> + </profiles> </project> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-jgroups/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-jgroups/readme.html b/examples/features/clustered/clustered-jgroups/readme.html deleted file mode 100644 index 2731997..0000000 --- a/examples/features/clustered/clustered-jgroups/readme.html +++ /dev/null @@ -1,67 +0,0 @@ -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -<html> - <head> - <title>ActiveMQ Artemis Clustering with JGroups Example</title> - <link rel="stylesheet" type="text/css" href="../../../common/common.css" /> - <link rel="stylesheet" type="text/css" href="../../../common/prettify.css" /> - <script type="text/javascript" src="../../../common/prettify.js"></script> - </head> - <body onload="prettyPrint()"> - <h1>ActiveMQ Artemis Clustering with JGroups Example</h1> - - <pre>To run the example, simply type <b>mvn verify</b> from this directory, <br>or <b>mvn -PnoServer verify</b> if you want to start and create the server manually.</pre> - - <p>This example demonstrates the working of a two node cluster using JGroups as the underlying topology broadcasting/discovery - technique.</p> - <p>We deploy a queue on to the cluster, then create a consumer on the queue on each node, and we create a producer on only one of the nodes.</p> - <p>We then send some messages via the producer, and we verify that <b>both</b> consumers receive the sent messages - in a round-robin fashion.</p> - <p>This example uses JNDI to lookup the JMS Queue and ConnectionFactory objects. If you prefer not to use - JNDI, these could be instantiated directly.</p> - <p>To enable ActiveMQ Artemis to use JGroups you need to configure JGroups configuration file and make sure it is on the classpath - by placing in the configuration directory, the file test-jgroups-file_ping.xml is the configuration used in this - exaample</p> - <p>You then configure the jgroups file used by the broadcast and discovery groups in the configuration along with the - channel name which you want this cluster to share.</p> - <pre class="prettyprint"> - <code> - <broadcast-groups> - <broadcast-group name="my-broadcast-group"> - <broadcast-period>5000</broadcast-period> - <jgroups-file>test-jgroups-file_ping.xml</jgroups-file> - <jgroups-channel>activemq_broadcast_channel</jgroups-channel> - <connector-ref>netty-connector</connector-ref> - </broadcast-group> - </broadcast-groups> - - <discovery-groups> - <discovery-group name="my-discovery-group"> - <jgroups-file>test-jgroups-file_ping.xml</jgroups-file> - <jgroups-channel>activemq_broadcast_channel</jgroups-channel> - <refresh-timeout>10000</refresh-timeout> - </discovery-group> - </discovery-groups> - </code> - </pre> - <p>For more information on ActiveMQ Artemis clustering in general, please see the clustering - section of the user manual.</p> - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-jgroups/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-jgroups/readme.md b/examples/features/clustered/clustered-jgroups/readme.md new file mode 100644 index 0000000..9783268 --- /dev/null +++ b/examples/features/clustered/clustered-jgroups/readme.md @@ -0,0 +1,34 @@ +# ActiveMQ Artemis Clustering with JGroups Example + +To run the example, simply type **mvn verify** from this directory, or **mvn -PnoServer verify** if you want to start and create the broker manually. + +This example demonstrates the working of a two node cluster using JGroups as the underlying topology broadcasting/discovery technique. + +We deploy a queue on to the cluster, then create a consumer on the queue on each node, and we create a producer on only one of the nodes. + +We then send some messages via the producer, and we verify that **both** consumers receive the sent messages in a round-robin fashion. + +This example uses JNDI to lookup the JMS Queue and ConnectionFactory objects. If you prefer not to use JNDI, these could be instantiated directly. + +To enable ActiveMQ Artemis to use JGroups you need to configure JGroups configuration file and make sure it is on the classpath by placing in the configuration directory, the file test-jgroups-file_ping.xml is the configuration used in this exaample + +You then configure the jgroups file used by the broadcast and discovery groups in the configuration along with the channel name which you want this cluster to share. + + <broadcast-groups> + <broadcast-group name="my-broadcast-group"> + <broadcast-period>5000</broadcast-period> + <jgroups-file>test-jgroups-file_ping.xml</jgroups-file> + <jgroups-channel>activemq_broadcast_channel</jgroups-channel> + <connector-ref>netty-connector</connector-ref> + </broadcast-group> + </broadcast-groups> + + <discovery-groups> + <discovery-group name="my-discovery-group"> + <jgroups-file>test-jgroups-file_ping.xml</jgroups-file> + <jgroups-channel>activemq_broadcast_channel</jgroups-channel> + <refresh-timeout>10000</refresh-timeout> + </discovery-group> + </discovery-groups> + +For more information on ActiveMQ Artemis clustering in general, please see the "Clusters" chapter of the user manual. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-jgroups/src/main/resources/activemq/server0/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-jgroups/src/main/resources/activemq/server0/broker.xml b/examples/features/clustered/clustered-jgroups/src/main/resources/activemq/server0/broker.xml index cc82b8e..5bb1234 100644 --- a/examples/features/clustered/clustered-jgroups/src/main/resources/activemq/server0/broker.xml +++ b/examples/features/clustered/clustered-jgroups/src/main/resources/activemq/server0/broker.xml @@ -16,10 +16,8 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---><configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - - - +--> +<configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> <core xmlns="urn:activemq:core"> <bindings-directory>./data/bindings</bindings-directory> @@ -85,7 +83,7 @@ under the License. </security-setting> </security-settings> - <addresses> + <addresses> <address name="exampleQueue"> <anycast> <queue name="exampleQueue"/> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-jgroups/src/main/resources/activemq/server1/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-jgroups/src/main/resources/activemq/server1/broker.xml b/examples/features/clustered/clustered-jgroups/src/main/resources/activemq/server1/broker.xml index 8b65e68..5531062 100644 --- a/examples/features/clustered/clustered-jgroups/src/main/resources/activemq/server1/broker.xml +++ b/examples/features/clustered/clustered-jgroups/src/main/resources/activemq/server1/broker.xml @@ -16,10 +16,8 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---><configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - - - +--> +<configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> <core xmlns="urn:activemq:core"> <bindings-directory>./data/bindings</bindings-directory> @@ -84,7 +82,7 @@ under the License. </security-setting> </security-settings> - <addresses> + <addresses> <address name="exampleQueue"> <anycast> <queue name="exampleQueue"/> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-queue/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-queue/pom.xml b/examples/features/clustered/clustered-queue/pom.xml index 5f1f0ed..5953992 100644 --- a/examples/features/clustered/clustered-queue/pom.xml +++ b/examples/features/clustered/clustered-queue/pom.xml @@ -151,7 +151,23 @@ under the License. </dependency> </dependencies> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-clean-plugin</artifactId> + </plugin> </plugins> </build> - -</project> + <profiles> + <profile> + <id>release</id> + <build> + <plugins> + <plugin> + <groupId>com.vladsch.flexmark</groupId> + <artifactId>markdown-page-generator-plugin</artifactId> + </plugin> + </plugins> + </build> + </profile> + </profiles> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-queue/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-queue/readme.html b/examples/features/clustered/clustered-queue/readme.html deleted file mode 100644 index a39fc4c..0000000 --- a/examples/features/clustered/clustered-queue/readme.html +++ /dev/null @@ -1,55 +0,0 @@ -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -<html> - <head> - <title>ActiveMQ Artemis JMS Load Balanced Clustered Queue Example</title> - <link rel="stylesheet" type="text/css" href="../../../common/common.css" /> - <link rel="stylesheet" type="text/css" href="../../../common/prettify.css" /> - <script type="text/javascript" src="../../../common/prettify.js"></script> - </head> - <body onload="prettyPrint()"> - <h1>JMS Load Balanced Clustered Queue Example</h1> - - <pre>To run the example, simply type <b>mvn verify</b> from this directory, <br>or <b>mvn -PnoServer verify</b> if you want to start and create the server manually.</pre> - - <p>This example demonstrates a JMS queue deployed on two different nodes. The two nodes are configured to form a cluster.</p> - <p>We then create a consumer on the queue on each node, and we create a producer on only one of the nodes.</p> - <p>We then send some messages via the producer, and we verify that <b>both</b> consumers receive the sent messages - in a round-robin fashion.</p> - <p>In other words, ActiveMQ Artemis <b>load balances</b> the sent messages across all consumers on the cluster</p> - <p>This example uses JNDI to lookup the JMS Queue and ConnectionFactory objects. If you prefer not to use - JNDI, these could be instantiated directly.</p> - <p>Here's the relevant snippet from the server configuration, which tells the server to form a cluster between the two nodes - and to load balance the messages between the nodes.</p> - <pre class="prettyprint"> - <code><cluster-connection name="my-cluster"> - <connector-ref>netty-connector</connector-ref> - <retry-interval>500</retry-interval> - <use-duplicate-detection>true</use-duplicate-detection> - <message-load-balancing>STRICT</message-load-balancing> - <max-hops>1</max-hops> - <discovery-group-ref discovery-group-name="my-discovery-group"/> - </cluster-connection> - </code> - </pre> - <p>For more information on ActiveMQ Artemis load balancing, and clustering in general, please see the clustering - section of the user manual.</p> - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-queue/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-queue/readme.md b/examples/features/clustered/clustered-queue/readme.md new file mode 100644 index 0000000..769ce8b --- /dev/null +++ b/examples/features/clustered/clustered-queue/readme.md @@ -0,0 +1,26 @@ +# JMS Load Balanced Clustered Queue Example + +To run the example, simply type **mvn verify** from this directory, or **mvn -PnoServer verify** if you want to start and create the broker manually. + +This example demonstrates a JMS queue deployed on two different nodes. The two nodes are configured to form a cluster. + +We then create a consumer on the queue on each node, and we create a producer on only one of the nodes. + +We then send some messages via the producer, and we verify that **both** consumers receive the sent messages in a round-robin fashion. + +In other words, ActiveMQ Artemis **load balances** the sent messages across all consumers on the cluster + +This example uses JNDI to lookup the JMS Queue and ConnectionFactory objects. If you prefer not to use JNDI, these could be instantiated directly. + +Here's the relevant snippet from the broker configuration, which tells the broker to form a cluster between the two nodes and to load balance the messages between the nodes. + + <cluster-connection name="my-cluster"> + <connector-ref>netty-connector</connector-ref> + <retry-interval>500</retry-interval> + <use-duplicate-detection>true</use-duplicate-detection> + <message-load-balancing>STRICT</message-load-balancing> + <max-hops>1</max-hops> + <discovery-group-ref discovery-group-name="my-discovery-group"/> + </cluster-connection> + +For more information on ActiveMQ Artemis load balancing, and clustering in general, please see the clustering section of the user manual. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-queue/src/main/resources/activemq/server0/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-queue/src/main/resources/activemq/server0/broker.xml b/examples/features/clustered/clustered-queue/src/main/resources/activemq/server0/broker.xml index cee673a..452ad36 100644 --- a/examples/features/clustered/clustered-queue/src/main/resources/activemq/server0/broker.xml +++ b/examples/features/clustered/clustered-queue/src/main/resources/activemq/server0/broker.xml @@ -16,10 +16,8 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---><configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - - - +--> +<configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> <core xmlns="urn:activemq:core"> <bindings-directory>./data/bindings</bindings-directory> @@ -83,7 +81,7 @@ under the License. </security-setting> </security-settings> - <addresses> + <addresses> <address name="exampleQueue"> <anycast> <queue name="exampleQueue"/> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-queue/src/main/resources/activemq/server1/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-queue/src/main/resources/activemq/server1/broker.xml b/examples/features/clustered/clustered-queue/src/main/resources/activemq/server1/broker.xml index de6f9e6..5bfc79f 100644 --- a/examples/features/clustered/clustered-queue/src/main/resources/activemq/server1/broker.xml +++ b/examples/features/clustered/clustered-queue/src/main/resources/activemq/server1/broker.xml @@ -16,10 +16,8 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---><configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - - - +--> +<configuration xmlns="urn:activemq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> <core xmlns="urn:activemq:core"> @@ -84,7 +82,7 @@ under the License. </security-setting> </security-settings> - <addresses> + <addresses> <address name="exampleQueue"> <anycast> <queue name="exampleQueue"/> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-static-discovery-uri/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-static-discovery-uri/pom.xml b/examples/features/clustered/clustered-static-discovery-uri/pom.xml index bc921cb..68e82db 100644 --- a/examples/features/clustered/clustered-static-discovery-uri/pom.xml +++ b/examples/features/clustered/clustered-static-discovery-uri/pom.xml @@ -238,7 +238,23 @@ under the License. </dependency> </dependencies> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-clean-plugin</artifactId> + </plugin> </plugins> </build> - -</project> + <profiles> + <profile> + <id>release</id> + <build> + <plugins> + <plugin> + <groupId>com.vladsch.flexmark</groupId> + <artifactId>markdown-page-generator-plugin</artifactId> + </plugin> + </plugins> + </build> + </profile> + </profiles> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-static-discovery-uri/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-static-discovery-uri/readme.html b/examples/features/clustered/clustered-static-discovery-uri/readme.html deleted file mode 100644 index 0dc1205..0000000 --- a/examples/features/clustered/clustered-static-discovery-uri/readme.html +++ /dev/null @@ -1,57 +0,0 @@ -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -<html> - <head> - <title>ActiveMQ Artemis JMS Load Balanced Static Clustered Queue Example</title> - <link rel="stylesheet" type="text/css" href="../../../common/common.css" /> - <link rel="stylesheet" type="text/css" href="../../../common/prettify.css" /> - <script type="text/javascript" src="../../../common/prettify.js"></script> - </head> - <body onload="prettyPrint()"> - <h1>JMS Load Balanced Static Clustered Queue Example</h1> - <pre>To run the example, simply type <b>mvn verify</b> from this directory, <br>or <b>mvn -PnoServer verify</b> if you want to start and create the server manually.</pre> - - <p>This example demonstrates a JMS queue deployed on two different nodes. The two nodes are configured to form a cluster - from a <em>static</em> list of nodes.</p> - <p>We then create a consumer on the queue on each node, and we create a producer on only one of the nodes.</p> - <p>We then send some messages via the producer, and we verify that <b>both</b> consumers receive the sent messages - in a round-robin fashion.</p> - <p>In other words, ActiveMQ Artemis <b>load balances</b> the sent messages across all consumers on the cluster</p> - <p>This example uses JNDI to lookup the JMS Queue and ConnectionFactory objects. If you prefer not to use - JNDI, these could be instantiated directly.</p> - <p>Here's the relevant snippet from the server configuration, which tells the server to form a cluster between the two nodes - and to load balance the messages between the nodes.</p> - <pre class="prettyprint"> - <code><cluster-connection name="my-cluster"> - <connector-ref>netty-connector</connector-ref> - <retry-interval>500</retry-interval> - <use-duplicate-detection>true</use-duplicate-detection> - <message-load-balancing>STRICT</message-load-balancing> - <max-hops>1</max-hops> - <static-connectors> - <connector-ref>server1-connector</connector-ref> - </static-connectors> - </cluster-connection> - </code> - </pre> - <p>For more information on ActiveMQ Artemis load balancing, and clustering in general, please see the clustering - section of the user manual.</p> - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/clustered/clustered-static-discovery-uri/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/clustered/clustered-static-discovery-uri/readme.md b/examples/features/clustered/clustered-static-discovery-uri/readme.md new file mode 100644 index 0000000..d2f9ca1 --- /dev/null +++ b/examples/features/clustered/clustered-static-discovery-uri/readme.md @@ -0,0 +1,28 @@ +# JMS Load Balanced Static Clustered Queue Example + +To run the example, simply type **mvn verify** from this directory, or **mvn -PnoServer verify** if you want to start and create the broker manually. + +This example demonstrates a JMS queue deployed on two different nodes. The two nodes are configured to form a cluster from a _static_ list of nodes. + +We then create a consumer on the queue on each node, and we create a producer on only one of the nodes. + +We then send some messages via the producer, and we verify that **both** consumers receive the sent messages in a round-robin fashion. + +In other words, ActiveMQ Artemis **load balances** the sent messages across all consumers on the cluster + +This example uses JNDI to lookup the JMS Queue and ConnectionFactory objects. If you prefer not to use JNDI, these could be instantiated directly. + +Here's the relevant snippet from the broker configuration, which tells the broker to form a cluster between the two nodes and to load balance the messages between the nodes. + + <cluster-connection name="my-cluster"> + <connector-ref>netty-connector</connector-ref> + <retry-interval>500</retry-interval> + <use-duplicate-detection>true</use-duplicate-detection> + <message-load-balancing>STRICT</message-load-balancing> + <max-hops>1</max-hops> + <static-connectors> + <connector-ref>server1-connector</connector-ref> + </static-connectors> + </cluster-connection> + +For more information on ActiveMQ Artemis load balancing, and clustering in general, please see the clustering section of the user manual. \ No newline at end of file
