| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>JmsSpout (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.jms.spout, class: JmsSpout"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/JmsSpout.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="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.jms.spout</a></div> |
| <h1 title="Class JmsSpout" class="title">Class JmsSpout</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../../topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseComponent</a> |
| <div class="inheritance"><a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseRichSpout</a> |
| <div class="inheritance">org.apache.storm.jms.spout.JmsSpout</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code>, <code><a href="../../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="../../topology/IRichSpout.html" title="interface in org.apache.storm.topology">IRichSpout</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JmsSpout</span> |
| <span class="extends-implements">extends <a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></span></div> |
| <div class="block">A Storm <code>Spout</code> implementation that listens to a JMS topic or |
| queue and outputs tuples based on the messages it receives. |
| |
| <p><code>JmsSpout</code> instances rely on <code>JmsProducer</code> |
| implementations to obtain the JMS |
| <code>ConnectionFactory</code> and <code>Destination</code> objects necessary |
| to connect to a JMS topic/queue. |
| |
| <p>When a <code>JmsSpout</code> receives a JMS message, it delegates to an |
| internal <code>JmsTupleProducer</code> instance to create a Storm tuple from |
| the incoming message. |
| |
| <p>Typically, developers will supply a custom <code>JmsTupleProducer</code> |
| implementation appropriate for the expected message content.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../serialized-form.html#org.apache.storm.jms.spout.JmsSpout">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">JmsSpout</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#ack(java.lang.Object)" class="member-name-link">ack</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> msgId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Ack a successfully handled message by the matching <a href="JmsMessageID.html" title="class in org.apache.storm.jms.spout"><code>JmsMessageID</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Close the <code>session</code> and <code>connection</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)" class="member-name-link">declareOutputFields</a><wbr>(<a href="../../topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a> declarer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Use the <code>tupleProducer</code> to determine which fields are about |
| to be emitted.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fail(java.lang.Object)" class="member-name-link">fail</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> msgId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Fail an unsuccessfully handled message by its <a href="JmsMessageID.html" title="class in org.apache.storm.jms.spout"><code>JmsMessageID</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComponentConfiguration()" class="member-name-link">getComponentConfiguration</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Declare configuration specific to this component.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJmsAcknowledgeMode()" class="member-name-link">getJmsAcknowledgeMode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the JMS Session acknowledgement mode for the JMS session |
| associated with this spout.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected javax.jms.Session</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSession()" class="member-name-link">getSession</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the currently active session.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isDistributed()" class="member-name-link">isDistributed</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns if the spout is distributed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextTuple()" class="member-name-link">nextTuple</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Generate the next tuple from a message.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#open(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.spout.SpoutOutputCollector)" class="member-name-link">open</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> conf, |
| <a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context, |
| <a href="../../spout/SpoutOutputCollector.html" title="class in org.apache.storm.spout">SpoutOutputCollector</a> spoutOutputCollector)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block"><code>ISpout</code> implementation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDistributed(boolean)" class="member-name-link">setDistributed</a><wbr>(boolean isDistributed)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the "distributed" mode of this spout.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setIndividualAcks()" class="member-name-link">setIndividualAcks</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set if JMS vendor supports ack-ing individual messages.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setJmsAcknowledgeMode(int)" class="member-name-link">setJmsAcknowledgeMode</a><wbr>(int mode)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the JMS Session acknowledgement mode for the JMS session.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setJmsProvider(org.apache.storm.jms.JmsProvider)" class="member-name-link">setJmsProvider</a><wbr>(<a href="../JmsProvider.html" title="interface in org.apache.storm.jms">JmsProvider</a> provider)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set <code>jmsProvider</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setJmsTupleProducer(org.apache.storm.jms.JmsTupleProducer)" class="member-name-link">setJmsTupleProducer</a><wbr>(<a href="../JmsTupleProducer.html" title="interface in org.apache.storm.jms">JmsTupleProducer</a> producer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the <code>JmsTupleProducer</code> |
| implementation that will convert <code>javax.jms.Message</code> |
| object to <code>org.apache.storm.tuple.Values</code> objects |
| to be emitted.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.topology.base.BaseRichSpout">Methods inherited from class org.apache.storm.topology.base.<a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></h3> |
| <code><a href="../../topology/base/BaseRichSpout.html#activate()">activate</a>, <a href="../../topology/base/BaseRichSpout.html#deactivate()">deactivate</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>JmsSpout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JmsSpout</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setJmsAcknowledgeMode(int)"> |
| <h3>setJmsAcknowledgeMode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setJmsAcknowledgeMode</span><wbr><span class="parameters">(int mode)</span></div> |
| <div class="block">Sets the JMS Session acknowledgement mode for the JMS session. |
| |
| <p>Possible values: |
| <ul> |
| <li>javax.jms.Session.AUTO_ACKNOWLEDGE</li> |
| <li>javax.jms.Session.CLIENT_ACKNOWLEDGE</li> |
| <li>javax.jms.Session.DUPS_OK_ACKNOWLEDGE</li> |
| </ul> |
| |
| <p>Any other vendor specific modes are not supported.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>mode</code> - JMS Session Acknowledgement mode</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJmsAcknowledgeMode()"> |
| <h3>getJmsAcknowledgeMode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getJmsAcknowledgeMode</span>()</div> |
| <div class="block">Returns the JMS Session acknowledgement mode for the JMS session |
| associated with this spout. Can be either of: |
| <ul> |
| <li><code>Session.AUTO_ACKNOWLEDGE</code></li> |
| <li><code>Session.CLIENT_ACKNOWLEDGE</code></li> |
| <li><code>Session.DUPS_OK_ACKNOWLEDGE</code></li> |
| <li><code>Session.SESSION_TRANSACTED</code></li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the int value of the acknowledgment mode.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setJmsProvider(org.apache.storm.jms.JmsProvider)"> |
| <h3>setJmsProvider</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setJmsProvider</span><wbr><span class="parameters">(<a href="../JmsProvider.html" title="interface in org.apache.storm.jms">JmsProvider</a> provider)</span></div> |
| <div class="block">Set <code>jmsProvider</code>. |
| |
| <p>Set the <code>JmsProvider</code> |
| implementation that this Spout will use to connect to |
| a JMS <code>javax.jms.Desination</code></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>provider</code> - the provider to use</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setJmsTupleProducer(org.apache.storm.jms.JmsTupleProducer)"> |
| <h3>setJmsTupleProducer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setJmsTupleProducer</span><wbr><span class="parameters">(<a href="../JmsTupleProducer.html" title="interface in org.apache.storm.jms">JmsTupleProducer</a> producer)</span></div> |
| <div class="block">Set the <code>JmsTupleProducer</code> |
| implementation that will convert <code>javax.jms.Message</code> |
| object to <code>org.apache.storm.tuple.Values</code> objects |
| to be emitted.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>producer</code> - the producer instance to use</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIndividualAcks()"> |
| <h3>setIndividualAcks</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setIndividualAcks</span>()</div> |
| <div class="block">Set if JMS vendor supports ack-ing individual messages. The appropriate |
| mode must be set via {<a href="#setJmsAcknowledgeMode(int)"><code>setJmsAcknowledgeMode(int)</code></a>}.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="open(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.spout.SpoutOutputCollector)"> |
| <h3>open</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">open</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> conf, |
| <a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context, |
| <a href="../../spout/SpoutOutputCollector.html" title="class in org.apache.storm.spout">SpoutOutputCollector</a> spoutOutputCollector)</span></div> |
| <div class="block"><code>ISpout</code> implementation. |
| |
| <p>Connects the JMS spout to the configured JMS destination |
| topic/queue.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - The Storm configuration for this spout. This is the configuration provided to the topology merged in with cluster |
| configuration on this machine.</dd> |
| <dd><code>context</code> - This object can be used to get information about this task's place within the topology, including the task id and |
| component id of this task, input and output information, etc.</dd> |
| <dd><code>spoutOutputCollector</code> - The collector is used to emit tuples from this spout. Tuples can be emitted at any time, including the open and |
| close methods. The collector is thread-safe and should be saved as an instance variable of this spout object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <div class="block">Close the <code>session</code> and <code>connection</code>. |
| |
| <p>When overridden, should always call <code>super</code> |
| to finalize the active connections.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../spout/ISpout.html#close()">close</a></code> in interface <code><a href="../../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../topology/base/BaseRichSpout.html#close()">close</a></code> in class <code><a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nextTuple()"> |
| <h3>nextTuple</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">nextTuple</span>()</div> |
| <div class="block">Generate the next tuple from a message. |
| |
| <p>This method polls the queue that's being filled asynchronously by the |
| jms connection, every <code>POLL_INTERVAL_MS</code> seconds.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ack(java.lang.Object)"> |
| <h3>ack</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">ack</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> msgId)</span></div> |
| <div class="block">Ack a successfully handled message by the matching <a href="JmsMessageID.html" title="class in org.apache.storm.jms.spout"><code>JmsMessageID</code></a>. |
| |
| <p>Acking means removing the message from the pending messages |
| collections, and if it was the oldest pending message - |
| ack it to the mq as well, so that it's the only one acked. |
| |
| <p>Will only be called if we're transactional or not AUTO_ACKNOWLEDGE.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../spout/ISpout.html#ack(java.lang.Object)">ack</a></code> in interface <code><a href="../../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../topology/base/BaseRichSpout.html#ack(java.lang.Object)">ack</a></code> in class <code><a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fail(java.lang.Object)"> |
| <h3>fail</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">fail</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> msgId)</span></div> |
| <div class="block">Fail an unsuccessfully handled message by its <a href="JmsMessageID.html" title="class in org.apache.storm.jms.spout"><code>JmsMessageID</code></a>. |
| |
| <p>Failing means dropping all pending messages and queueing a recovery |
| attempt. |
| |
| <p>Will only be called if we're transactional or not AUTO_ACKNOWLEDGE</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../spout/ISpout.html#fail(java.lang.Object)">fail</a></code> in interface <code><a href="../../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../topology/base/BaseRichSpout.html#fail(java.lang.Object)">fail</a></code> in class <code><a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)"> |
| <h3>declareOutputFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">declareOutputFields</span><wbr><span class="parameters">(<a href="../../topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a> declarer)</span></div> |
| <div class="block">Use the <code>tupleProducer</code> to determine which fields are about |
| to be emitted. |
| |
| <p>Note that <a href="#nextTuple()"><code>nextTuple()</code></a> always emits to the default stream, |
| and thus only fields declared for this stream are used.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>declarer</code> - this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isDistributed()"> |
| <h3>isDistributed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isDistributed</span>()</div> |
| <div class="block">Returns if the spout is distributed.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>distributed</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDistributed(boolean)"> |
| <h3>setDistributed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDistributed</span><wbr><span class="parameters">(boolean isDistributed)</span></div> |
| <div class="block">Sets the "distributed" mode of this spout. |
| |
| <p>If <code>true</code> multiple instances of this spout <i>may</i> be |
| created across the cluster (depending on the "parallelism_hint" in the topology configuration). |
| |
| <p>Setting this value to <code>false</code> essentially means this spout |
| will run as a singleton within the cluster ("parallelism_hint" will be ignored). |
| |
| <p>In general, this should be set to <code>false</code> if the underlying |
| JMS destination is a topic, and <code>true</code> if it is a JMS queue.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>isDistributed</code> - <code>true</code> if should be distributed, <code>false</code> otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSession()"> |
| <h3>getSession</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">javax.jms.Session</span> <span class="element-name">getSession</span>()</div> |
| <div class="block">Returns the currently active session.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The currently active session</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComponentConfiguration()"> |
| <h3>getComponentConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getComponentConfiguration</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../topology/IComponent.html#getComponentConfiguration()">IComponent</a></code></span></div> |
| <div class="block">Declare configuration specific to this component. Only a subset of the "topology.*" configs can be overridden. The component |
| configuration can be further overridden when constructing the topology using <a href="../../topology/TopologyBuilder.html" title="class in org.apache.storm.topology"><code>TopologyBuilder</code></a></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code> in interface <code><a href="../../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../topology/base/BaseComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code> in class <code><a href="../../topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">BaseComponent</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
