Added: websites/production/activemq/content/artemis/docs/latest/maven-plugin.html ============================================================================== --- websites/production/activemq/content/artemis/docs/latest/maven-plugin.html (added) +++ websites/production/activemq/content/artemis/docs/latest/maven-plugin.html Thu Sep 14 19:48:11 2017 @@ -0,0 +1,1300 @@ + +<!DOCTYPE HTML> +<html lang="" > + <head> + <title>Maven Plugin · ActiveMQ Artemis Documentation</title> + <meta charset="UTF-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge" /> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + <meta name="description" content=""> + <meta name="generator" content="GitBook 3.1.1"> + + + + + <link rel="stylesheet" href="gitbook/style.css"> + + + + + <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css"> + + + + <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css"> + + + + <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css"> + + + + + + + + + + + + + + + + + + + + + + + + <meta name="HandheldFriendly" content="true"/> + <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> + <meta name="apple-mobile-web-app-capable" content="yes"> + <meta name="apple-mobile-web-app-status-bar-style" content="black"> + <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png"> + <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon"> + + + <link rel="next" href="unit-testing.html" /> + + + <link rel="prev" href="tools.html" /> + + + </head> + <body> + +<div class="book"> + <div class="book-summary"> + + +<div id="book-search-input" role="search"> + <input type="text" placeholder="Type to search" /> +</div> + + + <nav role="navigation"> + + + +<ul class="summary"> + + + + + + + + + + <li class="chapter " data-level="1.1" data-path="./"> + + <a href="./"> + + + Introduction + + </a> + + + + </li> + + <li class="chapter " data-level="1.2" data-path="notice.html"> + + <a href="notice.html"> + + + Legal Notice + + </a> + + + + </li> + + <li class="chapter " data-level="1.3" data-path="preface.html"> + + <a href="preface.html"> + + + Preface + + </a> + + + + </li> + + <li class="chapter " data-level="1.4" data-path="project-info.html"> + + <a href="project-info.html"> + + + Project Info + + </a> + + + + </li> + + <li class="chapter " data-level="1.5" data-path="messaging-concepts.html"> + + <a href="messaging-concepts.html"> + + + Messaging Concepts + + </a> + + + + </li> + + <li class="chapter " data-level="1.6" data-path="architecture.html"> + + <a href="architecture.html"> + + + Architecture + + </a> + + + + </li> + + <li class="chapter " data-level="1.7" data-path="using-server.html"> + + <a href="using-server.html"> + + + Using the Server + + </a> + + + + </li> + + <li class="chapter " data-level="1.8" data-path="address-model.html"> + + <a href="address-model.html"> + + + Address Model + + </a> + + + + </li> + + <li class="chapter " data-level="1.9" data-path="using-jms.html"> + + <a href="using-jms.html"> + + + Using JMS + + </a> + + + + </li> + + <li class="chapter " data-level="1.10" data-path="using-core.html"> + + <a href="using-core.html"> + + + Using Core + + </a> + + + + </li> + + <li class="chapter " data-level="1.11" data-path="using-AMQP.html"> + + <a href="using-AMQP.html"> + + + Using AMQP + + </a> + + + + </li> + + <li class="chapter " data-level="1.12" data-path="jms-core-mapping.html"> + + <a href="jms-core-mapping.html"> + + + Mapping JMS Concepts to the Core API + + </a> + + + + </li> + + <li class="chapter " data-level="1.13" data-path="client-classpath.html"> + + <a href="client-classpath.html"> + + + The Client Classpath + + </a> + + + + </li> + + <li class="chapter " data-level="1.14" data-path="examples.html"> + + <a href="examples.html"> + + + Examples + + </a> + + + + </li> + + <li class="chapter " data-level="1.15" data-path="wildcard-routing.html"> + + <a href="wildcard-routing.html"> + + + Routing Messages With Wild Cards + + </a> + + + + </li> + + <li class="chapter " data-level="1.16" data-path="wildcard-syntax.html"> + + <a href="wildcard-syntax.html"> + + + Understanding the Apache ActiveMQ Artemis Wildcard Syntax + + </a> + + + + </li> + + <li class="chapter " data-level="1.17" data-path="filter-expressions.html"> + + <a href="filter-expressions.html"> + + + Filter Expressions + + </a> + + + + </li> + + <li class="chapter " data-level="1.18" data-path="persistence.html"> + + <a href="persistence.html"> + + + Persistence + + </a> + + + + </li> + + <li class="chapter " data-level="1.19" data-path="configuring-transports.html"> + + <a href="configuring-transports.html"> + + + Configuring Transports + + </a> + + + + </li> + + <li class="chapter " data-level="1.20" data-path="config-reload.html"> + + <a href="config-reload.html"> + + + Configuration Reload + + </a> + + + + </li> + + <li class="chapter " data-level="1.21" data-path="connection-ttl.html"> + + <a href="connection-ttl.html"> + + + Detecting Dead Connections + + </a> + + + + </li> + + <li class="chapter " data-level="1.22" data-path="slow-consumers.html"> + + <a href="slow-consumers.html"> + + + Detecting Slow Consumers + + </a> + + + + </li> + + <li class="chapter " data-level="1.23" data-path="network-isolation.html"> + + <a href="network-isolation.html"> + + + Avoiding Network Isolation + + </a> + + + + </li> + + <li class="chapter " data-level="1.24" data-path="critical-analysis.html"> + + <a href="critical-analysis.html"> + + + Detecting Broker Issues (Critical Analysis) + + </a> + + + + </li> + + <li class="chapter " data-level="1.25" data-path="transaction-config.html"> + + <a href="transaction-config.html"> + + + Resource Manager Configuration + + </a> + + + + </li> + + <li class="chapter " data-level="1.26" data-path="flow-control.html"> + + <a href="flow-control.html"> + + + Flow Control + + </a> + + + + </li> + + <li class="chapter " data-level="1.27" data-path="send-guarantees.html"> + + <a href="send-guarantees.html"> + + + Guarantees of sends and commits + + </a> + + + + </li> + + <li class="chapter " data-level="1.28" data-path="undelivered-messages.html"> + + <a href="undelivered-messages.html"> + + + Message Redelivery and Undelivered Messages + + </a> + + + + </li> + + <li class="chapter " data-level="1.29" data-path="message-expiry.html"> + + <a href="message-expiry.html"> + + + Message Expiry + + </a> + + + + </li> + + <li class="chapter " data-level="1.30" data-path="large-messages.html"> + + <a href="large-messages.html"> + + + Large Messages + + </a> + + + + </li> + + <li class="chapter " data-level="1.31" data-path="paging.html"> + + <a href="paging.html"> + + + Paging + + </a> + + + + </li> + + <li class="chapter " data-level="1.32" data-path="queue-attributes.html"> + + <a href="queue-attributes.html"> + + + Queue Attributes + + </a> + + + + </li> + + <li class="chapter " data-level="1.33" data-path="scheduled-messages.html"> + + <a href="scheduled-messages.html"> + + + Scheduled Messages + + </a> + + + + </li> + + <li class="chapter " data-level="1.34" data-path="last-value-queues.html"> + + <a href="last-value-queues.html"> + + + Last-Value Queues + + </a> + + + + </li> + + <li class="chapter " data-level="1.35" data-path="message-grouping.html"> + + <a href="message-grouping.html"> + + + Message Grouping + + </a> + + + + </li> + + <li class="chapter " data-level="1.36" data-path="pre-acknowledge.html"> + + <a href="pre-acknowledge.html"> + + + Extra Acknowledge Modes + + </a> + + + + </li> + + <li class="chapter " data-level="1.37" data-path="management.html"> + + <a href="management.html"> + + + Management + + </a> + + + + </li> + + <li class="chapter " data-level="1.38" data-path="management-console.html"> + + <a href="management-console.html"> + + + Management Console + + </a> + + + + </li> + + <li class="chapter " data-level="1.39" data-path="security.html"> + + <a href="security.html"> + + + Security + + </a> + + + + </li> + + <li class="chapter " data-level="1.40" data-path="broker-plugins.html"> + + <a href="broker-plugins.html"> + + + Broker Plugins + + </a> + + + + </li> + + <li class="chapter " data-level="1.41" data-path="resource-limits.html"> + + <a href="resource-limits.html"> + + + Resource Limits + + </a> + + + + </li> + + <li class="chapter " data-level="1.42" data-path="jms-bridge.html"> + + <a href="jms-bridge.html"> + + + The JMS Bridge + + </a> + + + + </li> + + <li class="chapter " data-level="1.43" data-path="client-reconnection.html"> + + <a href="client-reconnection.html"> + + + Client Reconnection and Session Reattachment + + </a> + + + + </li> + + <li class="chapter " data-level="1.44" data-path="diverts.html"> + + <a href="diverts.html"> + + + Diverting and Splitting Message Flows + + </a> + + + + </li> + + <li class="chapter " data-level="1.45" data-path="core-bridges.html"> + + <a href="core-bridges.html"> + + + Core Bridges + + </a> + + + + </li> + + <li class="chapter " data-level="1.46" data-path="duplicate-detection.html"> + + <a href="duplicate-detection.html"> + + + Duplicate Message Detection + + </a> + + + + </li> + + <li class="chapter " data-level="1.47" data-path="clusters.html"> + + <a href="clusters.html"> + + + Clusters + + </a> + + + + </li> + + <li class="chapter " data-level="1.48" data-path="ha.html"> + + <a href="ha.html"> + + + High Availability and Failover + + </a> + + + + </li> + + <li class="chapter " data-level="1.49" data-path="graceful-shutdown.html"> + + <a href="graceful-shutdown.html"> + + + Graceful Server Shutdown + + </a> + + + + </li> + + <li class="chapter " data-level="1.50" data-path="libaio.html"> + + <a href="libaio.html"> + + + Libaio Native Libraries + + </a> + + + + </li> + + <li class="chapter " data-level="1.51" data-path="thread-pooling.html"> + + <a href="thread-pooling.html"> + + + Thread management + + </a> + + + + </li> + + <li class="chapter " data-level="1.52" data-path="logging.html"> + + <a href="logging.html"> + + + Logging + + </a> + + + + </li> + + <li class="chapter " data-level="1.53" data-path="rest.html"> + + <a href="rest.html"> + + + REST Interface + + </a> + + + + </li> + + <li class="chapter " data-level="1.54" data-path="embedding-activemq.html"> + + <a href="embedding-activemq.html"> + + + Embedding Apache ActiveMQ Artemis + + </a> + + + + </li> + + <li class="chapter " data-level="1.55" data-path="karaf.html"> + + <a href="karaf.html"> + + + Apache Karaf + + </a> + + + + </li> + + <li class="chapter " data-level="1.56" data-path="spring-integration.html"> + + <a href="spring-integration.html"> + + + Spring Integration + + </a> + + + + </li> + + <li class="chapter " data-level="1.57" data-path="cdi-integration.html"> + + <a href="cdi-integration.html"> + + + CDI Integration + + </a> + + + + </li> + + <li class="chapter " data-level="1.58" data-path="intercepting-operations.html"> + + <a href="intercepting-operations.html"> + + + Intercepting Operations + + </a> + + + + </li> + + <li class="chapter " data-level="1.59" data-path="protocols-interoperability.html"> + + <a href="protocols-interoperability.html"> + + + Protocols and Interoperability + + </a> + + + + </li> + + <li class="chapter " data-level="1.60" data-path="tools.html"> + + <a href="tools.html"> + + + Tools + + </a> + + + + </li> + + <li class="chapter active" data-level="1.61" data-path="maven-plugin.html"> + + <a href="maven-plugin.html"> + + + Maven Plugin + + </a> + + + + </li> + + <li class="chapter " data-level="1.62" data-path="unit-testing.html"> + + <a href="unit-testing.html"> + + + Unit Testing + + </a> + + + + </li> + + <li class="chapter " data-level="1.63" data-path="perf-tuning.html"> + + <a href="perf-tuning.html"> + + + Troubleshooting and Performance Tuning + + </a> + + + + </li> + + <li class="chapter " data-level="1.64" data-path="configuration-index.html"> + + <a href="configuration-index.html"> + + + Configuration Reference + + </a> + + + + </li> + + <li class="chapter " data-level="1.65" data-path="updating-artemis.html"> + + <a href="updating-artemis.html"> + + + Updating Artemis + + </a> + + + + </li> + + + + + <li class="divider"></li> + + <li> + <a href="https://www.gitbook.com"; target="blank" class="gitbook-link"> + Published with GitBook + </a> + </li> +</ul> + + + </nav> + + + </div> + + <div class="book-body"> + + <div class="body-inner"> + + + +<div class="book-header" role="navigation"> + + + <!-- Title --> + <h1> + <i class="fa fa-circle-o-notch fa-spin"></i> + <a href="." >Maven Plugin</a> + </h1> +</div> + + + + + <div class="page-wrapper" tabindex="-1" role="main"> + <div class="page-inner"> + +<div id="book-search-results"> + <div class="search-noresults"> + + <section class="normal markdown-section"> + + <h1 id="maven-plugins">Maven Plugins</h1> +<p>Since Artemis 1.1.0 Artemis provides the possibility of using Maven Plugins to manage the life cycle of servers.</p> +<h2 id="when-to-use-it">When to use it</h2> +<p>These Maven plugins were initially created to manage server instances across our examples. They can create a server, start, and do any CLI operation over servers.</p> +<p>You could for example use these maven plugins on your testsuite or deployment automation.</p> +<h2 id="goals">Goals</h2> +<p>There are three goals that you can use</p> +<ul> +<li>create</li> +</ul> +<p>This will create a server accordingly to your arguments. You can do some extra tricks here such as installing extra libraries for external modules.</p> +<ul> +<li>cli</li> +</ul> +<p>This will perform any CLI operation. This is basically a maven expression of the CLI classes</p> +<ul> +<li>runClient</li> +</ul> +<p>This is a simple wrapper around classes implementing a static main call. Notice that this won't spawn a new VM or new Thread.</p> +<h2 id="declaration">Declaration</h2> +<p>On your pom, use the plugins section:</p> +<pre><code class="lang-xml"> <span class="hljs-tag"><<span class="hljs-name">build</span>></span> + <span class="hljs-tag"><<span class="hljs-name">plugins</span>></span> + <span class="hljs-tag"><<span class="hljs-name">plugin</span>></span> + <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.apache.activemq<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span> + <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>artemis-maven-plugin<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span> +</code></pre> +<h2 id="create-goal">create goal</h2> +<p>I won't detail every operation of the create plugin here, but I will try to describe the main parameters:</p> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left">configuration</td> +<td style="text-align:left">A place that will hold any file to replace on the configuration. For instance if you are providing your own broker.xml. Default is "${basedir}/target/classes/activemq/server0"</td> +</tr> +<tr> +<td style="text-align:left">home</td> +<td style="text-align:left">The location where you downloaded and installed artemis. Default is "${activemq.basedir}"</td> +</tr> +<tr> +<td style="text-align:left">alternateHome</td> +<td style="text-align:left">This is used case you have two possible locations for your home (e.g. one under compile and one under production</td> +</tr> +<tr> +<td style="text-align:left">instance</td> +<td style="text-align:left">Where the server is going to be installed. Default is "${basedir}/target/server0"</td> +</tr> +<tr> +<td style="text-align:left">liblist[]</td> +<td style="text-align:left">A list of libraries to be installed under ./lib. ex: "org.jgroups:jgroups:3.6.0.Final"</td> +</tr> +</tbody> +</table> +<p>Example:</p> +<pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">executions</span>></span> + <span class="hljs-tag"><<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"><<span class="hljs-name">id</span>></span>create<span class="hljs-tag"></<span class="hljs-name">id</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goal</span>></span>create<span class="hljs-tag"></<span class="hljs-name">goal</span>></span> + <span class="hljs-tag"></<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"><<span class="hljs-name">ignore</span>></span>${noServer}<span class="hljs-tag"></<span class="hljs-name">ignore</span>></span> + <span class="hljs-tag"></<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"></<span class="hljs-name">execution</span>></span> +</code></pre> +<h2 id="cli-goal">cli goal</h2> +<p>Some properties for the CLI</p> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left">configuration</td> +<td style="text-align:left">A place that will hold any file to replace on the configuration. For instance if you are providing your own broker.xml. Default is "${basedir}/target/classes/activemq/server0"</td> +</tr> +<tr> +<td style="text-align:left">home</td> +<td style="text-align:left">The location where you downloaded and installed artemis. Default is "${activemq.basedir}"</td> +</tr> +<tr> +<td style="text-align:left">alternateHome</td> +<td style="text-align:left">This is used case you have two possible locations for your home (e.g. one under compile and one under production</td> +</tr> +<tr> +<td style="text-align:left">instance</td> +<td style="text-align:left">Where the server is going to be installed. Default is "${basedir}/target/server0"</td> +</tr> +</tbody> +</table> +<p>Similarly to the create plugin, the artemis exampels are using the cli plugin. Look at them for concrete examples.</p> +<p>Example:</p> +<pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"><<span class="hljs-name">id</span>></span>start<span class="hljs-tag"></<span class="hljs-name">id</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goal</span>></span>cli<span class="hljs-tag"></<span class="hljs-name">goal</span>></span> + <span class="hljs-tag"></<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"><<span class="hljs-name">spawn</span>></span>true<span class="hljs-tag"></<span class="hljs-name">spawn</span>></span> + <span class="hljs-tag"><<span class="hljs-name">ignore</span>></span>${noServer}<span class="hljs-tag"></<span class="hljs-name">ignore</span>></span> + <span class="hljs-tag"><<span class="hljs-name">testURI</span>></span>tcp://localhost:61616<span class="hljs-tag"></<span class="hljs-name">testURI</span>></span> + <span class="hljs-tag"><<span class="hljs-name">args</span>></span> + <span class="hljs-tag"><<span class="hljs-name">param</span>></span>run<span class="hljs-tag"></<span class="hljs-name">param</span>></span> + <span class="hljs-tag"></<span class="hljs-name">args</span>></span> + <span class="hljs-tag"></<span class="hljs-name">configuration</span>></span> +<span class="hljs-tag"></<span class="hljs-name">execution</span>></span> +</code></pre> +<h3 id="runclient-goal">runClient goal</h3> +<p>This is a simple solution for running classes implementing the main method.</p> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left">clientClass</td> +<td style="text-align:left">A class implement a static void main(String arg[])</td> +</tr> +<tr> +<td style="text-align:left">args</td> +<td style="text-align:left">A string array of arguments passed to the method</td> +</tr> +</tbody> +</table> +<p>Example:</p> +<pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"><<span class="hljs-name">id</span>></span>runClient<span class="hljs-tag"></<span class="hljs-name">id</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goal</span>></span>runClient<span class="hljs-tag"></<span class="hljs-name">goal</span>></span> + <span class="hljs-tag"></<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"><<span class="hljs-name">clientClass</span>></span>org.apache.activemq.artemis.jms.example.QueueExample<span class="hljs-tag"></<span class="hljs-name">clientClass</span>></span> + <span class="hljs-tag"></<span class="hljs-name">configuration</span>></span> +<span class="hljs-tag"></<span class="hljs-name">execution</span>></span> +</code></pre> +<h3 id="complete-example">Complete example</h3> +<p>The following example is a copy of the /examples/features/standard/queue example. You may refer to it directly under the examples directory tree.</p> +<pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">project</span> <span class="hljs-attr">xmlns</span>=<span class="hljs-string">"http://maven.apache.org/POM/4.0.0"</span> <span class="hljs-attr">xmlns:xsi</span>=<span class="hljs-string">"http://www.w3.org/2001/XMLSchema-instance"</span> + <span class="hljs-attr">xsi:schemaLocation</span>=<span class="hljs-string">"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"</span>></span> + <span class="hljs-tag"><<span class="hljs-name">modelVersion</span>></span>4.0.0<span class="hljs-tag"></<span class="hljs-name">modelVersion</span>></span> + + <span class="hljs-tag"><<span class="hljs-name">parent</span>></span> + <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.apache.activemq.examples.broker<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span> + <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>jms-examples<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span> + <span class="hljs-tag"><<span class="hljs-name">version</span>></span>1.1.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span> + <span class="hljs-tag"></<span class="hljs-name">parent</span>></span> + + <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>queue<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span> + <span class="hljs-tag"><<span class="hljs-name">packaging</span>></span>jar<span class="hljs-tag"></<span class="hljs-name">packaging</span>></span> + <span class="hljs-tag"><<span class="hljs-name">name</span>></span>ActiveMQ Artemis JMS Queue Example<span class="hljs-tag"></<span class="hljs-name">name</span>></span> + + <span class="hljs-tag"><<span class="hljs-name">properties</span>></span> + <span class="hljs-tag"><<span class="hljs-name">activemq.basedir</span>></span>${project.basedir}/../../../..<span class="hljs-tag"></<span class="hljs-name">activemq.basedir</span>></span> + <span class="hljs-tag"></<span class="hljs-name">properties</span>></span> + + <span class="hljs-tag"><<span class="hljs-name">dependencies</span>></span> + <span class="hljs-tag"><<span class="hljs-name">dependency</span>></span> + <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.apache.activemq<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span> + <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>artemis-jms-client<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span> + <span class="hljs-tag"><<span class="hljs-name">version</span>></span>${project.version}<span class="hljs-tag"></<span class="hljs-name">version</span>></span> + <span class="hljs-tag"></<span class="hljs-name">dependency</span>></span> + <span class="hljs-tag"></<span class="hljs-name">dependencies</span>></span> + + <span class="hljs-tag"><<span class="hljs-name">build</span>></span> + <span class="hljs-tag"><<span class="hljs-name">plugins</span>></span> + <span class="hljs-tag"><<span class="hljs-name">plugin</span>></span> + <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.apache.activemq<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span> + <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>artemis-maven-plugin<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span> + <span class="hljs-tag"><<span class="hljs-name">executions</span>></span> + <span class="hljs-tag"><<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"><<span class="hljs-name">id</span>></span>create<span class="hljs-tag"></<span class="hljs-name">id</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goal</span>></span>create<span class="hljs-tag"></<span class="hljs-name">goal</span>></span> + <span class="hljs-tag"></<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"><<span class="hljs-name">ignore</span>></span>${noServer}<span class="hljs-tag"></<span class="hljs-name">ignore</span>></span> + <span class="hljs-tag"></<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"></<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"><<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"><<span class="hljs-name">id</span>></span>start<span class="hljs-tag"></<span class="hljs-name">id</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goal</span>></span>cli<span class="hljs-tag"></<span class="hljs-name">goal</span>></span> + <span class="hljs-tag"></<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"><<span class="hljs-name">spawn</span>></span>true<span class="hljs-tag"></<span class="hljs-name">spawn</span>></span> + <span class="hljs-tag"><<span class="hljs-name">ignore</span>></span>${noServer}<span class="hljs-tag"></<span class="hljs-name">ignore</span>></span> + <span class="hljs-tag"><<span class="hljs-name">testURI</span>></span>tcp://localhost:61616<span class="hljs-tag"></<span class="hljs-name">testURI</span>></span> + <span class="hljs-tag"><<span class="hljs-name">args</span>></span> + <span class="hljs-tag"><<span class="hljs-name">param</span>></span>run<span class="hljs-tag"></<span class="hljs-name">param</span>></span> + <span class="hljs-tag"></<span class="hljs-name">args</span>></span> + <span class="hljs-tag"></<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"></<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"><<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"><<span class="hljs-name">id</span>></span>runClient<span class="hljs-tag"></<span class="hljs-name">id</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goal</span>></span>runClient<span class="hljs-tag"></<span class="hljs-name">goal</span>></span> + <span class="hljs-tag"></<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"><<span class="hljs-name">clientClass</span>></span>org.apache.activemq.artemis.jms.example.QueueExample<span class="hljs-tag"></<span class="hljs-name">clientClass</span>></span> + <span class="hljs-tag"></<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"></<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"><<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"><<span class="hljs-name">id</span>></span>stop<span class="hljs-tag"></<span class="hljs-name">id</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">goal</span>></span>cli<span class="hljs-tag"></<span class="hljs-name">goal</span>></span> + <span class="hljs-tag"></<span class="hljs-name">goals</span>></span> + <span class="hljs-tag"><<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"><<span class="hljs-name">ignore</span>></span>${noServer}<span class="hljs-tag"></<span class="hljs-name">ignore</span>></span> + <span class="hljs-tag"><<span class="hljs-name">args</span>></span> + <span class="hljs-tag"><<span class="hljs-name">param</span>></span>stop<span class="hljs-tag"></<span class="hljs-name">param</span>></span> + <span class="hljs-tag"></<span class="hljs-name">args</span>></span> + <span class="hljs-tag"></<span class="hljs-name">configuration</span>></span> + <span class="hljs-tag"></<span class="hljs-name">execution</span>></span> + <span class="hljs-tag"></<span class="hljs-name">executions</span>></span> + <span class="hljs-tag"><<span class="hljs-name">dependencies</span>></span> + <span class="hljs-tag"><<span class="hljs-name">dependency</span>></span> + <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.apache.activemq.examples.broker<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span> + <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>queue<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span> + <span class="hljs-tag"><<span class="hljs-name">version</span>></span>${project.version}<span class="hljs-tag"></<span class="hljs-name">version</span>></span> + <span class="hljs-tag"></<span class="hljs-name">dependency</span>></span> + <span class="hljs-tag"></<span class="hljs-name">dependencies</span>></span> + <span class="hljs-tag"></<span class="hljs-name">plugin</span>></span> + <span class="hljs-tag"></<span class="hljs-name">plugins</span>></span> + <span class="hljs-tag"></<span class="hljs-name">build</span>></span> + +<span class="hljs-tag"></<span class="hljs-name">project</span>></span> +</code></pre> + + + </section> + + </div> + <div class="search-results"> + <div class="has-results"> + + <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> + <ul class="search-results-list"></ul> + + </div> + <div class="no-results"> + + <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> + + </div> + </div> +</div> + + </div> + </div> + + </div> + + + + <a href="tools.html" class="navigation navigation-prev " aria-label="Previous page: Tools"> + <i class="fa fa-angle-left"></i> + </a> + + + <a href="unit-testing.html" class="navigation navigation-next " aria-label="Next page: Unit Testing"> + <i class="fa fa-angle-right"></i> + </a> + + + + </div> + + <script> + var gitbook = gitbook || []; + gitbook.push(function() { + gitbook.page.hasChanged({"page":{"title":"Maven Plugin","level":"1.61","depth":1,"next":{"title":"Unit Testing","level":"1.62","depth":1,"path":"unit-testing.md","ref":"unit-testing.md","articles":[]},"previous":{"title":"Tools","level":"1.60","depth":1,"path":"tools.md","ref":"tools.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.c ss"},"showLevel":false}},"github":"apache/activemq-artemis","theme":"default","githubHost":"https://github.com/","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"ActiveMQ Artemis Documentation","links":{"home":"http://activemq.apache.org/artemis","issues":"https://issues.apache.org/jira/browse/ARTEMIS","contribute":"http://activemq.apache.org/contributing.html"},"gitbook":"3.x.x","description":"ActiveMQ Artemis User Guide and Reference Documentation"},"file":{"path":"maven-plugin.md","mtime":"2017-08-02T14:46:10.000Z","type":"markdown"},"gitbook":{"version":"3.1.1","time":"2017-09-14T19:42:32.953Z"},"basePath":".","book":{"language":""}}); + }); + </script> +</div> + + + <script src="gitbook/gitbook.js"></script> + <script src="gitbook/theme.js"></script> + + + <script src="gitbook/gitbook-plugin-search/search-engine.js"></script> + + + + <script src="gitbook/gitbook-plugin-search/search.js"></script> + + + + <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script> + + + + <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script> + + + + <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script> + + + + <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script> + + + + </body> +</html> +
Added: websites/production/activemq/content/artemis/docs/latest/message-expiry.html ============================================================================== --- websites/production/activemq/content/artemis/docs/latest/message-expiry.html (added) +++ websites/production/activemq/content/artemis/docs/latest/message-expiry.html Thu Sep 14 19:48:11 2017 @@ -0,0 +1,1121 @@ + +<!DOCTYPE HTML> +<html lang="" > + <head> + <title>Message Expiry · ActiveMQ Artemis Documentation</title> + <meta charset="UTF-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge" /> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + <meta name="description" content=""> + <meta name="generator" content="GitBook 3.1.1"> + + + + + <link rel="stylesheet" href="gitbook/style.css"> + + + + + <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css"> + + + + <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css"> + + + + <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css"> + + + + + + + + + + + + + + + + + + + + + + + + <meta name="HandheldFriendly" content="true"/> + <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> + <meta name="apple-mobile-web-app-capable" content="yes"> + <meta name="apple-mobile-web-app-status-bar-style" content="black"> + <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png"> + <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon"> + + + <link rel="next" href="large-messages.html" /> + + + <link rel="prev" href="undelivered-messages.html" /> + + + </head> + <body> + +<div class="book"> + <div class="book-summary"> + + +<div id="book-search-input" role="search"> + <input type="text" placeholder="Type to search" /> +</div> + + + <nav role="navigation"> + + + +<ul class="summary"> + + + + + + + + + + <li class="chapter " data-level="1.1" data-path="./"> + + <a href="./"> + + + Introduction + + </a> + + + + </li> + + <li class="chapter " data-level="1.2" data-path="notice.html"> + + <a href="notice.html"> + + + Legal Notice + + </a> + + + + </li> + + <li class="chapter " data-level="1.3" data-path="preface.html"> + + <a href="preface.html"> + + + Preface + + </a> + + + + </li> + + <li class="chapter " data-level="1.4" data-path="project-info.html"> + + <a href="project-info.html"> + + + Project Info + + </a> + + + + </li> + + <li class="chapter " data-level="1.5" data-path="messaging-concepts.html"> + + <a href="messaging-concepts.html"> + + + Messaging Concepts + + </a> + + + + </li> + + <li class="chapter " data-level="1.6" data-path="architecture.html"> + + <a href="architecture.html"> + + + Architecture + + </a> + + + + </li> + + <li class="chapter " data-level="1.7" data-path="using-server.html"> + + <a href="using-server.html"> + + + Using the Server + + </a> + + + + </li> + + <li class="chapter " data-level="1.8" data-path="address-model.html"> + + <a href="address-model.html"> + + + Address Model + + </a> + + + + </li> + + <li class="chapter " data-level="1.9" data-path="using-jms.html"> + + <a href="using-jms.html"> + + + Using JMS + + </a> + + + + </li> + + <li class="chapter " data-level="1.10" data-path="using-core.html"> + + <a href="using-core.html"> + + + Using Core + + </a> + + + + </li> + + <li class="chapter " data-level="1.11" data-path="using-AMQP.html"> + + <a href="using-AMQP.html"> + + + Using AMQP + + </a> + + + + </li> + + <li class="chapter " data-level="1.12" data-path="jms-core-mapping.html"> + + <a href="jms-core-mapping.html"> + + + Mapping JMS Concepts to the Core API + + </a> + + + + </li> + + <li class="chapter " data-level="1.13" data-path="client-classpath.html"> + + <a href="client-classpath.html"> + + + The Client Classpath + + </a> + + + + </li> + + <li class="chapter " data-level="1.14" data-path="examples.html"> + + <a href="examples.html"> + + + Examples + + </a> + + + + </li> + + <li class="chapter " data-level="1.15" data-path="wildcard-routing.html"> + + <a href="wildcard-routing.html"> + + + Routing Messages With Wild Cards + + </a> + + + + </li> + + <li class="chapter " data-level="1.16" data-path="wildcard-syntax.html"> + + <a href="wildcard-syntax.html"> + + + Understanding the Apache ActiveMQ Artemis Wildcard Syntax + + </a> + + + + </li> + + <li class="chapter " data-level="1.17" data-path="filter-expressions.html"> + + <a href="filter-expressions.html"> + + + Filter Expressions + + </a> + + + + </li> + + <li class="chapter " data-level="1.18" data-path="persistence.html"> + + <a href="persistence.html"> + + + Persistence + + </a> + + + + </li> + + <li class="chapter " data-level="1.19" data-path="configuring-transports.html"> + + <a href="configuring-transports.html"> + + + Configuring Transports + + </a> + + + + </li> + + <li class="chapter " data-level="1.20" data-path="config-reload.html"> + + <a href="config-reload.html"> + + + Configuration Reload + + </a> + + + + </li> + + <li class="chapter " data-level="1.21" data-path="connection-ttl.html"> + + <a href="connection-ttl.html"> + + + Detecting Dead Connections + + </a> + + + + </li> + + <li class="chapter " data-level="1.22" data-path="slow-consumers.html"> + + <a href="slow-consumers.html"> + + + Detecting Slow Consumers + + </a> + + + + </li> + + <li class="chapter " data-level="1.23" data-path="network-isolation.html"> + + <a href="network-isolation.html"> + + + Avoiding Network Isolation + + </a> + + + + </li> + + <li class="chapter " data-level="1.24" data-path="critical-analysis.html"> + + <a href="critical-analysis.html"> + + + Detecting Broker Issues (Critical Analysis) + + </a> + + + + </li> + + <li class="chapter " data-level="1.25" data-path="transaction-config.html"> + + <a href="transaction-config.html"> + + + Resource Manager Configuration + + </a> + + + + </li> + + <li class="chapter " data-level="1.26" data-path="flow-control.html"> + + <a href="flow-control.html"> + + + Flow Control + + </a> + + + + </li> + + <li class="chapter " data-level="1.27" data-path="send-guarantees.html"> + + <a href="send-guarantees.html"> + + + Guarantees of sends and commits + + </a> + + + + </li> + + <li class="chapter " data-level="1.28" data-path="undelivered-messages.html"> + + <a href="undelivered-messages.html"> + + + Message Redelivery and Undelivered Messages + + </a> + + + + </li> + + <li class="chapter active" data-level="1.29" data-path="message-expiry.html"> + + <a href="message-expiry.html"> + + + Message Expiry + + </a> + + + + </li> + + <li class="chapter " data-level="1.30" data-path="large-messages.html"> + + <a href="large-messages.html"> + + + Large Messages + + </a> + + + + </li> + + <li class="chapter " data-level="1.31" data-path="paging.html"> + + <a href="paging.html"> + + + Paging + + </a> + + + + </li> + + <li class="chapter " data-level="1.32" data-path="queue-attributes.html"> + + <a href="queue-attributes.html"> + + + Queue Attributes + + </a> + + + + </li> + + <li class="chapter " data-level="1.33" data-path="scheduled-messages.html"> + + <a href="scheduled-messages.html"> + + + Scheduled Messages + + </a> + + + + </li> + + <li class="chapter " data-level="1.34" data-path="last-value-queues.html"> + + <a href="last-value-queues.html"> + + + Last-Value Queues + + </a> + + + + </li> + + <li class="chapter " data-level="1.35" data-path="message-grouping.html"> + + <a href="message-grouping.html"> + + + Message Grouping + + </a> + + + + </li> + + <li class="chapter " data-level="1.36" data-path="pre-acknowledge.html"> + + <a href="pre-acknowledge.html"> + + + Extra Acknowledge Modes + + </a> + + + + </li> + + <li class="chapter " data-level="1.37" data-path="management.html"> + + <a href="management.html"> + + + Management + + </a> + + + + </li> + + <li class="chapter " data-level="1.38" data-path="management-console.html"> + + <a href="management-console.html"> + + + Management Console + + </a> + + + + </li> + + <li class="chapter " data-level="1.39" data-path="security.html"> + + <a href="security.html"> + + + Security + + </a> + + + + </li> + + <li class="chapter " data-level="1.40" data-path="broker-plugins.html"> + + <a href="broker-plugins.html"> + + + Broker Plugins + + </a> + + + + </li> + + <li class="chapter " data-level="1.41" data-path="resource-limits.html"> + + <a href="resource-limits.html"> + + + Resource Limits + + </a> + + + + </li> + + <li class="chapter " data-level="1.42" data-path="jms-bridge.html"> + + <a href="jms-bridge.html"> + + + The JMS Bridge + + </a> + + + + </li> + + <li class="chapter " data-level="1.43" data-path="client-reconnection.html"> + + <a href="client-reconnection.html"> + + + Client Reconnection and Session Reattachment + + </a> + + + + </li> + + <li class="chapter " data-level="1.44" data-path="diverts.html"> + + <a href="diverts.html"> + + + Diverting and Splitting Message Flows + + </a> + + + + </li> + + <li class="chapter " data-level="1.45" data-path="core-bridges.html"> + + <a href="core-bridges.html"> + + + Core Bridges + + </a> + + + + </li> + + <li class="chapter " data-level="1.46" data-path="duplicate-detection.html"> + + <a href="duplicate-detection.html"> + + + Duplicate Message Detection + + </a> + + + + </li> + + <li class="chapter " data-level="1.47" data-path="clusters.html"> + + <a href="clusters.html"> + + + Clusters + + </a> + + + + </li> + + <li class="chapter " data-level="1.48" data-path="ha.html"> + + <a href="ha.html"> + + + High Availability and Failover + + </a> + + + + </li> + + <li class="chapter " data-level="1.49" data-path="graceful-shutdown.html"> + + <a href="graceful-shutdown.html"> + + + Graceful Server Shutdown + + </a> + + + + </li> + + <li class="chapter " data-level="1.50" data-path="libaio.html"> + + <a href="libaio.html"> + + + Libaio Native Libraries + + </a> + + + + </li> + + <li class="chapter " data-level="1.51" data-path="thread-pooling.html"> + + <a href="thread-pooling.html"> + + + Thread management + + </a> + + + + </li> + + <li class="chapter " data-level="1.52" data-path="logging.html"> + + <a href="logging.html"> + + + Logging + + </a> + + + + </li> + + <li class="chapter " data-level="1.53" data-path="rest.html"> + + <a href="rest.html"> + + + REST Interface + + </a> + + + + </li> + + <li class="chapter " data-level="1.54" data-path="embedding-activemq.html"> + + <a href="embedding-activemq.html"> + + + Embedding Apache ActiveMQ Artemis + + </a> + + + + </li> + + <li class="chapter " data-level="1.55" data-path="karaf.html"> + + <a href="karaf.html"> + + + Apache Karaf + + </a> + + + + </li> + + <li class="chapter " data-level="1.56" data-path="spring-integration.html"> + + <a href="spring-integration.html"> + + + Spring Integration + + </a> + + + + </li> + + <li class="chapter " data-level="1.57" data-path="cdi-integration.html"> + + <a href="cdi-integration.html"> + + + CDI Integration + + </a> + + + + </li> + + <li class="chapter " data-level="1.58" data-path="intercepting-operations.html"> + + <a href="intercepting-operations.html"> + + + Intercepting Operations + + </a> + + + + </li> + + <li class="chapter " data-level="1.59" data-path="protocols-interoperability.html"> + + <a href="protocols-interoperability.html"> + + + Protocols and Interoperability + + </a> + + + + </li> + + <li class="chapter " data-level="1.60" data-path="tools.html"> + + <a href="tools.html"> + + + Tools + + </a> + + + + </li> + + <li class="chapter " data-level="1.61" data-path="maven-plugin.html"> + + <a href="maven-plugin.html"> + + + Maven Plugin + + </a> + + + + </li> + + <li class="chapter " data-level="1.62" data-path="unit-testing.html"> + + <a href="unit-testing.html"> + + + Unit Testing + + </a> + + + + </li> + + <li class="chapter " data-level="1.63" data-path="perf-tuning.html"> + + <a href="perf-tuning.html"> + + + Troubleshooting and Performance Tuning + + </a> + + + + </li> + + <li class="chapter " data-level="1.64" data-path="configuration-index.html"> + + <a href="configuration-index.html"> + + + Configuration Reference + + </a> + + + + </li> + + <li class="chapter " data-level="1.65" data-path="updating-artemis.html"> + + <a href="updating-artemis.html"> + + + Updating Artemis + + </a> + + + + </li> + + + + + <li class="divider"></li> + + <li> + <a href="https://www.gitbook.com"; target="blank" class="gitbook-link"> + Published with GitBook + </a> + </li> +</ul> + + + </nav> + + + </div> + + <div class="book-body"> + + <div class="body-inner"> + + + +<div class="book-header" role="navigation"> + + + <!-- Title --> + <h1> + <i class="fa fa-circle-o-notch fa-spin"></i> + <a href="." >Message Expiry</a> + </h1> +</div> + + + + + <div class="page-wrapper" tabindex="-1" role="main"> + <div class="page-inner"> + +<div id="book-search-results"> + <div class="search-noresults"> + + <section class="normal markdown-section"> + + <h1 id="message-expiry">Message Expiry</h1> +<p>Messages can be set with an optional <em>time to live</em> when sending them.</p> +<p>Apache ActiveMQ Artemis will not deliver a message to a consumer after it's time to +live has been exceeded. If the message hasn't been delivered by the time +that time to live is reached the server can discard it.</p> +<p>Apache ActiveMQ Artemis's addresses can be assigned a expiry address so that, when +messages are expired, they are removed from the queue and sent to the +expiry address. Many different queues can be bound to an expiry address. +These <em>expired</em> messages can later be consumed for further inspection.</p> +<h2 id="message-expiry">Message Expiry</h2> +<p>Using Apache ActiveMQ Artemis Core API, you can set an expiration time directly on the +message:</p> +<pre><code>// message will expire in 5000ms from now +message.setExpiration(System.currentTimeMillis() + 5000); +</code></pre><p>JMS MessageProducer allows to set a TimeToLive for the messages it sent:</p> +<pre><code>// messages sent by this producer will be retained for 5s (5000ms) before expiration +producer.setTimeToLive(5000); +</code></pre><p>Expired messages which are consumed from an expiry address have the +following properties:</p> +<ul> +<li><p><code>_AMQ_ORIG_ADDRESS</code></p> +<p>a String property containing the <em>original address</em> of the expired +message</p> +</li> +<li><p><code>_AMQ_ORIG_QUEUE</code></p> +<p>a String property containing the <em>original queue</em> of the expired +message</p> +</li> +<li><p><code>_AMQ_ACTUAL_EXPIRY</code></p> +<p>a Long property containing the <em>actual expiration time</em> of the +expired message</p> +</li> +</ul> +<h2 id="configuring-expiry-addresses">Configuring Expiry Addresses</h2> +<p>Expiry address are defined in the address-setting configuration:</p> +<pre><code><!-- expired messages in exampleQueue will be sent to the expiry address expiryQueue --> +<address-setting match="exampleQueue"> + <expiry-address>expiryQueue</expiry-address> +</address-setting> +</code></pre><p>If messages are expired and no expiry address is specified, messages are +simply removed from the queue and dropped. Address wildcards can be used +to configure expiry address for a set of addresses (see <a href="wildcard-syntax.html">Understanding the Wildcard Syntax</a>).</p> +<h2 id="configuring-the-expiry-reaper-thread">Configuring The Expiry Reaper Thread</h2> +<p>A reaper thread will periodically inspect the queues to check if +messages have expired.</p> +<p>The reaper thread can be configured with the following properties in +<code>broker.xml</code></p> +<ul> +<li><p><code>message-expiry-scan-period</code></p> +<p>How often the queues will be scanned to detect expired messages (in +milliseconds, default is 30000ms, set to <code>-1</code> to disable the reaper +thread)</p> +</li> +<li><p><code>message-expiry-thread-priority</code></p> +<p>The reaper thread priority (it must be between 1 and 10, 10 being the +highest priority, default is 3)</p> +</li> +</ul> +<h2 id="example">Example</h2> +<p>See the <a href="examples.html">examples.md</a> chapter for an example which shows how message expiry is configured and used with JMS.</p> + + + </section> + + </div> + <div class="search-results"> + <div class="has-results"> + + <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> + <ul class="search-results-list"></ul> + + </div> + <div class="no-results"> + + <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> + + </div> + </div> +</div> + + </div> + </div> + + </div> + + + + <a href="undelivered-messages.html" class="navigation navigation-prev " aria-label="Previous page: Message Redelivery and Undelivered Messages"> + <i class="fa fa-angle-left"></i> + </a> + + + <a href="large-messages.html" class="navigation navigation-next " aria-label="Next page: Large Messages"> + <i class="fa fa-angle-right"></i> + </a> + + + + </div> + + <script> + var gitbook = gitbook || []; + gitbook.push(function() { + gitbook.page.hasChanged({"page":{"title":"Message Expiry","level":"1.29","depth":1,"next":{"title":"Large Messages","level":"1.30","depth":1,"path":"large-messages.md","ref":"large-messages.md","articles":[]},"previous":{"title":"Message Redelivery and Undelivered Messages","level":"1.28","depth":1,"path":"undelivered-messages.md","ref":"undelivered-messages.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css" ,"mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"github":"apache/activemq-artemis","theme":"default","githubHost":"https://github.com/","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"ActiveMQ Artemis Documentation","links":{"home":"http://activemq.apache.org/artemis","issues":"https://issues.apache.org/jira/browse/ARTEMIS","contribute":"http://activemq.apache.org/contributing.html"},"gitbook":"3.x.x","description":"ActiveMQ Artemis User Guide and Reference Documentation"},"file":{"path":"message-expiry.md","mtime":"2017-09-08T01:26:53.000Z","type":"markdown"},"gitbook":{"version":"3.1.1","time":"2017-09-14T19:42:32.953Z"},"basePath":".","book":{"language":""}}); + }); + </script> +</div> + + + <script src="gitbook/gitbook.js"></script> + <script src="gitbook/theme.js"></script> + + + <script src="gitbook/gitbook-plugin-search/search-engine.js"></script> + + + + <script src="gitbook/gitbook-plugin-search/search.js"></script> + + + + <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script> + + + + <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script> + + + + <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script> + + + + <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script> + + + + </body> +</html> +
