http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/divert/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/standard/divert/readme.html b/examples/features/standard/divert/readme.html deleted file mode 100644 index 63fb710..0000000 --- a/examples/features/standard/divert/readme.html +++ /dev/null @@ -1,119 +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 Divert 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>Divert 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>ActiveMQ Artemis diverts allow messages to be transparently "diverted" from one address to another - with just some simple configuration defined on the server side.</p> - <p>Diverts can be defined to be <b>exclusive</b> or <b>non-exclusive</b>.</p> - <p>With an <b>exclusive</b> divert the message is intercepted and does not get sent to the queues originally - bound to that address - it only gets diverted.</p> - <p>With a <b>non-exclusive</b> divert the message continues to go to the queues bound to the address, - but also a <b>copy</b> of the message gets sent to the address specified in the divert. Consequently non-exclusive - diverts can be used to "snoop" on another address</p> - <p>Diverts can also be configured to have an optional filter. If specified then only matching messages - will be diverted.</p> - <p>Diverts can be configured to apply a Transformer. If specified, all diverted messages will have the - opportunity of being transformed by the Transformer.</p> - <p>Diverts are a very sophisticated concept, which when combined with bridges can be used to create - interesting and complex routings. The set of diverts can be thought of as a type of <i>routing table</i> - for messages.</p> - - <h2>Example step-by-step</h2> - <p>In this example we will imagine a fictitious company which has two offices; one in London and another in New York.</p> - <p>The company accepts orders for it's products only at it's London office, and also generates price-updates - for it's products, also only from it's London office. However only the New York office is interested in receiving - price updates for New York products. Any prices for New York products need to be forwarded to the New York office.</p> - <p>There is an unreliable WAN linking the London and New York offices.</p> - <p>The company also requires a copy of any order received to be available to be inspected by management.</p> - <p>In order to achieve this, we will create a queue <code>orderQueue</code> on the London server in to which orders arrive.</p> - <p>We will create a topic, <code>spyTopic</code> on the London server, and there will be two subscribers both in London.</p> - <p>We will create a <i>non-exclusive</i> divert on the London server which will siphon off a copy of each order - received to the topic <code>spyTopic</code>.</p> - <p>Here's the xml config for that divert, from <code>broker.xml</code></p> - <pre class="prettyprint"> - <code> - <divert name="order-divert"> - <address>jms.queue.orders</address> - <forwarding-address>jms.topic.spyTopic</forwarding-address> - <exclusive>false</exclusive> - </divert> - </code> - </pre> - <p>For the prices we will create a topic on the London server, <code>priceUpdates</code> to which all price updates - are sent. We will create another topic on the New York server <code>newYorkPriceUpdates</code> to which all New York - price updates need to be forwarded.</p> - <p>Diverts can only be used to divert messages from one <b>local</b> address to another <b>local</b> address - so we cannot divert directly to an address on another server.</p> - <p>Instead we divert to a local <i>store and forward queue</i> they we define in the configuration. This is just a normal queue - that we use for storing messages before forwarding to another node.</p> - <p>Here's the configuration for it:</p> - <pre class="prettyprint"> - <code> - <queues> - <queue name="jms.queue.priceForwarding"> - <address>jms.queue.priceForwarding</address> - </queue> - </queues> - </code> - </pre> - <p>Here's the configuration for the divert:</p> - <pre class="prettyprint"> - <code> - <divert name="prices-divert"> - <address>jms.topic.priceUpdates</address> - <forwarding-address>jms.queue.priceForwarding</forwarding-address> - <filter string="office='New York'"/> - <transformer-class-name>org.apache.activemq.artemis.jms.example.AddForwardingTimeTransformer</transformer-class-name> - <exclusive>true</exclusive> - </divert> - </code> - </pre> - <p>Note we specify a filter in the divert, so only New York prices get diverted. We also specify a Transformer class - since we are going to insert a header in the message at divert time, recording the time the diversion happened.</p> - <p>And finally we define a bridge that moves messages from the local queue to the address on the New York server. - Bridges move messages from queues to remote addresses and are ideal to use when the target server may be stopped and - started independently, and/or the network might be unreliable. Bridges guarantee once and only once delivery - of messages from their source queues to their target addresses.</p> - <p>Here is the bridge configuration: </p> - <pre class="prettyprint"> - <code> - <bridges> - <bridge name="price-forward-bridge"> - <queue-name>jms.queue.priceForwarding</queue-name> - <forwarding-address>jms.topic.newYorkPriceUpdates</forwarding-address> - <reconnect-attempts>-1</reconnect-attempts> - <static-connectors> - <connector-ref>newyork-connector</connector-ref> - </static-connectors> - </bridge> - </bridges> - </code> - </pre> - </body> -</html>
http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/divert/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/standard/divert/readme.md b/examples/features/standard/divert/readme.md new file mode 100644 index 0000000..8651024 --- /dev/null +++ b/examples/features/standard/divert/readme.md @@ -0,0 +1,82 @@ +# Divert 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. + +ActiveMQ Artemis diverts allow messages to be transparently "diverted" from one address to another with just some simple configuration defined on the broker side. + +Diverts can be defined to be **exclusive** or **non-exclusive**. + +With an **exclusive** divert the message is intercepted and does not get sent to the queues originally bound to that address - it only gets diverted. + +With a **non-exclusive** divert the message continues to go to the queues bound to the address, but also a **copy** of the message gets sent to the address specified in the divert. Consequently non-exclusive diverts can be used to "snoop" on another address + +Diverts can also be configured to have an optional filter. If specified then only matching messages will be diverted. + +Diverts can be configured to apply a Transformer. If specified, all diverted messages will have the opportunity of being transformed by the Transformer. + +Diverts are a very sophisticated concept, which when combined with bridges can be used to create interesting and complex routings. The set of diverts can be thought of as a type of _routing table_ for messages. + +## Example step-by-step + +In this example we will imagine a fictitious company which has two offices; one in London and another in New York. + +The company accepts orders for it's products only at it's London office, and also generates price-updates for it's products, also only from it's London office. However only the New York office is interested in receiving price updates for New York products. Any prices for New York products need to be forwarded to the New York office. + +There is an unreliable WAN linking the London and New York offices. + +The company also requires a copy of any order received to be available to be inspected by management. + +In order to achieve this, we will create a queue `orderQueue` on the London broker in to which orders arrive. + +We will create a topic, `spyTopic` on the London server, and there will be two subscribers both in London. + +We will create a _non-exclusive_ divert on the London broker which will siphon off a copy of each order received to the topic `spyTopic`. + +Here's the xml config for that divert, from `broker.xml` + + <divert name="order-divert"> + <address>orders</address> + <forwarding-address>spyTopic</forwarding-address> + <exclusive>false</exclusive> + </divert> + +For the prices we will create a topic on the London server, `priceUpdates` to which all price updates are sent. We will create another topic on the New York broker `newYorkPriceUpdates` to which all New York price updates need to be forwarded. + +Diverts can only be used to divert messages from one **local** address to another **local** address so we cannot divert directly to an address on another server. + +Instead we divert to a local _store and forward queue_ they we define in the configuration. This is just a normal queue that we use for storing messages before forwarding to another node. + +Here's the configuration for it: + + <address name="priceForwarding"> + <anycast> + <queue name="priceForwarding"/> + </anycast> + </address> + +Here's the configuration for the divert: + + <divert name="prices-divert"> + <address>priceUpdates</address> + <forwarding-address>priceForwarding</forwarding-address> + <filter string="office='New York'"/> + <transformer-class-name>org.apache.activemq.artemis.jms.example.AddForwardingTimeTransformer</transformer-class-name> + <exclusive>true</exclusive> + </divert> + +Note we specify a filter in the divert, so only New York prices get diverted. We also specify a Transformer class since we are going to insert a header in the message at divert time, recording the time the diversion happened. + +And finally we define a bridge that moves messages from the local queue to the address on the New York server. Bridges move messages from queues to remote addresses and are ideal to use when the target broker may be stopped and started independently, and/or the network might be unreliable. Bridges guarantee once and only once delivery of messages from their source queues to their target addresses. + +Here is the bridge configuration: + + <bridges> + <bridge name="price-forward-bridge"> + <queue-name>priceForwarding</queue-name> + <forwarding-address>newYorkPriceUpdates</forwarding-address> + <reconnect-attempts>-1</reconnect-attempts> + <static-connectors> + <connector-ref>newyork-connector</connector-ref> + </static-connectors> + </bridge> + </bridges> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/divert/src/main/java/org/apache/activemq/artemis/jms/example/DivertExample.java ---------------------------------------------------------------------- diff --git a/examples/features/standard/divert/src/main/java/org/apache/activemq/artemis/jms/example/DivertExample.java b/examples/features/standard/divert/src/main/java/org/apache/activemq/artemis/jms/example/DivertExample.java index 98740fe..babb069 100644 --- a/examples/features/standard/divert/src/main/java/org/apache/activemq/artemis/jms/example/DivertExample.java +++ b/examples/features/standard/divert/src/main/java/org/apache/activemq/artemis/jms/example/DivertExample.java @@ -33,7 +33,7 @@ import org.apache.activemq.artemis.jms.client.ActiveMQConnectionFactory; * This examples demonstrates the use of ActiveMQ Artemis "Diverts" to transparently divert or copy messages * from one address to another. * - * Please see the readme.html for more information. + * Please see the readme for more information. */ public class DivertExample { http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/divert/src/main/resources/activemq/server0/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/divert/src/main/resources/activemq/server0/broker.xml b/examples/features/standard/divert/src/main/resources/activemq/server0/broker.xml index 5e36d6e..a6fcc0b 100644 --- a/examples/features/standard/divert/src/main/resources/activemq/server0/broker.xml +++ b/examples/features/standard/divert/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> @@ -96,18 +94,15 @@ under the License. </security-setting> </security-settings> - <addresses> + <addresses> <address name="priceForwarding"> - <multicast> - <queue name="priceForwarding"/> - </multicast> <anycast> - <queue name="jms.queue.priceForwarding"/> + <queue name="priceForwarding"/> </anycast> </address> <address name="orders"> <anycast> - <queue name="jms.queue.orders"/> + <queue name="orders"/> </anycast> </address> <address name="spyTopic"> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/divert/src/main/resources/activemq/server1/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/divert/src/main/resources/activemq/server1/broker.xml b/examples/features/standard/divert/src/main/resources/activemq/server1/broker.xml index 4b2ee13..9bf01ef 100644 --- a/examples/features/standard/divert/src/main/resources/activemq/server1/broker.xml +++ b/examples/features/standard/divert/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> @@ -50,7 +48,7 @@ under the License. </security-setting> </security-settings> - <addresses> + <addresses> <address name="newYorkPriceUpdates"> <multicast/> </address> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/durable-subscription/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/durable-subscription/pom.xml b/examples/features/standard/durable-subscription/pom.xml index 7c537bf..578117f 100644 --- a/examples/features/standard/durable-subscription/pom.xml +++ b/examples/features/standard/durable-subscription/pom.xml @@ -103,7 +103,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/standard/durable-subscription/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/standard/durable-subscription/readme.html b/examples/features/standard/durable-subscription/readme.html deleted file mode 100644 index 61b591f..0000000 --- a/examples/features/standard/durable-subscription/readme.html +++ /dev/null @@ -1,39 +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 how to use a durable subscription with ActiveMQ Artemis.</p> - <p>Durable subscriptions are a standard part of JMS, please consult the JMS 1.1 specification for full details.</p> - <p>Unlike non durable subscriptions, the key function of durable subscriptions is that the messages contained in them - persist longer than the lifetime of the subscriber - i.e. they will accumulate messages sent to the topic even - if the subscriber is not currently connected. They will also survive server restarts. Note that for the messages to - be persisted, the messages sent to them must be marked as persistent messages.</p> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/durable-subscription/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/standard/durable-subscription/readme.md b/examples/features/standard/durable-subscription/readme.md new file mode 100644 index 0000000..6b74040 --- /dev/null +++ b/examples/features/standard/durable-subscription/readme.md @@ -0,0 +1,9 @@ +# JMS 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 how to use a durable subscription with ActiveMQ Artemis. + +Durable subscriptions are a standard part of JMS, please consult the JMS 1.1 specification for full details. + +Unlike non durable subscriptions, the key function of durable subscriptions is that the messages contained in them persist longer than the lifetime of the subscriber - i.e. they will accumulate messages sent to the topic even if the subscriber is not currently connected. They will also survive broker restarts. Note that for the messages to be persisted, the messages sent to them must be marked as persistent messages. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/durable-subscription/src/main/resources/activemq/server0/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/durable-subscription/src/main/resources/activemq/server0/broker.xml b/examples/features/standard/durable-subscription/src/main/resources/activemq/server0/broker.xml index d3352b1..91d733a 100644 --- a/examples/features/standard/durable-subscription/src/main/resources/activemq/server0/broker.xml +++ b/examples/features/standard/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> @@ -50,7 +48,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/standard/embedded-simple/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/embedded-simple/pom.xml b/examples/features/standard/embedded-simple/pom.xml index 40e9fc2..610934b 100644 --- a/examples/features/standard/embedded-simple/pom.xml +++ b/examples/features/standard/embedded-simple/pom.xml @@ -77,7 +77,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/standard/embedded-simple/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/standard/embedded-simple/readme.html b/examples/features/standard/embedded-simple/readme.html deleted file mode 100644 index dae7359..0000000 --- a/examples/features/standard/embedded-simple/readme.html +++ /dev/null @@ -1,35 +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 Embedded Broker with External Config 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>Embedded Broker with External Config Example</h1> - <pre>To run the example, simply type <b>mvn verify</b> from this directory</pre> - - <p>This examples shows how to setup and run an embedded broker using ActiveMQ Artemis.</p> - <p>ActiveMQ Artemis was designed using POJOs (Plain Old Java Objects) which means embedding ActiveMQ Artemis in your own application is as simple as instantiating a few objects.</p> - <p>This example uses an external configuration file (i.e. broker.xml).</p> - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/embedded-simple/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/standard/embedded-simple/readme.md b/examples/features/standard/embedded-simple/readme.md new file mode 100644 index 0000000..7b85d02 --- /dev/null +++ b/examples/features/standard/embedded-simple/readme.md @@ -0,0 +1,9 @@ +# Embedded Broker with External Config Example + +To run the example, simply type **mvn verify** from this directory. + +This examples shows how to setup and run an embedded broker using ActiveMQ Artemis. + +ActiveMQ Artemis was designed using POJOs (Plain Old Java Objects) which means embedding ActiveMQ Artemis in your own application is as simple as instantiating a few objects. + +This example uses an external configuration file (i.e. broker.xml). \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/embedded-simple/src/main/resources/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/embedded-simple/src/main/resources/broker.xml b/examples/features/standard/embedded-simple/src/main/resources/broker.xml index a67720c..52e32de 100644 --- a/examples/features/standard/embedded-simple/src/main/resources/broker.xml +++ b/examples/features/standard/embedded-simple/src/main/resources/broker.xml @@ -20,10 +20,7 @@ under the License. <configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xmlns="urn:activemq" - xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - - <core xmlns="urn:activemq:core"> - + xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> <persistence-enabled>false</persistence-enabled> <acceptors> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/embedded/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/embedded/pom.xml b/examples/features/standard/embedded/pom.xml index ff99767..a69522c 100644 --- a/examples/features/standard/embedded/pom.xml +++ b/examples/features/standard/embedded/pom.xml @@ -77,7 +77,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/standard/embedded/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/standard/embedded/readme.html b/examples/features/standard/embedded/readme.html deleted file mode 100644 index d277c91..0000000 --- a/examples/features/standard/embedded/readme.html +++ /dev/null @@ -1,36 +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 Embedded Broker with Programmatic Config 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>Embedded Broker with Programmatic Config Example</h1> - <pre>To run the example, simply type <b>mvn verify</b> from this directory</pre> - - <p>This examples shows how to setup and run an embedded broker using ActiveMQ Artemis.</p> - <p>ActiveMQ Artemis was designed using POJOs (Plain Old Java Objects) which means embedding ActiveMQ Artemis in your own application - is as simple as instantiating a few objects.</p> - <p>This example does not use any configuration files. The server is configured using POJOs and can be easily ported to any dependency injection framework.</p> - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/embedded/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/standard/embedded/readme.md b/examples/features/standard/embedded/readme.md new file mode 100644 index 0000000..c70c044 --- /dev/null +++ b/examples/features/standard/embedded/readme.md @@ -0,0 +1,9 @@ +# Embedded Broker with Programmatic Config Example + +To run the example, simply type **mvn verify** from this directory. + +This examples shows how to setup and run an embedded broker using ActiveMQ Artemis. + +ActiveMQ Artemis was designed using POJOs (Plain Old Java Objects) which means embedding ActiveMQ Artemis in your own application is as simple as instantiating a few objects. + +This example does not use any configuration files. The broker is configured using POJOs and can be easily ported to any dependency injection framework. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/expiry/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/expiry/pom.xml b/examples/features/standard/expiry/pom.xml index 4c8f1f7..84c4641 100644 --- a/examples/features/standard/expiry/pom.xml +++ b/examples/features/standard/expiry/pom.xml @@ -103,7 +103,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/standard/expiry/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/standard/expiry/readme.html b/examples/features/standard/expiry/readme.html deleted file mode 100644 index d13cac0..0000000 --- a/examples/features/standard/expiry/readme.html +++ /dev/null @@ -1,61 +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 Message Expiration 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 Expiration 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 shows you how to configure ActiveMQ Artemis so messages are expipired after a certain time.</p> - <p>Messages can be retained in the messaging system for a limited period of time before being removed. - JMS specification states that clients should not receive messages that have been expired (but it does not guarantee this will not happen).</p> - <p>ActiveMQ Artemis can assign a <em>expiry address</em> to a given queue so that when messages are expired, they are removed from the queue and - routed to this address. These "expired" messages can later be consumed for further inspection. - <p> - The example will send 1 message with a short <em>time-to-live</em> to a queue. We will wait for the message to expire and checks that the message - is no longer in the queue it was sent to. - We will instead consume it from an <em>expiry queue</em> where it was moved when it expired. - </p> - <h2>Example setup</h2> - <p>Expiry destinations are defined in the configuration file <a href="server0/broker.xml">broker.xml</a>:</p> - <pre class="prettyprint"> - <code><address-setting match="jms.queue.exampleQueue"> - <expiry-address>jms.queue.expiryQueue</expiry-address> - </address-setting> - </code> - </pre> - <p>This configuration will moved expired messages from the <code>exampleQueue</code> to the <code>expiryQueue</code></p> - <p>ActiveMQ Artemis allows to specify either a <code>Queue</code> by prefixing the <code>expiry-address</code> with <code>jms.queue.</code> - or a <code>Topic</code> by prefixing with <code>jms.topic.</code>.<br /> - In this example, we will use a <code>Queue</code> to hold the expired messages.</p> - <p>Since we want to consume messages from this expiryQueue, we also need to add a JNDI binding to perform a lookup. - This is configured in <a href="server0/activemq-jms.xml">activemq-jms.xml</a></p> - <pre class="prettyprint"> - <code><queue name="expiryQueue"> - <entry name="/queue/expiryQueue"/> - </queue></code> - </pre> - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/expiry/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/standard/expiry/readme.md b/examples/features/standard/expiry/readme.md new file mode 100644 index 0000000..963e6de --- /dev/null +++ b/examples/features/standard/expiry/readme.md @@ -0,0 +1,17 @@ +# JMS Expiration 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 shows you how to configure ActiveMQ Artemis so messages are expipired after a certain time. + +Messages can be retained in the messaging system for a limited period of time before being removed. JMS specification states that clients should not receive messages that have been expired (but it does not guarantee this will not happen). + +ActiveMQ Artemis can assign a _expiry address_ to a given queue so that when messages are expired, they are removed from the queue and routed to this address. These "expired" messages can later be consumed for further inspection. + +The example will send 1 message with a short _time-to-live_ to a queue. We will wait for the message to expire and checks that the message is no longer in the queue it was sent to. We will instead consume it from an _expiry queue_ where it was moved when it expired. + +## Example setup + +Expiry destinations are defined in the configuration file broker.xml. + +This configuration will moved expired messages from the `exampleQueue` to the `expiryQueue`. http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/expiry/src/main/resources/activemq/server0/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/expiry/src/main/resources/activemq/server0/broker.xml b/examples/features/standard/expiry/src/main/resources/activemq/server0/broker.xml index fd26edd..12faf9b 100644 --- a/examples/features/standard/expiry/src/main/resources/activemq/server0/broker.xml +++ b/examples/features/standard/expiry/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> @@ -56,7 +54,7 @@ under the License. </address-setting> </address-settings> - <addresses> + <addresses> <address name="exampleQueue"> <anycast> <queue name="exampleQueue"/> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/http-transport/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/http-transport/pom.xml b/examples/features/standard/http-transport/pom.xml index 38c3a60..02e4d45 100644 --- a/examples/features/standard/http-transport/pom.xml +++ b/examples/features/standard/http-transport/pom.xml @@ -103,7 +103,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/standard/http-transport/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/standard/http-transport/readme.html b/examples/features/standard/http-transport/readme.html deleted file mode 100644 index 061c939..0000000 --- a/examples/features/standard/http-transport/readme.html +++ /dev/null @@ -1,52 +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 HTTP Transport 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 HTTP 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 shows you how to configure ActiveMQ Artemis to use the HTTP protocol as its transport layer.</p> - - <p>ActiveMQ Artemis supports a variety of network protocols to be its underlying transport without any specific code change.</p> - - <p>This example is taken from the queue example without any code change. By changing the configuration file, one can get ActiveMQ Artemis working with HTTP transport.</p> - <p>All you need to do is open the server0/broker.xml and enable HTTP like the following</p> - - - <pre class="prettyprint"> - <code> - <connector name="netty-connector">tcp://localhost:8080?httpEnabled=true</connector> - - <!-- Acceptors --> - - <acceptor name="netty-acceptor">tcp://localhost:8080 </acceptor> - </code> - </pre> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/http-transport/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/standard/http-transport/readme.md b/examples/features/standard/http-transport/readme.md new file mode 100644 index 0000000..5c1951c --- /dev/null +++ b/examples/features/standard/http-transport/readme.md @@ -0,0 +1,9 @@ +# JMS HTTP 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 shows you how to configure ActiveMQ Artemis to use the HTTP protocol as its transport layer. + +ActiveMQ Artemis supports a variety of network protocols to be its underlying transport without any specific code change. + +This example is taken from the queue example without any code change. By changing the client's URL in `jndi.properties` one can get ActiveMQ Artemis working with the HTTP transport. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/http-transport/src/main/java/org/apache/activemq/artemis/jms/example/HttpTransportExample.java ---------------------------------------------------------------------- diff --git a/examples/features/standard/http-transport/src/main/java/org/apache/activemq/artemis/jms/example/HttpTransportExample.java b/examples/features/standard/http-transport/src/main/java/org/apache/activemq/artemis/jms/example/HttpTransportExample.java index bb189d3..721e6c6 100644 --- a/examples/features/standard/http-transport/src/main/java/org/apache/activemq/artemis/jms/example/HttpTransportExample.java +++ b/examples/features/standard/http-transport/src/main/java/org/apache/activemq/artemis/jms/example/HttpTransportExample.java @@ -23,29 +23,29 @@ import javax.jms.MessageProducer; import javax.jms.Queue; import javax.jms.Session; import javax.jms.TextMessage; - -import org.apache.activemq.artemis.api.jms.ActiveMQJMSClient; -import org.apache.activemq.artemis.jms.client.ActiveMQConnectionFactory; +import javax.naming.InitialContext; /** - * A simple JMS Queue example that uses HTTP protocol. + * A simple JMS Queue example that uses the HTTP protocol. */ public class HttpTransportExample { public static void main(final String[] args) throws Exception { Connection connection = null; + InitialContext initialContext = null; try { - // Step 2. Perfom a lookup on the queue - Queue queue = ActiveMQJMSClient.createQueue("exampleQueue"); + // Step 1. Create an initial context to perform the JNDI lookup. + initialContext = new InitialContext(); + + // Step 2. Perform a lookup on the queue + Queue queue = (Queue) initialContext.lookup("queue/exampleQueue"); // Step 3. Perform a lookup on the Connection Factory - ConnectionFactory cf = new ActiveMQConnectionFactory("tcp://localhost:8080?httpEnabled=true"); + ConnectionFactory cf = (ConnectionFactory) initialContext.lookup("ConnectionFactory"); // Step 4.Create a JMS Connection connection = cf.createConnection(); - System.out.println("connection created: " + connection); - // Step 5. Create a JMS Session Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE); @@ -70,8 +70,11 @@ public class HttpTransportExample { TextMessage messageReceived = (TextMessage) messageConsumer.receive(5000); System.out.println("Received message: " + messageReceived.getText()); - } finally { + // Step 12. Be sure to close our JMS resources! + if (initialContext != null) { + initialContext.close(); + } if (connection != null) { connection.close(); } http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/http-transport/src/main/resources/activemq/server0/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/http-transport/src/main/resources/activemq/server0/broker.xml b/examples/features/standard/http-transport/src/main/resources/activemq/server0/broker.xml index db5d588..cb1f0d9 100644 --- a/examples/features/standard/http-transport/src/main/resources/activemq/server0/broker.xml +++ b/examples/features/standard/http-transport/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> @@ -50,7 +48,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/standard/http-transport/src/main/resources/jndi.properties ---------------------------------------------------------------------- diff --git a/examples/features/standard/http-transport/src/main/resources/jndi.properties b/examples/features/standard/http-transport/src/main/resources/jndi.properties new file mode 100644 index 0000000..5f8076d --- /dev/null +++ b/examples/features/standard/http-transport/src/main/resources/jndi.properties @@ -0,0 +1,20 @@ +# 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. + +java.naming.factory.initial=org.apache.activemq.artemis.jndi.ActiveMQInitialContextFactory +connectionFactory.ConnectionFactory=tcp://localhost:8080?httpEnabled=true +queue.queue/exampleQueue=exampleQueue http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/instantiate-connection-factory/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/instantiate-connection-factory/pom.xml b/examples/features/standard/instantiate-connection-factory/pom.xml index bd63910..8ab0350 100644 --- a/examples/features/standard/instantiate-connection-factory/pom.xml +++ b/examples/features/standard/instantiate-connection-factory/pom.xml @@ -104,7 +104,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/standard/instantiate-connection-factory/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/standard/instantiate-connection-factory/readme.html b/examples/features/standard/instantiate-connection-factory/readme.html deleted file mode 100644 index b084471..0000000 --- a/examples/features/standard/instantiate-connection-factory/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 Instantiate Connection Factory 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 Instantiate Connection Factory 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>Usually, JMS Objects such as ConnectionFactories, Queue and Topic instances are looked up from JNDI - before being used by the client code. This objects are called "administered objects" in JMS specification - terminology.</p> - <p>However, in some cases a JNDI server may not be available or desired. To come to the rescue ActiveMQ - also supports the direct instantiation of these administered objects on the client side.</p> - <p>This allows the full set of JMS functionality to be available without requiring a JNDI server!</p> - <p>This example is very simple and based on the simple Queue example, however in this example we - instantiate the JMS Queue and ConnectionFactory objects directly.</p> - <p>A wide variety of methods are available for instantiating ConnectionFactory objects. In this example - we use a simple method which just takes the server connection details so it knows where to make the - connection to.</p> - <p>Other methods are available so all the connection factory parameters can be specified - including specifying UDP discovery so the client does not need hard-wired knowledge of where the servers - are that it wishes to connect to, or for specifying live-backup pairs of servers for failover.</p> - <p>For more information on instantiating ConnectionFactories directly please consult the user manual and - javadoc.</p> - </body> -</html> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/interceptor-amqp/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-amqp/pom.xml b/examples/features/standard/interceptor-amqp/pom.xml new file mode 100644 index 0000000..de4e5b1 --- /dev/null +++ b/examples/features/standard/interceptor-amqp/pom.xml @@ -0,0 +1,137 @@ +<?xml version='1.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. +--> + +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.activemq.examples.broker</groupId> + <artifactId>jms-examples</artifactId> + <version>2.5.0-SNAPSHOT</version> + </parent> + + <artifactId>interceptor-amqp</artifactId> + <packaging>jar</packaging> + <name>ActiveMQ Artemis AMQP Interceptor Example</name> + + <properties> + <activemq.basedir>${project.basedir}/../../../..</activemq.basedir> + </properties> + + <dependencies> + <dependency> + <groupId>org.apache.activemq</groupId> + <artifactId>artemis-amqp-protocol</artifactId> + <version>${project.version}</version> + </dependency> + + <dependency> + <groupId>org.apache.qpid</groupId> + <artifactId>qpid-jms-client</artifactId> + <version>${qpid.jms.version}</version> + </dependency> + + <dependency> + <groupId>io.netty</groupId> + <artifactId>netty-all</artifactId> + </dependency> + </dependencies> + + <build> + <plugins> + <plugin> + <groupId>org.apache.activemq</groupId> + <artifactId>artemis-maven-plugin</artifactId> + <executions> + <execution> + <id>create</id> + <goals> + <goal>create</goal> + </goals> + <configuration> + <libList><arg>org.apache.activemq.examples.broker:interceptor-client-amqp:${project.version}</arg></libList> + <ignore>${noServer}</ignore> + <configuration>${basedir}/target/classes/activemq/server0</configuration> + </configuration> + </execution> + <execution> + <id>start</id> + <goals> + <goal>cli</goal> + </goals> + <configuration> + <ignore>${noServer}</ignore> + <spawn>true</spawn> + <testURI>tcp://localhost:61616</testURI> + <args> + <param>run</param> + </args> + </configuration> + </execution> + <execution> + <id>runClient</id> + <goals> + <goal>runClient</goal> + </goals> + <configuration> + <clientClass>org.apache.activemq.artemis.amqp.example.InterceptorExample</clientClass> + </configuration> + </execution> + <execution> + <id>stop</id> + <goals> + <goal>cli</goal> + </goals> + <configuration> + <ignore>${noServer}</ignore> + <args> + <param>stop</param> + </args> + </configuration> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.apache.activemq.examples.broker</groupId> + <artifactId>interceptor-client-amqp</artifactId> + <version>${project.version}</version> + </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> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/interceptor-amqp/readme.md ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-amqp/readme.md b/examples/features/standard/interceptor-amqp/readme.md new file mode 100644 index 0000000..73735b5 --- /dev/null +++ b/examples/features/standard/interceptor-amqp/readme.md @@ -0,0 +1,21 @@ +# AMQP Interceptor 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 shows you how to implement and configure a simple incoming, server-side AMQP interceptor with ActiveMQ Artemis. + +ActiveMQ Artemis allows an application to use an interceptor to hook into the messaging system. To intercept AMQP packets all that needs to be done is to implement the `org.apache.activemq.artemis.protocol.amqp.broker.AmqpInterceptor` interface. + +Once you have your own interceptor class add it to the broker.xml as follows: + + <configuration> + ... + <remoting-incoming-interceptors> + <class-name>org.apache.activemq.artemis.amqp.example.SimpleAmqpInterceptor</class-name> + </remoting-incoming-interceptors> + ... + </configuration> + +With an interceptor you can handle various events in message processing. In this example, a simple interceptor, SimpleAmqpInterceptor, is implemented and configured. When the example is running, the interceptor will display the value of a string property of a sample AMQP message. + +With our interceptor we always return `true` from the `intercept` method. If we were to return `false` that signifies that no more interceptors are to run. Throw an exception to abort processing of the packet. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/interceptor-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/InterceptorExample.java ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/InterceptorExample.java b/examples/features/standard/interceptor-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/InterceptorExample.java new file mode 100644 index 0000000..5ae2e5c --- /dev/null +++ b/examples/features/standard/interceptor-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/InterceptorExample.java @@ -0,0 +1,47 @@ +/* + * 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. + */ +package org.apache.activemq.artemis.amqp.example; + +import org.apache.qpid.jms.JmsConnectionFactory; + +import javax.jms.Connection; +import javax.jms.MessageProducer; +import javax.jms.Queue; +import javax.jms.Session; +import javax.jms.TextMessage; + +/** + * A simple example that shows how to implement and use interceptors with ActiveMQ Artemis with the AMQP protocol. + */ +public class InterceptorExample { + public static void main(final String[] args) throws Exception { + JmsConnectionFactory factory = new JmsConnectionFactory("amqp://localhost:61616"); + + try (Connection connection = factory.createConnection()) { + + Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE); + + Queue interceptorQueue = session.createQueue("interceptorQueue"); + + MessageProducer producer = session.createProducer(interceptorQueue); + + TextMessage textMessage = session.createTextMessage("A text message"); + textMessage.setStringProperty("SimpleAmqpInterceptor", "SimpleAmqpInterceptorValue"); + producer.send(textMessage); + } + } +} http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/interceptor-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/SimpleAmqpInterceptor.java ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/SimpleAmqpInterceptor.java b/examples/features/standard/interceptor-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/SimpleAmqpInterceptor.java new file mode 100644 index 0000000..02faea0 --- /dev/null +++ b/examples/features/standard/interceptor-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/SimpleAmqpInterceptor.java @@ -0,0 +1,37 @@ +/* + * 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. + */ +package org.apache.activemq.artemis.amqp.example; + +import org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage; +import org.apache.activemq.artemis.protocol.amqp.broker.AmqpInterceptor; +import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; + + +/** + * A simple Interceptor implementation + */ +public class SimpleAmqpInterceptor implements AmqpInterceptor { + + @Override + public boolean intercept(final AMQPMessage message, RemotingConnection connection) { + System.out.println("AMQP Interceptor gets called with message " + message.getMessageID()); + String val = message.getStringProperty("SimpleAmqpInterceptor"); + System.out.println("intercepted message with property " + val); + return true; + } + +} http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/interceptor-amqp/src/main/resources/activemq/server0/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-amqp/src/main/resources/activemq/server0/broker.xml b/examples/features/standard/interceptor-amqp/src/main/resources/activemq/server0/broker.xml new file mode 100644 index 0000000..e03bff6 --- /dev/null +++ b/examples/features/standard/interceptor-amqp/src/main/resources/activemq/server0/broker.xml @@ -0,0 +1,53 @@ +<?xml version='1.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. +--> +<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"> + + <paging-directory>./data/paging</paging-directory> + + <bindings-directory>./data/bindings</bindings-directory> + + <journal-directory>./data/journal</journal-directory> + + <large-messages-directory>./data/large-messages</large-messages-directory> + + <remoting-incoming-interceptors> + <class-name>org.apache.activemq.artemis.amqp.example.SimpleAmqpInterceptor</class-name> + </remoting-incoming-interceptors> + + <acceptors> + <!-- Acceptor for every supported protocol --> + <acceptor name="artemis">tcp://0.0.0.0:61616?tcpSendBufferSize=1048576;tcpReceiveBufferSize=1048576;protocols=CORE,AMQP,STOMP,HORNETQ,MQTT,OPENWIRE</acceptor> + </acceptors> + + <security-settings> + <security-setting match="#"> + <permission type="createNonDurableQueue" roles="guest"/> + <permission type="deleteNonDurableQueue" roles="guest"/> + <permission type="createDurableQueue" roles="guest"/> + <permission type="deleteDurableQueue" roles="guest"/> + <permission type="createAddress" roles="guest"/> + <permission type="deleteAddress" roles="guest"/> + <permission type="consume" roles="guest"/> + <permission type="send" roles="guest"/> + </security-setting> + </security-settings> + </core> +</configuration> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/interceptor-client-amqp/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-client-amqp/pom.xml b/examples/features/standard/interceptor-client-amqp/pom.xml deleted file mode 100644 index 35d90ca..0000000 --- a/examples/features/standard/interceptor-client-amqp/pom.xml +++ /dev/null @@ -1,121 +0,0 @@ -<?xml version='1.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. ---> - -<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> - <modelVersion>4.0.0</modelVersion> - - <parent> - <groupId>org.apache.activemq.examples.broker</groupId> - <artifactId>jms-examples</artifactId> - <version>2.5.0-SNAPSHOT</version> - </parent> - - <artifactId>interceptor-client-amqp</artifactId> - <packaging>jar</packaging> - <name>ActiveMQ Artemis AMQP Interceptor Example</name> - - <properties> - <activemq.basedir>${project.basedir}/../../../..</activemq.basedir> - </properties> - - <dependencies> - <dependency> - <groupId>org.apache.activemq</groupId> - <artifactId>artemis-amqp-protocol</artifactId> - <version>${project.version}</version> - </dependency> - - <dependency> - <groupId>org.apache.qpid</groupId> - <artifactId>qpid-jms-client</artifactId> - <version>${qpid.jms.version}</version> - </dependency> - - <dependency> - <groupId>io.netty</groupId> - <artifactId>netty-all</artifactId> - </dependency> - </dependencies> - - <build> - <plugins> - <plugin> - <groupId>org.apache.activemq</groupId> - <artifactId>artemis-maven-plugin</artifactId> - <executions> - <execution> - <id>create</id> - <goals> - <goal>create</goal> - </goals> - <configuration> - <libList><arg>org.apache.activemq.examples.broker:interceptor-client-amqp:${project.version}</arg></libList> - <ignore>${noServer}</ignore> - <configuration>${basedir}/target/classes/activemq/server0</configuration> - </configuration> - </execution> - <execution> - <id>start</id> - <goals> - <goal>cli</goal> - </goals> - <configuration> - <ignore>${noServer}</ignore> - <spawn>true</spawn> - <testURI>tcp://localhost:61616</testURI> - <args> - <param>run</param> - </args> - </configuration> - </execution> - <execution> - <id>runClient</id> - <goals> - <goal>runClient</goal> - </goals> - <configuration> - <clientClass>org.apache.activemq.artemis.amqp.example.InterceptorExample</clientClass> - </configuration> - </execution> - <execution> - <id>stop</id> - <goals> - <goal>cli</goal> - </goals> - <configuration> - <ignore>${noServer}</ignore> - <args> - <param>stop</param> - </args> - </configuration> - </execution> - </executions> - <dependencies> - <dependency> - <groupId>org.apache.activemq.examples.broker</groupId> - <artifactId>interceptor-client-amqp</artifactId> - <version>${project.version}</version> - </dependency> - </dependencies> - </plugin> - </plugins> - </build> - -</project> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/interceptor-client-amqp/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-client-amqp/readme.html b/examples/features/standard/interceptor-client-amqp/readme.html deleted file mode 100644 index 20bbc5c..0000000 --- a/examples/features/standard/interceptor-client-amqp/readme.html +++ /dev/null @@ -1,71 +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 AMQP Interceptor 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>AMQP Interceptor 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 shows you how to implement and configure a simple incoming, server-side AMQP interceptor with ActiveMQ Artemis.</p> - - <p>ActiveMQ Artemis allows an application to use an interceptor to hook into the messaging system. All that needs to do is to implement the - Interceptor interface, as defined below: </p> - <pre class="prettyprint"> - <code> - public interface AmqpInterceptor - { - boolean intercept(final AMQPMessage message, RemotingConnection connection); - } - </code> - </pre> - <p>Once you have your own interceptor class, add it to the broker.xml, as follows:</p> - <pre class="prettyprint"> - <code> - <configuration> - ... - <remoting-incoming-interceptors> - <class-name>org.apache.activemq.artemis.amqp.example.SimpleAMQPInterceptor</class-name> - </remoting-incoming-interceptors> - ... - </configuration> - </code> - </pre> - - <p>With interceptor, you can handle various events in message processing. In this example, a simple interceptor, SimpleAMQPInterceptor, is implemented and configured. - When the example is running, the interceptor examine and log properties of the AMQP message.</p> - - <p>With our interceptor we always return <code>true</code> from the <code>intercept</code> method. If we were - to return <code>false</code> that signifies that no more interceptors are to run. - Throw an exception to abort processing of the packet.</p> - </body> -</html> - - - - - - http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/interceptor-client-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/InterceptorExample.java ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-client-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/InterceptorExample.java b/examples/features/standard/interceptor-client-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/InterceptorExample.java deleted file mode 100644 index 5ae2e5c..0000000 --- a/examples/features/standard/interceptor-client-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/InterceptorExample.java +++ /dev/null @@ -1,47 +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. - */ -package org.apache.activemq.artemis.amqp.example; - -import org.apache.qpid.jms.JmsConnectionFactory; - -import javax.jms.Connection; -import javax.jms.MessageProducer; -import javax.jms.Queue; -import javax.jms.Session; -import javax.jms.TextMessage; - -/** - * A simple example that shows how to implement and use interceptors with ActiveMQ Artemis with the AMQP protocol. - */ -public class InterceptorExample { - public static void main(final String[] args) throws Exception { - JmsConnectionFactory factory = new JmsConnectionFactory("amqp://localhost:61616"); - - try (Connection connection = factory.createConnection()) { - - Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE); - - Queue interceptorQueue = session.createQueue("interceptorQueue"); - - MessageProducer producer = session.createProducer(interceptorQueue); - - TextMessage textMessage = session.createTextMessage("A text message"); - textMessage.setStringProperty("SimpleAmqpInterceptor", "SimpleAmqpInterceptorValue"); - producer.send(textMessage); - } - } -} http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/b77cdaf7/examples/features/standard/interceptor-client-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/SimpleAmqpInterceptor.java ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-client-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/SimpleAmqpInterceptor.java b/examples/features/standard/interceptor-client-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/SimpleAmqpInterceptor.java deleted file mode 100644 index 02faea0..0000000 --- a/examples/features/standard/interceptor-client-amqp/src/main/java/org/apache/activemq/artemis/amqp/example/SimpleAmqpInterceptor.java +++ /dev/null @@ -1,37 +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. - */ -package org.apache.activemq.artemis.amqp.example; - -import org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage; -import org.apache.activemq.artemis.protocol.amqp.broker.AmqpInterceptor; -import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; - - -/** - * A simple Interceptor implementation - */ -public class SimpleAmqpInterceptor implements AmqpInterceptor { - - @Override - public boolean intercept(final AMQPMessage message, RemotingConnection connection) { - System.out.println("AMQP Interceptor gets called with message " + message.getMessageID()); - String val = message.getStringProperty("SimpleAmqpInterceptor"); - System.out.println("intercepted message with property " + val); - return true; - } - -}
