| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>AbstractProtocolReference (ActiveMQ Artemis Website 2.29.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="AbstractProtocolReference (ActiveMQ Artemis Website 2.29.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/AbstractProtocolReference.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.core.server.impl</a></div> |
| <h2 title="Class AbstractProtocolReference" class="title">Class AbstractProtocolReference</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.activemq.artemis.utils.collections.LinkedListImpl.Node<<a href="MessageReferenceImpl.html" title="class in org.apache.activemq.artemis.core.server.impl">MessageReferenceImpl</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.activemq.artemis.core.server.impl.AbstractProtocolReference</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="MessageReferenceImpl.html" title="class in org.apache.activemq.artemis.core.server.impl">MessageReferenceImpl</a></code>, <code><a href="../../paging/cursor/PagedReferenceImpl.html" title="class in org.apache.activemq.artemis.core.paging.cursor">PagedReferenceImpl</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">AbstractProtocolReference</span> |
| extends org.apache.activemq.artemis.utils.collections.LinkedListImpl.Node<<a href="MessageReferenceImpl.html" title="class in org.apache.activemq.artemis.core.server.impl">MessageReferenceImpl</a>> |
| implements <a href="../MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></pre> |
| <div class="block">I need to store protocol specific data on the references. The same need exists in both PagedReference and MessageReferenceImpl. |
| This class will serve the purpose to keep the specific protocol data for either reference.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.activemq.artemis.core.server.MessageReference"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.activemq.artemis.core.server.<a href="../MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></h3> |
| <code><a href="../MessageReference.Factory.html" title="class in org.apache.activemq.artemis.core.server">MessageReference.Factory</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractProtocolReference</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocolData(java.lang.Class)">getProtocolData</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> classType)</code></th> |
| <td class="colLast"> |
| <div class="block">To be used on holding protocol specific data during the delivery.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProtocolData(java.lang.Class,T)">setProtocolData</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> classType, |
| T protocolData)</code></th> |
| <td class="colLast"> |
| <div class="block">To be used on holding protocol specific data during the delivery.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.activemq.artemis.utils.collections.LinkedListImpl.Node"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.activemq.artemis.utils.collections.LinkedListImpl.Node</h3> |
| <code>next, prev, toString, val</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.activemq.artemis.core.server.MessageReference"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.activemq.artemis.core.server.<a href="../MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></h3> |
| <code><a href="../MessageReference.html#acknowledge()">acknowledge</a>, <a href="../MessageReference.html#acknowledge(org.apache.activemq.artemis.core.transaction.Transaction)">acknowledge</a>, <a href="../MessageReference.html#acknowledge(org.apache.activemq.artemis.core.transaction.Transaction,org.apache.activemq.artemis.core.server.impl.AckReason,org.apache.activemq.artemis.core.server.ServerConsumer)">acknowledge</a>, <a href="../MessageReference.html#acknowledge(org.apache.activemq.artemis.core.transaction.Transaction,org.apache.activemq.artemis.core.server.ServerConsumer)">acknowledge</a>, <a href="../MessageReference.html#copy(org.apache.activemq.artemis.core.server.Queue)">copy</a>, <a href="../MessageReference.html#decrementDeliveryCount()">decrementDeliveryCount</a>, <a href="../MessageReference.html#emptyConsumerID()">emptyConsumerID</a>, <a href="../MessageReference.html#getConsumerId()">getConsumerId</a>, <a href="../MessageReference.html#getDeliveryCount()">getDeliveryCount</a>, <a href="../MessageReference.html#getLastValueProperty()">getLastValueProperty</a>, <a href="../MessageReference.html#getMessage()">getMessage</a>, <a href="../MessageReference.html#getMessageID()">getMessageID</a>, <a href="../MessageReference.html#getMessageMemoryEstimate()">getMessageMemoryEstimate</a>, <a href="../MessageReference.html#getPersistedCount()">getPersistedCount</a>, <a href="../MessageReference.html#getPersistentSize()">getPersistentSize</a>, <a href="../MessageReference.html#getQueue()">getQueue</a>, <a href="../MessageReference.html#getScheduledDeliveryTime()">getScheduledDeliveryTime</a>, <a href="../MessageReference.html#handled()">handled</a>, <a href="../MessageReference.html#hasConsumerId()">hasConsumerId</a>, <a href="../MessageReference.html#incrementDeliveryCount()">incrementDeliveryCount</a>, <a href="../MessageReference.html#isAlreadyAcked()">isAlreadyAcked</a>, <a href="../MessageReference.html#isDurable()">isDurable</a>, <a href="../MessageReference.html#isInDelivery()">isInDelivery</a>, <a href="../MessageReference.html#isPaged()">isPaged</a>, <a href="../MessageReference.html#onDelivery(java.util.function.Consumer)">onDelivery</a>, <a href="../MessageReference.html#setAlreadyAcked()">setAlreadyAcked</a>, <a href="../MessageReference.html#setConsumerId(long)">setConsumerId</a>, <a href="../MessageReference.html#setDeliveryCount(int)">setDeliveryCount</a>, <a href="../MessageReference.html#setInDelivery(boolean)">setInDelivery</a>, <a href="../MessageReference.html#setPersistedCount(int)">setPersistedCount</a>, <a href="../MessageReference.html#setScheduledDeliveryTime(long)">setScheduledDeliveryTime</a>, <a href="../MessageReference.html#skipDelivery()">skipDelivery</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractProtocolReference</h4> |
| <pre>public AbstractProtocolReference()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getProtocolData(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtocolData</h4> |
| <pre class="methodSignature">public <T> T getProtocolData​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> classType)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../MessageReference.html#getProtocolData(java.lang.Class)">MessageReference</a></code></span></div> |
| <div class="block">To be used on holding protocol specific data during the delivery. |
| This will be only valid while the message is on the delivering queue at the consumer</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../MessageReference.html#getProtocolData(java.lang.Class)">getProtocolData</a></code> in interface <code><a href="../MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setProtocolData(java.lang.Class,java.lang.Object)"> |
| <!-- --> |
| </a><a id="setProtocolData(java.lang.Class,T)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setProtocolData</h4> |
| <pre class="methodSignature">public <T> void setProtocolData​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> classType, |
| T protocolData)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../MessageReference.html#setProtocolData(java.lang.Class,T)">MessageReference</a></code></span></div> |
| <div class="block">To be used on holding protocol specific data during the delivery. |
| This will be only valid while the message is on the delivering queue at the consumer</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../MessageReference.html#setProtocolData(java.lang.Class,T)">setProtocolData</a></code> in interface <code><a href="../MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></code></dd> |
| </dl> |
| </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/AbstractProtocolReference.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
