blob: f329720f17b9563a4008cce1cf27b6c370c79dfb [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>ActiveMQ</title>
<link rel="icon" type="image/png" href="/assets/img/favicon.png">
<link rel="stylesheet" href="/css/main.css">
<script defer src="https://use.fontawesome.com/releases/v5.0.8/js/all.js" integrity="sha384-SlE991lGASHoBfWbelyBPLsUlwY1GwNDJo3jSJO04KZ33K2bwfV9YBauFfnzvynJ" crossorigin="anonymous"></script>
<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js" integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q" crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
</head>
<body>
<nav class="navbar navbar-expand-lg navbar-light fixed-top">
<div class="container">
<!-- <a class="navbar-brand mr-auto" href="#"><img style="height: 50px" src="assets/img/apache-feather.png" /></a> -->
<a class="navbar-brand mr-auto" href="/"><img src="/assets/img/activemq_logo_black_small.png" style="height: 50px"/></a>
<button class="navbar-toggler ml-auto" type="button" data-toggle="collapse" data-target="#navbarContent" aria-controls="navbarContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="ml-auto collapse navbar-collapse" id="navbarContent">
<ul class="navbar-nav ml-auto">
<li class="nav-item">
<a class="nav-link active" href="/index.html">Home</a>
</li>
<li class="nav-item dropdown">
<a class="nav-link" id="navbarDropdownComponents" data-target="#" href="" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Components</a>
<ul class="dropdown-menu dropdown-menu-center" aria-labelledby="navbarDropdownComponents">
<div class="row">
<div class="col-12">
<ul class="multi-column-dropdown">
<li class="nav-item"><a class="dropdown-item" href="/components/classic">ActiveMQ 5</a></li>
<li class="nav-item"><a class="dropdown-item" href="/components/artemis/">ActiveMQ Artemis</a></li>
<li class="nav-item"><a class="dropdown-item" href="/components/nms">NMS Clients</a></li>
<li class="nav-item"><a class="dropdown-item" href="/components/cms">CMS Client</a></li>
</ul>
</div>
</div>
</ul>
</li>
<li class="nav-item dropdown">
<a class="nav-link" id="navbarDropdownCommunity" data-target="#" href="" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Contact</a>
<ul class="dropdown-menu dropdown-menu-center multi-column columns-1" aria-labelledby="navbarDropdownCommunity">
<div class="row">
<div class="col-12">
<ul class="multi-column-dropdown">
<li class="nav-item"><a class="dropdown-item" href="/contact#mailing">Mailing Lists</a></li>
<li class="nav-item"><a class="dropdown-item" href="/contact#chat">Chat</a></li>
<li class="nav-item"><a class="dropdown-item" href="/contact#issues">Report Issues</a></li>
<li class="nav-item"><a class="dropdown-item" href="/contact#contributing">Contributing</a></li>
<li class="nav-item"><a class="dropdown-item" href="/security-advisories.html">Security</a></li>
</ul>
</div>
</div>
</ul>
</li>
<li class="nav-item dropdown">
<a class="nav-link" id="navbarDropdownTeam" data-target="#" href="" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Apache</a>
<ul class="dropdown-menu dropdown-menu-center multi-column columns-1" aria-labelledby="navbarDropdownTeam">
<div class="row">
<div class="col-sm-12">
<ul class="multi-column-dropdown">
<li class="nav-item"><a class="dropdown-item" href="https://www.apache.org">The Apache Software Foundation</a></li>
<li class="nav-item"><a class="dropdown-item" href="https://www.apache.org/licenses/">License</a></li>
<li class="nav-item"><a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
<li class="nav-item"><a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a></li>
<li class="nav-item"><a class="dropdown-item" href="/security-advisories.html">Security</a></li>
<li class="nav-item"><a class="dropdown-item" href="https://www.apache.org/events/current-event">Events</a></li>
<li class="nav-item"><a class="dropdown-item" href="https://people.apache.org/phonebook.html?pmc=activemq">PMC & Committers</a></li>
<li class="nav-item"><a class="dropdown-item" href="/team/reports">Board Reports</a></li>
</ul>
</div>
</div>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<div class="content">
<div class="page-title-activemq5">
<div class="container">
<h1>ActiveMQ Message Properties</h1>
</div>
</div>
<div class="container" >
<div class="row" style="margin-top: 30px">
<div class="col-12 activemq5">
<p><a href="features">Features</a> &gt; <a href="message-features">Message Features</a> &gt; <a href="activemq-message-properties">ActiveMQ Message Properties</a></p>
<p><strong>ActiveMQ Messages support the following default message properties:</strong></p>
<h2 id="message-attributes-accessed-as-properties">Message Attributes Accessed as Properties:</h2>
<table>
<thead>
<tr>
<th>Property Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">JMSDestination</code></td>
<td><code class="highlighter-rouge">javax.jms.Destination</code></td>
<td><em>Set by the producer</em></td>
<td>Destination used by the producer.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSReplyTo</code></td>
<td><code class="highlighter-rouge">javax.jms.Destination</code></td>
<td><code class="highlighter-rouge">null</code></td>
<td>User defined.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSType</code></td>
<td><code class="highlighter-rouge">String</code></td>
<td><code class="highlighter-rouge">""</code></td>
<td>User defined.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSDeliveryMode</code></td>
<td><code class="highlighter-rouge">int</code></td>
<td><code class="highlighter-rouge">DeliveryMode.PERSISTENT</code></td>
<td>Indicator if messages should be persisted.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSPriority</code></td>
<td><code class="highlighter-rouge">int</code></td>
<td><code class="highlighter-rouge">4</code></td>
<td>Value from <code class="highlighter-rouge">0-9</code>.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSMessageID</code></td>
<td><code class="highlighter-rouge">String</code></td>
<td><code class="highlighter-rouge">unique</code></td>
<td>Unique identifier for the message.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSTimestamp</code></td>
<td><code class="highlighter-rouge">long</code></td>
<td><em>Time the message was sent</em></td>
<td>Time in milliseconds.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSCorrelationID</code></td>
<td><code class="highlighter-rouge">String</code></td>
<td><code class="highlighter-rouge">null</code></td>
<td>User defined.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSExpiration</code></td>
<td><code class="highlighter-rouge">long</code></td>
<td><code class="highlighter-rouge">0</code></td>
<td>Time in milliseconds to expire the message. A value of <code class="highlighter-rouge">0</code> means never expire.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSRedelivered</code></td>
<td><code class="highlighter-rouge">boolean</code></td>
<td><code class="highlighter-rouge">false</code></td>
<td><code class="highlighter-rouge">true</code> if the message is being resent to the consumer, persisted via <a href="per-destination-policies">persistJMSRedelivered</a></td>
</tr>
</tbody>
</table>
<h2 id="jms-defined">JMS Defined:</h2>
<table>
<thead>
<tr>
<th>Property Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">JMSXDeliveryCount</code></td>
<td><code class="highlighter-rouge">int</code></td>
<td><code class="highlighter-rouge">0</code></td>
<td>Number of attempts to send the message.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSXGroupID</code></td>
<td><code class="highlighter-rouge">String</code></td>
<td><code class="highlighter-rouge">null</code></td>
<td>Identity of the message group.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSXGroupSeq</code></td>
<td><code class="highlighter-rouge">int</code></td>
<td><code class="highlighter-rouge">0</code></td>
<td>Sequence number of the message.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSXProducerTXID</code></td>
<td><code class="highlighter-rouge">String</code></td>
<td><code class="highlighter-rouge">null</code></td>
<td>Transaction identifier.</td>
</tr>
</tbody>
</table>
<h2 id="activemq-defined">ActiveMQ Defined:</h2>
<table>
<thead>
<tr>
<th>Property Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">JMSActiveMQBrokerInTime</code></td>
<td><code class="highlighter-rouge">long</code></td>
<td><code class="highlighter-rouge">0</code></td>
<td>Time stamp (in milliseconds) for when the message arrived at the broker.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">JMSActiveMQBrokerOutTime</code></td>
<td><code class="highlighter-rouge">long</code></td>
<td><code class="highlighter-rouge">0</code></td>
<td>Time stamp (in milliseconds) for when the message left the broker.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="row sitemap">
<div class="col-sm-12">
<div class="container">
<div class="row">
<div class="col-sm-12">
<div class="row">
<div class="col-sm-3">
<div >
<img class="float-left" style="max-height: 100px" src="/assets/img/activemq_logo_white_vertical_small.png"/>
</div>
</div>
<div style="text-align: center; margin-bottom: 0px; margin-top: 30px; font-size: 65%" class="col-sm-6">
<p>Apache ActiveMQ, ActiveMQ, ActiveMQ Artemis, Apache, the Apache feather logo, and the Apache ActiveMQ project logo are trademarks of The Apache Software Foundation. Copyright &copy; 2019, The Apache Software Foundation. Licensed under <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</a>.</p>
</div>
<div class="col-sm-3">
<div >
<a href="https://www.apache.org"><img class="float-right" style="margin-top: 10px; max-height: 80px" src="/assets/img/apache-logo-small.png"/></a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>