| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Message (ActiveMQ Artemis Website 2.33.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Message (ActiveMQ Artemis Website 2.33.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":18,"i1":18,"i2":6,"i3":6,"i4":6,"i5":6,"i6":18,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":18,"i13":50,"i14":50,"i15":6,"i16":6,"i17":18,"i18":6,"i19":6,"i20":6,"i21":6,"i22":18,"i23":18,"i24":6,"i25":6,"i26":18,"i27":18,"i28":6,"i29":6,"i30":6,"i31":18,"i32":6,"i33":6,"i34":18,"i35":18,"i36":18,"i37":6,"i38":6,"i39":18,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":18,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":18,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":18,"i63":6,"i64":6,"i65":6,"i66":50,"i67":6,"i68":6,"i69":6,"i70":18,"i71":18,"i72":18,"i73":6,"i74":18,"i75":18,"i76":6,"i77":6,"i78":6,"i79":6,"i80":6,"i81":6,"i82":6,"i83":6,"i84":6,"i85":6,"i86":6,"i87":6,"i88":6,"i89":18,"i90":6,"i91":6,"i92":6,"i93":6,"i94":6,"i95":6,"i96":6,"i97":6,"i98":6,"i99":6,"i100":6,"i101":6,"i102":6,"i103":6,"i104":18,"i105":6,"i106":18,"i107":6,"i108":18,"i109":6,"i110":18,"i111":18,"i112":6,"i113":6,"i114":6,"i115":6,"i116":6,"i117":18,"i118":18,"i119":18,"i120":18,"i121":6,"i122":6,"i123":18,"i124":18,"i125":18,"i126":18,"i127":18,"i128":6,"i129":6,"i130":6,"i131":6,"i132":6,"i133":18,"i134":18,"i135":6,"i136":50,"i137":6,"i138":6,"i139":18,"i140":18,"i141":6,"i142":6,"i143":18,"i144":18,"i145":18,"i146":18,"i147":6,"i148":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Message.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.activemq.artemis.api.core</a></div> |
| <h2 title="Interface Message" class="title">Interface Message</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a></code>, <code><a href="ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Message</span></pre> |
| <div class="block">A Message is a routable instance that has a payload. |
| <p> |
| The payload (the "body") is opaque to the messaging system. A Message also has a fixed set of |
| headers (required by the messaging system) and properties (defined by the users) that can be used |
| by the messaging system to route the message (e.g. to ensure it matches a queue filter). |
| <h2>Message Properties</h2> |
| <p> |
| Message can contain properties specified by the users. It is possible to convert from some types |
| to other types as specified by the following table: |
| <pre> |
| | | boolean byte short int long float double String byte[] |
| |---------------------------------------------------------------- |
| |boolean | X X |
| |byte | X X X X X |
| |short | X X X X |
| |int | X X X |
| |long | X X |
| |float | X X X |
| |double | X X |
| |String | X X X X X X X X |
| |byte[] | X |
| |----------------------------------------------------------------- |
| </pre> |
| <p> |
| If conversion is not allowed (for example calling <code>getFloatProperty</code> on a property set a |
| <code>boolean</code>), a <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core"><code>ActiveMQPropertyConversionException</code></a> will be thrown. |
| |
| |
| User cases that will be covered by Message |
| |
| Receiving a buffer: |
| |
| Message encode = new CoreMessage(); // or any other implementation |
| encode.receiveBuffer(buffer); |
| |
| |
| Sending to a buffer: |
| |
| Message encode; |
| size = encode.getEncodeSize(); |
| encode.encodeDirectly(bufferOutput);</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#BYTES_TYPE">BYTES_TYPE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_TYPE">DEFAULT_TYPE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EMBEDDED_TYPE">EMBEDDED_TYPE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The message will contain another message persisted through org.apache.activemq.artemis.spi.core.protocol.EmbedMessageUtil</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ACTUAL_EXPIRY_TIME">HDR_ACTUAL_EXPIRY_TIME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">the actual time the message was expired.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_BRIDGE_DUPLICATE_ID">HDR_BRIDGE_DUPLICATE_ID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_CONTENT_TYPE">HDR_CONTENT_TYPE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">To define the mime-type of body messages.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_DUPLICATE_DETECTION_ID">HDR_DUPLICATE_DETECTION_ID</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">To be used with duplicate detection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_GROUP_ID">HDR_GROUP_ID</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">For the Message Grouping feature.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_GROUP_SEQUENCE">HDR_GROUP_SEQUENCE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_INGRESS_TIMESTAMP">HDR_INGRESS_TIMESTAMP</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The time at which the message arrived at the broker.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_LARGE_BODY_SIZE">HDR_LARGE_BODY_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The body size of a large message before it was compressed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_LARGE_COMPRESSED">HDR_LARGE_COMPRESSED</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">to determine if the Large Message was compressed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_LAST_VALUE_NAME">HDR_LAST_VALUE_NAME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">To be used with Last value queues.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ORIG_MESSAGE_ID">HDR_ORIG_MESSAGE_ID</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The original message ID before the message was transferred.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ORIG_ROUTING_TYPE">HDR_ORIG_ROUTING_TYPE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The original routing type of a message before getting transferred through DLQ or expiry</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ORIGINAL_ADDRESS">HDR_ORIGINAL_ADDRESS</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The original address of a message when a message is diverted or transferred through DLQ or expiry</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ORIGINAL_QUEUE">HDR_ORIGINAL_QUEUE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The original address of a message when a message is transferred through DLQ or expiry</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_PREFIX">HDR_PREFIX</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The prefix used (if any) when sending this message.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ROUTE_TO_ACK_IDS">HDR_ROUTE_TO_ACK_IDS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ROUTE_TO_IDS">HDR_ROUTE_TO_IDS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ROUTING_TYPE">HDR_ROUTING_TYPE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The Routing Type for this message.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_SCALEDOWN_TO_IDS">HDR_SCALEDOWN_TO_IDS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_SCHEDULED_DELIVERY_TIME">HDR_SCHEDULED_DELIVERY_TIME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">To be used with Scheduled Delivery.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_VALIDATED_USER">HDR_VALIDATED_USER</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The name of the validated user who sent the message.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Predicate</a><<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#INTERNAL_PROPERTY_NAMES_PREDICATE">INTERNAL_PROPERTY_NAMES_PREDICATE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LARGE_EMBEDDED_TYPE">LARGE_EMBEDDED_TYPE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">This is to embedd Large Messages from other protocol</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MAP_TYPE">MAP_TYPE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#memoryOffset">memoryOffset</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#OBJECT_TYPE">OBJECT_TYPE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#STREAM_TYPE">STREAM_TYPE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TEXT_TYPE">TEXT_TYPE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acceptsConsumer(long)">acceptsConsumer</a></span>​(long uniqueConsumerID)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearInternalProperties()">clearInternalProperties</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsProperty(java.lang.String)">containsProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsProperty(org.apache.activemq.artemis.api.core.SimpleString)">containsProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy()">copy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">It will generate a new instance of the message encode, being a deep copy, new properties, new everything</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(long)">copy</a></span>​(long newID)</code></th> |
| <td class="colLast"> |
| <div class="block">It will generate a new instance of the message encode, being a deep copy, new properties, new everything</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(long,boolean)">copy</a></span>​(long newID, |
| boolean isExpiryOrDLQ)</code></th> |
| <td class="colLast"> |
| <div class="block">It will generate a new instance of the message encode, being a deep copy, new properties, new everything</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#durableDown()">durableDown</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#durableUp()">durableUp</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAddress()">getAddress</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAddressSimpleString()">getAddressSimpleString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAnnotation(org.apache.activemq.artemis.api.core.SimpleString)">getAnnotation</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAnnotationString(org.apache.activemq.artemis.api.core.SimpleString)">getAnnotationString</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>default <a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBodyBuffer()">getBodyBuffer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">do not use this, use through ICoreMessage or ClientMessage |
| Warning: if you need to read the content of a message use getDataBuffer().</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBodyInputStream()">getBodyInputStream</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">do not use this, use through ICoreMessage or ClientMessage</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBooleanProperty(java.lang.String)">getBooleanProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBooleanProperty(org.apache.activemq.artemis.api.core.SimpleString)">getBooleanProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBrokerProperty(org.apache.activemq.artemis.api.core.SimpleString)">getBrokerProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Byte.html?is-external=true" title="class or interface in java.lang" class="externalLink">Byte</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByteProperty(java.lang.String)">getByteProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Byte.html?is-external=true" title="class or interface in java.lang" class="externalLink">Byte</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByteProperty(org.apache.activemq.artemis.api.core.SimpleString)">getByteProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBytesProperty(java.lang.String)">getBytesProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBytesProperty(org.apache.activemq.artemis.api.core.SimpleString)">getBytesProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectionID()">getConnectionID</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCorrelationID()">getCorrelationID</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDoubleProperty(java.lang.String)">getDoubleProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDoubleProperty(org.apache.activemq.artemis.api.core.SimpleString)">getDoubleProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>default byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDuplicateIDBytes()">getDuplicateIDBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">it will translate a property named HDR_DUPLICATE_DETECTION_ID.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDuplicateProperty()">getDuplicateProperty</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDurableCount()">getDurableCount</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEncodeSize()">getEncodeSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the size of the <em>encoded</em> message.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpiration()">getExpiration</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the expiration time of this message.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>default byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtraBytesProperty(org.apache.activemq.artemis.api.core.SimpleString)">getExtraBytesProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html?is-external=true" title="class or interface in java.lang" class="externalLink">Float</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFloatProperty(java.lang.String)">getFloatProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html?is-external=true" title="class or interface in java.lang" class="externalLink">Float</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFloatProperty(org.apache.activemq.artemis.api.core.SimpleString)">getFloatProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>default <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupID()">getGroupID</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>default int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupSequence()">getGroupSequence</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIngressTimestamp()">getIngressTimestamp</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIntProperty(java.lang.String)">getIntProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIntProperty(org.apache.activemq.artemis.api.core.SimpleString)">getIntProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>default <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLastValueProperty()">getLastValueProperty</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLongProperty(java.lang.String)">getLongProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLongProperty(org.apache.activemq.artemis.api.core.SimpleString)">getLongProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMemoryEstimate()">getMemoryEstimate</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageID()">getMessageID</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the messageID.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectProperty(java.lang.String)">getObjectProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectProperty(org.apache.activemq.artemis.api.core.SimpleString)">getObjectProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectPropertyForFilter(org.apache.activemq.artemis.api.core.SimpleString)">getObjectPropertyForFilter</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOwner()">getOwner</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistentSize()">getPersistentSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This is the size of the message when persisted on disk which is used for metrics tracking |
| Note that even if the message itself is not persisted on disk (ie non-durable) this value is |
| still used for metrics tracking |
| If a normal message it will be the encoded message size |
| If a large message it will be encoded message size + large message body size</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>org.apache.activemq.artemis.core.persistence.Persister<<a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersister()">getPersister</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistSize()">getPersistSize</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPriority()">getPriority</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the message priority.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPropertyNames()">getPropertyNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns all the names of the properties for this message.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocolName()">getProtocolName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRefCount()">getRefCount</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplyTo()">getReplyTo</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>default <a href="RoutingType.html" title="enum in org.apache.activemq.artemis.api.core">RoutingType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoutingType()">getRoutingType</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScheduledDeliveryTime()">getScheduledDeliveryTime</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Used to calculate what is the delivery time.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Short.html?is-external=true" title="class or interface in java.lang" class="externalLink">Short</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getShortProperty(java.lang.String)">getShortProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Short.html?is-external=true" title="class or interface in java.lang" class="externalLink">Short</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getShortProperty(org.apache.activemq.artemis.api.core.SimpleString)">getShortProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code><a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSimpleStringProperty(java.lang.String)">getSimpleStringProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code><a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSimpleStringProperty(org.apache.activemq.artemis.api.core.SimpleString)">getSimpleStringProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStringBody()">getStringBody</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStringProperty(java.lang.String)">getStringProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStringProperty(org.apache.activemq.artemis.api.core.SimpleString)">getStringProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTimestamp()">getTimestamp</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>default byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType()">getType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">do not use this, use through ICoreMessage or ClientMessage</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUsage()">getUsage</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserContext(java.lang.Object)">getUserContext</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Used for user context data.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserID()">getUserID</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This represents historically the JMSMessageID.</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValidatedUserID()">getValidatedUserID</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code>default long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWholeMessageSize()">getWholeMessageSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return an estimate of the size of the message on the wire.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasScheduledDeliveryTime()">hasScheduledDeliveryTime</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Search for the existence of the property: an implementor can save |
| the message to be decoded, if possible.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDurable()">isDurable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this message is durable or not.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isExpired()">isExpired</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this message is expired or not.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLargeMessage()">isLargeMessage</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPaged()">isPaged</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messageChanged()">messageChanged</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">WARNING: Calling this method on a AMQPMessage will allow the non mutable part of the message to be modified.</div> |
| </td> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#persist(org.apache.activemq.artemis.api.core.ActiveMQBuffer)">persist</a></span>​(<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a> targetRecord)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i79" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putBooleanProperty(java.lang.String,boolean)">putBooleanProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| boolean value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i80" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putBooleanProperty(org.apache.activemq.artemis.api.core.SimpleString,boolean)">putBooleanProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| boolean value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i81" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putByteProperty(java.lang.String,byte)">putByteProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| byte value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i82" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putByteProperty(org.apache.activemq.artemis.api.core.SimpleString,byte)">putByteProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| byte value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i83" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putBytesProperty(java.lang.String,byte%5B%5D)">putBytesProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| byte[] value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i84" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putBytesProperty(org.apache.activemq.artemis.api.core.SimpleString,byte%5B%5D)">putBytesProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| byte[] value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i85" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putCharProperty(java.lang.String,char)">putCharProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| char value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i86" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putCharProperty(org.apache.activemq.artemis.api.core.SimpleString,char)">putCharProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| char value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i87" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putDoubleProperty(java.lang.String,double)">putDoubleProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| double value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i88" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putDoubleProperty(org.apache.activemq.artemis.api.core.SimpleString,double)">putDoubleProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| double value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i89" class="rowColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putExtraBytesProperty(org.apache.activemq.artemis.api.core.SimpleString,byte%5B%5D)">putExtraBytesProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| byte[] value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i90" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putFloatProperty(java.lang.String,float)">putFloatProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| float value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i91" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putFloatProperty(org.apache.activemq.artemis.api.core.SimpleString,float)">putFloatProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| float value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i92" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putIntProperty(java.lang.String,int)">putIntProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| int value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i93" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putIntProperty(org.apache.activemq.artemis.api.core.SimpleString,int)">putIntProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| int value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i94" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putLongProperty(java.lang.String,long)">putLongProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| long value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i95" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putLongProperty(org.apache.activemq.artemis.api.core.SimpleString,long)">putLongProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| long value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i96" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putObjectProperty(java.lang.String,java.lang.Object)">putObjectProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i97" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putObjectProperty(org.apache.activemq.artemis.api.core.SimpleString,java.lang.Object)">putObjectProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i98" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putShortProperty(java.lang.String,short)">putShortProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| short value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i99" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putShortProperty(org.apache.activemq.artemis.api.core.SimpleString,short)">putShortProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| short value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i100" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putStringProperty(java.lang.String,java.lang.String)">putStringProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Puts a String property in this message.</div> |
| </td> |
| </tr> |
| <tr id="i101" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putStringProperty(org.apache.activemq.artemis.api.core.SimpleString,java.lang.String)">putStringProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i102" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putStringProperty(org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.SimpleString)">putStringProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i103" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiveBuffer(io.netty.buffer.ByteBuf)">receiveBuffer</a></span>​(io.netty.buffer.ByteBuf buffer)</code></th> |
| <td class="colLast"> |
| <div class="block">Used to receive this message from an encoded medium buffer</div> |
| </td> |
| </tr> |
| <tr id="i104" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reencode()">reencode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Propagate message modifications to clients.</div> |
| </td> |
| </tr> |
| <tr id="i105" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refDown()">refDown</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i106" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#referenceOriginalMessage(org.apache.activemq.artemis.api.core.Message,org.apache.activemq.artemis.api.core.SimpleString)">referenceOriginalMessage</a></span>​(<a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> original, |
| <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> originalQueue)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i107" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refUp()">refUp</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i108" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rejectConsumer(long)">rejectConsumer</a></span>​(long uniqueConsumerID)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i109" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reloadPersistence(org.apache.activemq.artemis.api.core.ActiveMQBuffer,org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools)">reloadPersistence</a></span>​(<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a> record, |
| org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools pools)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i110" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAnnotation(org.apache.activemq.artemis.api.core.SimpleString)">removeAnnotation</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i111" class="rowColor"> |
| <td class="colFirst"><code>default byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeExtraBytesProperty(org.apache.activemq.artemis.api.core.SimpleString)">removeExtraBytesProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i112" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeProperty(java.lang.String)">removeProperty</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i113" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeProperty(org.apache.activemq.artemis.api.core.SimpleString)">removeProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i114" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendBuffer(io.netty.buffer.ByteBuf,int)">sendBuffer</a></span>​(io.netty.buffer.ByteBuf buffer, |
| int deliveryCount)</code></th> |
| <td class="colLast"> |
| <div class="block">Used to send this message to an encoded medium buffer.</div> |
| </td> |
| </tr> |
| <tr id="i115" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAddress(java.lang.String)">setAddress</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> address)</code></th> |
| <td class="colLast"> |
| <div class="block">Look at <a href="#setAddress(org.apache.activemq.artemis.api.core.SimpleString)"><code>setAddress(SimpleString)</code></a> for the doc.</div> |
| </td> |
| </tr> |
| <tr id="i116" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAddress(org.apache.activemq.artemis.api.core.SimpleString)">setAddress</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> address)</code></th> |
| <td class="colLast"> |
| <div class="block">This will set the address on CoreMessage.</div> |
| </td> |
| </tr> |
| <tr id="i117" class="rowColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAnnotation(org.apache.activemq.artemis.api.core.SimpleString,java.lang.Object)">setAnnotation</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </td> |
| </tr> |
| <tr id="i118" class="altColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBrokerProperty(org.apache.activemq.artemis.api.core.SimpleString,java.lang.Object)">setBrokerProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">To be called by the broker on ocasions such as DLQ and expiry.</div> |
| </td> |
| </tr> |
| <tr id="i119" class="rowColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConnectionID(java.lang.String)">setConnectionID</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> connectionID)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i120" class="altColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCorrelationID(java.lang.Object)">setCorrelationID</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> correlationID)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i121" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDurable(boolean)">setDurable</a></span>​(boolean durable)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether this message is durable or not.</div> |
| </td> |
| </tr> |
| <tr id="i122" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExpiration(long)">setExpiration</a></span>​(long expiration)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the expiration of this message.</div> |
| </td> |
| </tr> |
| <tr id="i123" class="rowColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setGroupID(java.lang.String)">setGroupID</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> groupID)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i124" class="altColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setGroupID(org.apache.activemq.artemis.api.core.SimpleString)">setGroupID</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> groupID)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i125" class="rowColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setGroupSequence(int)">setGroupSequence</a></span>​(int sequence)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i126" class="altColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIngressTimestamp()">setIngressTimestamp</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i127" class="rowColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLastValueProperty(org.apache.activemq.artemis.api.core.SimpleString)">setLastValueProperty</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> lastValueName)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i128" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageID(long)">setMessageID</a></span>​(long id)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i129" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOwner(java.lang.Object)">setOwner</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i130" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPaged()">setPaged</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i131" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPriority(byte)">setPriority</a></span>​(byte priority)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the message priority.</div> |
| </td> |
| </tr> |
| <tr id="i132" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplyTo(org.apache.activemq.artemis.api.core.SimpleString)">setReplyTo</a></span>​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> address)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i133" class="rowColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRoutingType(org.apache.activemq.artemis.api.core.RoutingType)">setRoutingType</a></span>​(<a href="RoutingType.html" title="enum in org.apache.activemq.artemis.api.core">RoutingType</a> routingType)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i134" class="altColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setScheduledDeliveryTime(java.lang.Long)">setScheduledDeliveryTime</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> time)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i135" class="rowColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTimestamp(long)">setTimestamp</a></span>​(long timestamp)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i136" class="altColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setType(byte)">setType</a></span>​(byte type)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">do not use this, use through ICoreMessage or ClientMessage</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i137" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUserContext(java.lang.Object,java.lang.Object)">setUserContext</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Used for user context data.</div> |
| </td> |
| </tr> |
| <tr id="i138" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUserID(java.lang.Object)">setUserID</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> userID)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i139" class="rowColor"> |
| <td class="colFirst"><code>default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValidatedUserID(java.lang.String)">setValidatedUserID</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> validatedUserID)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i140" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/CompositeData.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">CompositeData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toCompositeData(int,int)">toCompositeData</a></span>​(int fieldsLimit, |
| int deliveryCount)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i141" class="rowColor"> |
| <td class="colFirst"><code><a href="ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toCore()">toCore</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This should make you convert your message into Core format.</div> |
| </td> |
| </tr> |
| <tr id="i142" class="altColor"> |
| <td class="colFirst"><code><a href="ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toCore(org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools)">toCore</a></span>​(org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools coreMessageObjectPools)</code></th> |
| <td class="colLast"> |
| <div class="block">This should make you convert your message into Core format.</div> |
| </td> |
| </tr> |
| <tr id="i143" class="rowColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toMap()">toMap</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i144" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toMap(int)">toMap</a></span>​(int valueSizeLimit)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i145" class="rowColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toPropertyMap()">toPropertyMap</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i146" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toPropertyMap(int)">toPropertyMap</a></span>​(int valueSizeLimit)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i147" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#usageDown()">usageDown</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i148" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#usageUp()">usageUp</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">this method indicates usage by components such as large message or page cache.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="memoryOffset"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>memoryOffset</h4> |
| <pre>static final int memoryOffset</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.Message.memoryOffset">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="INTERNAL_PROPERTY_NAMES_PREDICATE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INTERNAL_PROPERTY_NAMES_PREDICATE</h4> |
| <pre>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Predicate</a><<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a>> INTERNAL_PROPERTY_NAMES_PREDICATE</pre> |
| </li> |
| </ul> |
| <a id="HDR_ROUTE_TO_IDS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ROUTE_TO_IDS</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ROUTE_TO_IDS</pre> |
| </li> |
| </ul> |
| <a id="HDR_SCALEDOWN_TO_IDS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_SCALEDOWN_TO_IDS</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_SCALEDOWN_TO_IDS</pre> |
| </li> |
| </ul> |
| <a id="HDR_ROUTE_TO_ACK_IDS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ROUTE_TO_ACK_IDS</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ROUTE_TO_ACK_IDS</pre> |
| </li> |
| </ul> |
| <a id="HDR_BRIDGE_DUPLICATE_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_BRIDGE_DUPLICATE_ID</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_BRIDGE_DUPLICATE_ID</pre> |
| </li> |
| </ul> |
| <a id="HDR_ACTUAL_EXPIRY_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ACTUAL_EXPIRY_TIME</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ACTUAL_EXPIRY_TIME</pre> |
| <div class="block">the actual time the message was expired. |
| * *</div> |
| </li> |
| </ul> |
| <a id="HDR_ORIGINAL_ADDRESS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ORIGINAL_ADDRESS</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ORIGINAL_ADDRESS</pre> |
| <div class="block">The original address of a message when a message is diverted or transferred through DLQ or expiry</div> |
| </li> |
| </ul> |
| <a id="HDR_ORIGINAL_QUEUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ORIGINAL_QUEUE</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ORIGINAL_QUEUE</pre> |
| <div class="block">The original address of a message when a message is transferred through DLQ or expiry</div> |
| </li> |
| </ul> |
| <a id="HDR_ORIG_MESSAGE_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ORIG_MESSAGE_ID</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ORIG_MESSAGE_ID</pre> |
| <div class="block">The original message ID before the message was transferred.</div> |
| </li> |
| </ul> |
| <a id="HDR_GROUP_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_GROUP_ID</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_GROUP_ID</pre> |
| <div class="block">For the Message Grouping feature.</div> |
| </li> |
| </ul> |
| <a id="HDR_GROUP_SEQUENCE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_GROUP_SEQUENCE</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_GROUP_SEQUENCE</pre> |
| </li> |
| </ul> |
| <a id="HDR_LARGE_COMPRESSED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_LARGE_COMPRESSED</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_LARGE_COMPRESSED</pre> |
| <div class="block">to determine if the Large Message was compressed.</div> |
| </li> |
| </ul> |
| <a id="HDR_LARGE_BODY_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_LARGE_BODY_SIZE</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_LARGE_BODY_SIZE</pre> |
| <div class="block">The body size of a large message before it was compressed.</div> |
| </li> |
| </ul> |
| <a id="HDR_SCHEDULED_DELIVERY_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_SCHEDULED_DELIVERY_TIME</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_SCHEDULED_DELIVERY_TIME</pre> |
| <div class="block">To be used with Scheduled Delivery.</div> |
| </li> |
| </ul> |
| <a id="HDR_DUPLICATE_DETECTION_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_DUPLICATE_DETECTION_ID</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_DUPLICATE_DETECTION_ID</pre> |
| <div class="block">To be used with duplicate detection.</div> |
| </li> |
| </ul> |
| <a id="HDR_LAST_VALUE_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_LAST_VALUE_NAME</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_LAST_VALUE_NAME</pre> |
| <div class="block">To be used with Last value queues.</div> |
| </li> |
| </ul> |
| <a id="HDR_CONTENT_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_CONTENT_TYPE</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_CONTENT_TYPE</pre> |
| <div class="block">To define the mime-type of body messages. Mainly for stomp but it could be informed on any message for user purposes.</div> |
| </li> |
| </ul> |
| <a id="HDR_VALIDATED_USER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_VALIDATED_USER</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_VALIDATED_USER</pre> |
| <div class="block">The name of the validated user who sent the message. Useful for auditing.</div> |
| </li> |
| </ul> |
| <a id="HDR_ROUTING_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ROUTING_TYPE</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ROUTING_TYPE</pre> |
| <div class="block">The Routing Type for this message. Ensures that this message is only routed to queues with matching routing type.</div> |
| </li> |
| </ul> |
| <a id="HDR_ORIG_ROUTING_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ORIG_ROUTING_TYPE</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ORIG_ROUTING_TYPE</pre> |
| <div class="block">The original routing type of a message before getting transferred through DLQ or expiry</div> |
| </li> |
| </ul> |
| <a id="HDR_INGRESS_TIMESTAMP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_INGRESS_TIMESTAMP</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_INGRESS_TIMESTAMP</pre> |
| <div class="block">The time at which the message arrived at the broker.</div> |
| </li> |
| </ul> |
| <a id="HDR_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_PREFIX</h4> |
| <pre>static final <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_PREFIX</pre> |
| <div class="block">The prefix used (if any) when sending this message. For protocols (e.g. STOMP) that need to track this and restore |
| the prefix when the message is consumed.</div> |
| </li> |
| </ul> |
| <a id="DEFAULT_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_TYPE</h4> |
| <pre>static final byte DEFAULT_TYPE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.Message.DEFAULT_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="OBJECT_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OBJECT_TYPE</h4> |
| <pre>static final byte OBJECT_TYPE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.Message.OBJECT_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="TEXT_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TEXT_TYPE</h4> |
| <pre>static final byte TEXT_TYPE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.Message.TEXT_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="BYTES_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BYTES_TYPE</h4> |
| <pre>static final byte BYTES_TYPE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.Message.BYTES_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="MAP_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MAP_TYPE</h4> |
| <pre>static final byte MAP_TYPE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.Message.MAP_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="STREAM_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STREAM_TYPE</h4> |
| <pre>static final byte STREAM_TYPE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.Message.STREAM_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="EMBEDDED_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EMBEDDED_TYPE</h4> |
| <pre>static final byte EMBEDDED_TYPE</pre> |
| <div class="block">The message will contain another message persisted through org.apache.activemq.artemis.spi.core.protocol.EmbedMessageUtil</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.Message.EMBEDDED_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="LARGE_EMBEDDED_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LARGE_EMBEDDED_TYPE</h4> |
| <pre>static final byte LARGE_EMBEDDED_TYPE</pre> |
| <div class="block">This is to embedd Large Messages from other protocol</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.Message.LARGE_EMBEDDED_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="clearInternalProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearInternalProperties</h4> |
| <pre class="methodSignature">default void clearInternalProperties()</pre> |
| </li> |
| </ul> |
| <a id="hasScheduledDeliveryTime()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasScheduledDeliveryTime</h4> |
| <pre class="methodSignature">default boolean hasScheduledDeliveryTime()</pre> |
| <div class="block">Search for the existence of the property: an implementor can save |
| the message to be decoded, if possible.</div> |
| </li> |
| </ul> |
| <a id="getRoutingType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoutingType</h4> |
| <pre class="methodSignature">default <a href="RoutingType.html" title="enum in org.apache.activemq.artemis.api.core">RoutingType</a> getRoutingType()</pre> |
| </li> |
| </ul> |
| <a id="setRoutingType(org.apache.activemq.artemis.api.core.RoutingType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRoutingType</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setRoutingType​(<a href="RoutingType.html" title="enum in org.apache.activemq.artemis.api.core">RoutingType</a> routingType)</pre> |
| </li> |
| </ul> |
| <a id="getLastValueProperty()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastValueProperty</h4> |
| <pre class="methodSignature">default <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> getLastValueProperty()</pre> |
| </li> |
| </ul> |
| <a id="setLastValueProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLastValueProperty</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setLastValueProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> lastValueName)</pre> |
| </li> |
| </ul> |
| <a id="getBodyInputStream()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBodyInputStream</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> getBodyInputStream()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">do not use this, use through ICoreMessage or ClientMessage</div> |
| </div> |
| </li> |
| </ul> |
| <a id="getBodyBuffer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBodyBuffer</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| default <a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a> getBodyBuffer()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">do not use this, use through ICoreMessage or ClientMessage |
| Warning: if you need to read the content of a message use getDataBuffer(). This method is intended for when you |
| want to make changes.</div> |
| </div> |
| </li> |
| </ul> |
| <a id="getType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| default byte getType()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">do not use this, use through ICoreMessage or ClientMessage</div> |
| </div> |
| </li> |
| </ul> |
| <a id="setType(byte)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setType</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setType​(byte type)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">do not use this, use through ICoreMessage or ClientMessage</div> |
| </div> |
| </li> |
| </ul> |
| <a id="messageChanged()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>messageChanged</h4> |
| <pre class="methodSignature">void messageChanged()</pre> |
| <div class="block">WARNING: Calling this method on a AMQPMessage will allow the non mutable part of the message to be modified.</div> |
| </li> |
| </ul> |
| <a id="getScheduledDeliveryTime()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduledDeliveryTime</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> getScheduledDeliveryTime()</pre> |
| <div class="block">Used to calculate what is the delivery time. |
| Return null if not scheduled.</div> |
| </li> |
| </ul> |
| <a id="setPaged()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPaged</h4> |
| <pre class="methodSignature">void setPaged()</pre> |
| </li> |
| </ul> |
| <a id="isPaged()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPaged</h4> |
| <pre class="methodSignature">boolean isPaged()</pre> |
| </li> |
| </ul> |
| <a id="setScheduledDeliveryTime(java.lang.Long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setScheduledDeliveryTime</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setScheduledDeliveryTime​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> time)</pre> |
| </li> |
| </ul> |
| <a id="getGroupID()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroupID</h4> |
| <pre class="methodSignature">default <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> getGroupID()</pre> |
| </li> |
| </ul> |
| <a id="setGroupID(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGroupID</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setGroupID​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> groupID)</pre> |
| </li> |
| </ul> |
| <a id="setGroupID(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGroupID</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setGroupID​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> groupID)</pre> |
| </li> |
| </ul> |
| <a id="getGroupSequence()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroupSequence</h4> |
| <pre class="methodSignature">default int getGroupSequence()</pre> |
| </li> |
| </ul> |
| <a id="setGroupSequence(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGroupSequence</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setGroupSequence​(int sequence)</pre> |
| </li> |
| </ul> |
| <a id="getCorrelationID()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCorrelationID</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getCorrelationID()</pre> |
| </li> |
| </ul> |
| <a id="setCorrelationID(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCorrelationID</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setCorrelationID​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> correlationID)</pre> |
| </li> |
| </ul> |
| <a id="getReplyTo()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReplyTo</h4> |
| <pre class="methodSignature"><a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> getReplyTo()</pre> |
| </li> |
| </ul> |
| <a id="setReplyTo(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReplyTo</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setReplyTo​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> address)</pre> |
| </li> |
| </ul> |
| <a id="copy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> copy()</pre> |
| <div class="block">It will generate a new instance of the message encode, being a deep copy, new properties, new everything</div> |
| </li> |
| </ul> |
| <a id="copy(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> copy​(long newID)</pre> |
| <div class="block">It will generate a new instance of the message encode, being a deep copy, new properties, new everything</div> |
| </li> |
| </ul> |
| <a id="copy(long,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> copy​(long newID, |
| boolean isExpiryOrDLQ)</pre> |
| <div class="block">It will generate a new instance of the message encode, being a deep copy, new properties, new everything</div> |
| </li> |
| </ul> |
| <a id="acceptsConsumer(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptsConsumer</h4> |
| <pre class="methodSignature">default boolean acceptsConsumer​(long uniqueConsumerID)</pre> |
| </li> |
| </ul> |
| <a id="rejectConsumer(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rejectConsumer</h4> |
| <pre class="methodSignature">default void rejectConsumer​(long uniqueConsumerID)</pre> |
| </li> |
| </ul> |
| <a id="getMessageID()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageID</h4> |
| <pre class="methodSignature">long getMessageID()</pre> |
| <div class="block">Returns the messageID. |
| <br> |
| The messageID is set when the message is handled by the server.</div> |
| </li> |
| </ul> |
| <a id="getProtocolName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtocolName</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getProtocolName()</pre> |
| </li> |
| </ul> |
| <a id="setConnectionID(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionID</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setConnectionID​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> connectionID)</pre> |
| </li> |
| </ul> |
| <a id="getConnectionID()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionID</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getConnectionID()</pre> |
| </li> |
| </ul> |
| <a id="setMessageID(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageID</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setMessageID​(long id)</pre> |
| </li> |
| </ul> |
| <a id="isLargeMessage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLargeMessage</h4> |
| <pre class="methodSignature">default boolean isLargeMessage()</pre> |
| </li> |
| </ul> |
| <a id="getExpiration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExpiration</h4> |
| <pre class="methodSignature">long getExpiration()</pre> |
| <div class="block">Returns the expiration time of this message.</div> |
| </li> |
| </ul> |
| <a id="setExpiration(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExpiration</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setExpiration​(long expiration)</pre> |
| <div class="block">Sets the expiration of this message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expiration</code> - expiration time</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isExpired()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExpired</h4> |
| <pre class="methodSignature">default boolean isExpired()</pre> |
| <div class="block">Returns whether this message is expired or not.</div> |
| </li> |
| </ul> |
| <a id="getUserID()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserID</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getUserID()</pre> |
| <div class="block">This represents historically the JMSMessageID. |
| We had in the past used this for the MessageID that was sent on core messages... |
| |
| later on when we added AMQP this name clashed with AMQPMessage.getUserID();</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setUserID(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUserID</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setUserID​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> userID)</pre> |
| </li> |
| </ul> |
| <a id="getValidatedUserID()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValidatedUserID</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getValidatedUserID()</pre> |
| </li> |
| </ul> |
| <a id="setValidatedUserID(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValidatedUserID</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setValidatedUserID​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> validatedUserID)</pre> |
| </li> |
| </ul> |
| <a id="isDurable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDurable</h4> |
| <pre class="methodSignature">boolean isDurable()</pre> |
| <div class="block">Returns whether this message is durable or not.</div> |
| </li> |
| </ul> |
| <a id="setDurable(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDurable</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setDurable​(boolean durable)</pre> |
| <div class="block">Sets whether this message is durable or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>durable</code> - <code>true</code> to flag this message as durable, <code>false</code> else</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPersister()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersister</h4> |
| <pre class="methodSignature">org.apache.activemq.artemis.core.persistence.Persister<<a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>> getPersister()</pre> |
| </li> |
| </ul> |
| <a id="getAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAddress</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getAddress()</pre> |
| </li> |
| </ul> |
| <a id="setAddress(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAddress</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setAddress​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> address)</pre> |
| <div class="block">Look at <a href="#setAddress(org.apache.activemq.artemis.api.core.SimpleString)"><code>setAddress(SimpleString)</code></a> for the doc.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAddressSimpleString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAddressSimpleString</h4> |
| <pre class="methodSignature"><a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> getAddressSimpleString()</pre> |
| </li> |
| </ul> |
| <a id="setAddress(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAddress</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setAddress​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> address)</pre> |
| <div class="block">This will set the address on CoreMessage. |
| |
| Note for AMQPMessages: |
| in AMQPMessages this will not really change the address on the message. Instead it will add a property |
| on extraProperties which only transverse internally at the broker. |
| Whatever you change here it won't affect anything towards the received message. |
| |
| If you wish to change AMQPMessages address you will have to do it directly at the AMQP Message, however beware |
| that AMQPMessages are not supposed to be changed at the broker, so only do it if you know what you are doing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTimestamp()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimestamp</h4> |
| <pre class="methodSignature">long getTimestamp()</pre> |
| </li> |
| </ul> |
| <a id="setTimestamp(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimestamp</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setTimestamp​(long timestamp)</pre> |
| </li> |
| </ul> |
| <a id="getPriority()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPriority</h4> |
| <pre class="methodSignature">byte getPriority()</pre> |
| <div class="block">Returns the message priority. |
| <p> |
| Values range from 0 (less priority) to 9 (more priority) inclusive.</div> |
| </li> |
| </ul> |
| <a id="setPriority(byte)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPriority</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setPriority​(byte priority)</pre> |
| <div class="block">Sets the message priority. |
| <p> |
| Value must be between 0 and 9 inclusive.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>priority</code> - the new message priority</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="receiveBuffer(io.netty.buffer.ByteBuf)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>receiveBuffer</h4> |
| <pre class="methodSignature">void receiveBuffer​(io.netty.buffer.ByteBuf buffer)</pre> |
| <div class="block">Used to receive this message from an encoded medium buffer</div> |
| </li> |
| </ul> |
| <a id="sendBuffer(io.netty.buffer.ByteBuf,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendBuffer</h4> |
| <pre class="methodSignature">void sendBuffer​(io.netty.buffer.ByteBuf buffer, |
| int deliveryCount)</pre> |
| <div class="block">Used to send this message to an encoded medium buffer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - the buffer used.</dd> |
| <dd><code>deliveryCount</code> - Some protocols (AMQP) will have this as part of the message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPersistSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistSize</h4> |
| <pre class="methodSignature">int getPersistSize()</pre> |
| </li> |
| </ul> |
| <a id="persist(org.apache.activemq.artemis.api.core.ActiveMQBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>persist</h4> |
| <pre class="methodSignature">void persist​(<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a> targetRecord)</pre> |
| </li> |
| </ul> |
| <a id="reloadPersistence(org.apache.activemq.artemis.api.core.ActiveMQBuffer,org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reloadPersistence</h4> |
| <pre class="methodSignature">void reloadPersistence​(<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a> record, |
| org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools pools)</pre> |
| </li> |
| </ul> |
| <a id="reencode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reencode</h4> |
| <pre class="methodSignature">default void reencode()</pre> |
| <div class="block">Propagate message modifications to clients.</div> |
| </li> |
| </ul> |
| <a id="referenceOriginalMessage(org.apache.activemq.artemis.api.core.Message,org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>referenceOriginalMessage</h4> |
| <pre class="methodSignature">default void referenceOriginalMessage​(<a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> original, |
| <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> originalQueue)</pre> |
| </li> |
| </ul> |
| <a id="getDuplicateIDBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDuplicateIDBytes</h4> |
| <pre class="methodSignature">default byte[] getDuplicateIDBytes()</pre> |
| <div class="block">it will translate a property named HDR_DUPLICATE_DETECTION_ID.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="putExtraBytesProperty(org.apache.activemq.artemis.api.core.SimpleString,byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putExtraBytesProperty</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putExtraBytesProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| byte[] value)</pre> |
| </li> |
| </ul> |
| <a id="getExtraBytesProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtraBytesProperty</h4> |
| <pre class="methodSignature">default byte[] getExtraBytesProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeExtraBytesProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeExtraBytesProperty</h4> |
| <pre class="methodSignature">default byte[] removeExtraBytesProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDuplicateProperty()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDuplicateProperty</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getDuplicateProperty()</pre> |
| </li> |
| </ul> |
| <a id="putBooleanProperty(java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putBooleanProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putBooleanProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| boolean value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putByteProperty(java.lang.String,byte)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putByteProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putByteProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| byte value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putBytesProperty(java.lang.String,byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putBytesProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putBytesProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| byte[] value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putShortProperty(java.lang.String,short)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putShortProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putShortProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| short value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putCharProperty(java.lang.String,char)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putCharProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putCharProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| char value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putIntProperty(java.lang.String,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putIntProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putIntProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| int value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putLongProperty(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putLongProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putLongProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| long value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putFloatProperty(java.lang.String,float)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putFloatProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putFloatProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| float value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putDoubleProperty(java.lang.String,double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putDoubleProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putDoubleProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| double value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putBooleanProperty(org.apache.activemq.artemis.api.core.SimpleString,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putBooleanProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putBooleanProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| boolean value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putByteProperty(org.apache.activemq.artemis.api.core.SimpleString,byte)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putByteProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putByteProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| byte value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putBytesProperty(org.apache.activemq.artemis.api.core.SimpleString,byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putBytesProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putBytesProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| byte[] value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putShortProperty(org.apache.activemq.artemis.api.core.SimpleString,short)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putShortProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putShortProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| short value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putCharProperty(org.apache.activemq.artemis.api.core.SimpleString,char)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putCharProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putCharProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| char value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putIntProperty(org.apache.activemq.artemis.api.core.SimpleString,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putIntProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putIntProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| int value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putLongProperty(org.apache.activemq.artemis.api.core.SimpleString,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putLongProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putLongProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| long value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putFloatProperty(org.apache.activemq.artemis.api.core.SimpleString,float)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putFloatProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putFloatProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| float value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putDoubleProperty(org.apache.activemq.artemis.api.core.SimpleString,double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putDoubleProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putDoubleProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| double value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="putStringProperty(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putStringProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putStringProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</pre> |
| <div class="block">Puts a String property in this message. |
| <p> |
| Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property name</dd> |
| <dd><code>value</code> - property value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="putObjectProperty(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putObjectProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putObjectProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="putObjectProperty(org.apache.activemq.artemis.api.core.SimpleString,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putObjectProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putObjectProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> removeProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| </li> |
| </ul> |
| <a id="containsProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsProperty</h4> |
| <pre class="methodSignature">boolean containsProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| </li> |
| </ul> |
| <a id="getBooleanProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBooleanProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a> getBooleanProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getByteProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByteProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Byte.html?is-external=true" title="class or interface in java.lang" class="externalLink">Byte</a> getByteProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDoubleProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDoubleProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a> getDoubleProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIntProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIntProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> getIntProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLongProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLongProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> getLongProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getObjectProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getObjectProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| </li> |
| </ul> |
| <a id="getShortProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShortProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Short.html?is-external=true" title="class or interface in java.lang" class="externalLink">Short</a> getShortProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFloatProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFloatProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html?is-external=true" title="class or interface in java.lang" class="externalLink">Float</a> getFloatProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStringProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStringProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getStringProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSimpleStringProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSimpleStringProperty</h4> |
| <pre class="methodSignature"><a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> getSimpleStringProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBytesProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBytesProperty</h4> |
| <pre class="methodSignature">byte[] getBytesProperty​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> removeProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</pre> |
| </li> |
| </ul> |
| <a id="containsProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsProperty</h4> |
| <pre class="methodSignature">boolean containsProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</pre> |
| </li> |
| </ul> |
| <a id="getBooleanProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBooleanProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a> getBooleanProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getByteProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByteProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Byte.html?is-external=true" title="class or interface in java.lang" class="externalLink">Byte</a> getByteProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDoubleProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDoubleProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a> getDoubleProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIntProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIntProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> getIntProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLongProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLongProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> getLongProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getObjectPropertyForFilter(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectPropertyForFilter</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getObjectPropertyForFilter​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</pre> |
| </li> |
| </ul> |
| <a id="getObjectProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getObjectProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</pre> |
| </li> |
| </ul> |
| <a id="removeAnnotation(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAnnotation</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> removeAnnotation​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</pre> |
| </li> |
| </ul> |
| <a id="getAnnotationString(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAnnotationString</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getAnnotationString​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</pre> |
| </li> |
| </ul> |
| <a id="getAnnotation(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAnnotation</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getAnnotation​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</pre> |
| </li> |
| </ul> |
| <a id="setAnnotation(org.apache.activemq.artemis.api.core.SimpleString,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAnnotation</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setAnnotation​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block">Callers must call <a href="#reencode()"><code>reencode()</code></a> in order to be sent to clients</div> |
| </li> |
| </ul> |
| <a id="setBrokerProperty(org.apache.activemq.artemis.api.core.SimpleString,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBrokerProperty</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setBrokerProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block">To be called by the broker on ocasions such as DLQ and expiry. |
| When the broker is adding additional properties.</div> |
| </li> |
| </ul> |
| <a id="getBrokerProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBrokerProperty</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getBrokerProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key)</pre> |
| </li> |
| </ul> |
| <a id="setIngressTimestamp()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIngressTimestamp</h4> |
| <pre class="methodSignature">default <a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> setIngressTimestamp()</pre> |
| </li> |
| </ul> |
| <a id="getIngressTimestamp()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIngressTimestamp</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> getIngressTimestamp()</pre> |
| </li> |
| </ul> |
| <a id="getShortProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShortProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Short.html?is-external=true" title="class or interface in java.lang" class="externalLink">Short</a> getShortProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFloatProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFloatProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html?is-external=true" title="class or interface in java.lang" class="externalLink">Float</a> getFloatProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStringProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStringProperty</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getStringProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSimpleStringProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSimpleStringProperty</h4> |
| <pre class="methodSignature"><a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> getSimpleStringProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBytesProperty(org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBytesProperty</h4> |
| <pre class="methodSignature">byte[] getBytesProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key) |
| throws <a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQPropertyConversionException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQPropertyConversionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="putStringProperty(org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.SimpleString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putStringProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putStringProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| <a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> value)</pre> |
| </li> |
| </ul> |
| <a id="putStringProperty(org.apache.activemq.artemis.api.core.SimpleString,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putStringProperty</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> putStringProperty​(<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</pre> |
| </li> |
| </ul> |
| <a id="getEncodeSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncodeSize</h4> |
| <pre class="methodSignature">int getEncodeSize()</pre> |
| <div class="block">Returns the size of the <em>encoded</em> message.</div> |
| </li> |
| </ul> |
| <a id="getWholeMessageSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWholeMessageSize</h4> |
| <pre class="methodSignature">default long getWholeMessageSize()</pre> |
| <div class="block">Return an estimate of the size of the message on the wire. |
| for LargeMessages this will contain whatever is needed to encode properties and the body size of large messages. |
| For AMQP this will return the whole body size of the message as the body will contain all the data including properties.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPropertyNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyNames</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a>> getPropertyNames()</pre> |
| <div class="block">Returns all the names of the properties for this message.</div> |
| </li> |
| </ul> |
| <a id="getRefCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRefCount</h4> |
| <pre class="methodSignature">int getRefCount()</pre> |
| </li> |
| </ul> |
| <a id="getUsage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUsage</h4> |
| <pre class="methodSignature">int getUsage()</pre> |
| </li> |
| </ul> |
| <a id="getDurableCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDurableCount</h4> |
| <pre class="methodSignature">int getDurableCount()</pre> |
| </li> |
| </ul> |
| <a id="usageUp()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>usageUp</h4> |
| <pre class="methodSignature">int usageUp()</pre> |
| <div class="block">this method indicates usage by components such as large message or page cache. |
| This method will cause large messages to be held longer after the ack happened for instance.</div> |
| </li> |
| </ul> |
| <a id="usageDown()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>usageDown</h4> |
| <pre class="methodSignature">int usageDown()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#usageUp()"><code>usageUp()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="refUp()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refUp</h4> |
| <pre class="methodSignature">int refUp()</pre> |
| </li> |
| </ul> |
| <a id="refDown()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refDown</h4> |
| <pre class="methodSignature">int refDown()</pre> |
| </li> |
| </ul> |
| <a id="durableUp()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>durableUp</h4> |
| <pre class="methodSignature">int durableUp()</pre> |
| </li> |
| </ul> |
| <a id="durableDown()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>durableDown</h4> |
| <pre class="methodSignature">int durableDown()</pre> |
| </li> |
| </ul> |
| <a id="toMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toMap</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> toMap()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the message in Map form, useful when encoding to JSON</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toMap(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toMap</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> toMap​(int valueSizeLimit)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueSizeLimit</code> - that limits [] map values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the message in Map form, useful when encoding to JSON</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toPropertyMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toPropertyMap</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> toPropertyMap()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the message properties in Map form, useful when encoding to JSON</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toPropertyMap(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toPropertyMap</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> toPropertyMap​(int valueSizeLimit)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueSizeLimit</code> - that limits [] map values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the message properties in Map form, useful when encoding to JSON</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toCore()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toCore</h4> |
| <pre class="methodSignature"><a href="ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> toCore()</pre> |
| <div class="block">This should make you convert your message into Core format.</div> |
| </li> |
| </ul> |
| <a id="toCompositeData(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toCompositeData</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/CompositeData.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">CompositeData</a> toCompositeData​(int fieldsLimit, |
| int deliveryCount) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/OpenDataException.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">OpenDataException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/OpenDataException.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">OpenDataException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toCore(org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toCore</h4> |
| <pre class="methodSignature"><a href="ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> toCore​(org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools coreMessageObjectPools)</pre> |
| <div class="block">This should make you convert your message into Core format.</div> |
| </li> |
| </ul> |
| <a id="getMemoryEstimate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMemoryEstimate</h4> |
| <pre class="methodSignature">int getMemoryEstimate()</pre> |
| </li> |
| </ul> |
| <a id="getPersistentSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistentSize</h4> |
| <pre class="methodSignature">long getPersistentSize() |
| throws <a href="ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></pre> |
| <div class="block">This is the size of the message when persisted on disk which is used for metrics tracking |
| Note that even if the message itself is not persisted on disk (ie non-durable) this value is |
| still used for metrics tracking |
| If a normal message it will be the encoded message size |
| If a large message it will be encoded message size + large message body size</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOwner()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOwner</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getOwner()</pre> |
| </li> |
| </ul> |
| <a id="setOwner(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOwner</h4> |
| <pre class="methodSignature">void setOwner​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</pre> |
| </li> |
| </ul> |
| <a id="getStringBody()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStringBody</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getStringBody()</pre> |
| </li> |
| </ul> |
| <a id="getUserContext(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserContext</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getUserContext​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> key)</pre> |
| <div class="block">Used for user context data. Useful on interceptors.</div> |
| </li> |
| </ul> |
| <a id="setUserContext(java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setUserContext</h4> |
| <pre class="methodSignature">void setUserContext​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block">Used for user context data. Useful on interceptors.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Message.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |