| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TridentJmsSpout (Storm 2.4.0 API)</title> |
| <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="TridentJmsSpout (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TridentJmsSpout.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/storm/jms/trident/JmsUpdater.html" title="class in org.apache.storm.jms.trident"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/jms/trident/TridentJmsSpout.html" target="_top">Frames</a></li> |
| <li><a href="TridentJmsSpout.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.storm.jms.trident</div> |
| <h2 title="Class TridentJmsSpout" class="title">Class TridentJmsSpout</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">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.storm.jms.trident.TridentJmsSpout</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/storm/trident/spout/ITridentDataSource.html" title="interface in org.apache.storm.trident.spout">ITridentDataSource</a>, <a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout">ITridentSpout</a><<a href="../../../../../org/apache/storm/jms/trident/JmsBatch.html" title="class in org.apache.storm.jms.trident">JmsBatch</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">TridentJmsSpout</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout">ITridentSpout</a><<a href="../../../../../org/apache/storm/jms/trident/JmsBatch.html" title="class in org.apache.storm.jms.trident">JmsBatch</a>></pre> |
| <div class="block"><p>Trident implementation of the JmsSpout.</p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.storm.jms.trident.TridentJmsSpout">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.storm.trident.spout.ITridentSpout"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.storm.trident.spout.<a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout">ITridentSpout</a></h3> |
| <code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.BatchCoordinator</a><<a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a>>, <a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.Emitter</a><<a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.Emitter.html" title="type parameter in ITridentSpout.Emitter">X</a>></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#DEFAULT_BATCH_SIZE">DEFAULT_BATCH_SIZE</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#MAX_BATCH_SIZE_CONF">MAX_BATCH_SIZE_CONF</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#TridentJmsSpout--">TridentJmsSpout</a></span>()</code> |
| <div class="block">Create a TridentJmsSpout with a default name and acknowledge mode of AUTO_ACKNOWLEDGE.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#getComponentConfiguration--">getComponentConfiguration</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.BatchCoordinator</a><<a href="../../../../../org/apache/storm/jms/trident/JmsBatch.html" title="class in org.apache.storm.jms.trident">JmsBatch</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#getCoordinator-java.lang.String-java.util.Map-org.apache.storm.task.TopologyContext-">getCoordinator</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txStateId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> conf, |
| <a href="../../../../../org/apache/storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context)</code> |
| <div class="block">The coordinator for a TransactionalSpout runs in a single thread and indicates when batches of tuples should be emitted.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.Emitter</a><<a href="../../../../../org/apache/storm/jms/trident/JmsBatch.html" title="class in org.apache.storm.jms.trident">JmsBatch</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#getEmitter-java.lang.String-java.util.Map-org.apache.storm.task.TopologyContext-">getEmitter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txStateId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> conf, |
| <a href="../../../../../org/apache/storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context)</code> |
| <div class="block">The emitter for a TransactionalSpout runs as many tasks across the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#getOutputFields--">getOutputFields</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html" title="class in org.apache.storm.jms.trident">TridentJmsSpout</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#named-java.lang.String-">named</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Set the name for this spout, to improve log identification.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html" title="class in org.apache.storm.jms.trident">TridentJmsSpout</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#withJmsAcknowledgeMode-int-">withJmsAcknowledgeMode</a></span>(int jmsAcknowledgeMode)</code> |
| <div class="block">Set the JMS acknowledge mode for messages being processed by this spout.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html" title="class in org.apache.storm.jms.trident">TridentJmsSpout</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#withJmsProvider-org.apache.storm.jms.JmsProvider-">withJmsProvider</a></span>(<a href="../../../../../org/apache/storm/jms/JmsProvider.html" title="interface in org.apache.storm.jms">JmsProvider</a> provider)</code> |
| <div class="block">Set the <code>JmsProvider</code> implementation that this Spout will use to connect to a JMS <code>javax.jms.Desination</code>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html" title="class in org.apache.storm.jms.trident">TridentJmsSpout</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html#withTupleProducer-org.apache.storm.jms.JmsTupleProducer-">withTupleProducer</a></span>(<a href="../../../../../org/apache/storm/jms/JmsTupleProducer.html" title="interface in org.apache.storm.jms">JmsTupleProducer</a> tupleProducer)</code> |
| <div class="block">Set the <code>JmsTupleProducer</code> implementation that will convert <code>javax.jms.Message</code> object to <code>backtype.storm.tuple.Values</code> objects to be emitted.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="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">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">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">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">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">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">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">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">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</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">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">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">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="MAX_BATCH_SIZE_CONF"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MAX_BATCH_SIZE_CONF</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAX_BATCH_SIZE_CONF</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.storm.jms.trident.TridentJmsSpout.MAX_BATCH_SIZE_CONF">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_BATCH_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_BATCH_SIZE</h4> |
| <pre>public static final int DEFAULT_BATCH_SIZE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.storm.jms.trident.TridentJmsSpout.DEFAULT_BATCH_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TridentJmsSpout--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TridentJmsSpout</h4> |
| <pre>public TridentJmsSpout()</pre> |
| <div class="block"><p>Create a TridentJmsSpout with a default name and acknowledge mode of AUTO_ACKNOWLEDGE.</p></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="named-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>named</h4> |
| <pre>public <a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html" title="class in org.apache.storm.jms.trident">TridentJmsSpout</a> named(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><p>Set the name for this spout, to improve log identification.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name to be used in log messages</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This spout</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withJmsProvider-org.apache.storm.jms.JmsProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withJmsProvider</h4> |
| <pre>public <a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html" title="class in org.apache.storm.jms.trident">TridentJmsSpout</a> withJmsProvider(<a href="../../../../../org/apache/storm/jms/JmsProvider.html" title="interface in org.apache.storm.jms">JmsProvider</a> provider)</pre> |
| <div class="block"><p>Set the <code>JmsProvider</code> implementation that this Spout will use to connect to a JMS <code>javax.jms.Desination</code>.</p></div> |
| </li> |
| </ul> |
| <a name="withTupleProducer-org.apache.storm.jms.JmsTupleProducer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTupleProducer</h4> |
| <pre>public <a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html" title="class in org.apache.storm.jms.trident">TridentJmsSpout</a> withTupleProducer(<a href="../../../../../org/apache/storm/jms/JmsTupleProducer.html" title="interface in org.apache.storm.jms">JmsTupleProducer</a> tupleProducer)</pre> |
| <div class="block"><p>Set the <code>JmsTupleProducer</code> implementation that will convert <code>javax.jms.Message</code> object to <code>backtype.storm.tuple.Values</code> objects to be emitted.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This spout</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withJmsAcknowledgeMode-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withJmsAcknowledgeMode</h4> |
| <pre>public <a href="../../../../../org/apache/storm/jms/trident/TridentJmsSpout.html" title="class in org.apache.storm.jms.trident">TridentJmsSpout</a> withJmsAcknowledgeMode(int jmsAcknowledgeMode)</pre> |
| <div class="block"><p>Set the JMS acknowledge mode for messages being processed by this spout. <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></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jmsAcknowledgeMode</code> - The chosen acknowledge mode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This spout</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the mode is not recognized</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCoordinator-java.lang.String-java.util.Map-org.apache.storm.task.TopologyContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCoordinator</h4> |
| <pre>public <a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.BatchCoordinator</a><<a href="../../../../../org/apache/storm/jms/trident/JmsBatch.html" title="class in org.apache.storm.jms.trident">JmsBatch</a>> getCoordinator(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txStateId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> conf, |
| <a href="../../../../../org/apache/storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html#getCoordinator-java.lang.String-java.util.Map-org.apache.storm.task.TopologyContext-">ITridentSpout</a></code></span></div> |
| <div class="block"><p>The coordinator for a TransactionalSpout runs in a single thread and indicates when batches of tuples should be emitted. The Coordinator that you provide in a TransactionalSpout provides metadata for each transaction so that the transactions can be replayed in case of failure.</p><p><p>Two instances are requested, one on the master batch coordinator where isReady() is called, and an instance in the coordinator bolt which is used for all other operations. The two instances do not necessarily share a worker JVM.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html#getCoordinator-java.lang.String-java.util.Map-org.apache.storm.task.TopologyContext-">getCoordinator</a></code> in interface <code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout">ITridentSpout</a><<a href="../../../../../org/apache/storm/jms/trident/JmsBatch.html" title="class in org.apache.storm.jms.trident">JmsBatch</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>txStateId</code> - stream id</dd> |
| <dd><code>conf</code> - Storm config map</dd> |
| <dd><code>context</code> - topology context</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>spout coordinator instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEmitter-java.lang.String-java.util.Map-org.apache.storm.task.TopologyContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEmitter</h4> |
| <pre>public <a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.Emitter</a><<a href="../../../../../org/apache/storm/jms/trident/JmsBatch.html" title="class in org.apache.storm.jms.trident">JmsBatch</a>> getEmitter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txStateId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> conf, |
| <a href="../../../../../org/apache/storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html#getEmitter-java.lang.String-java.util.Map-org.apache.storm.task.TopologyContext-">ITridentSpout</a></code></span></div> |
| <div class="block"><p>The emitter for a TransactionalSpout runs as many tasks across the cluster. Emitters are responsible for emitting batches of tuples for a transaction and must ensure that the same batch of tuples is always emitted for the same transaction id.</p><p><p>All emitter tasks get the same transaction metadata. The topology context parameter contains the instance task id that can be used to distribute the work across the tasks.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html#getEmitter-java.lang.String-java.util.Map-org.apache.storm.task.TopologyContext-">getEmitter</a></code> in interface <code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout">ITridentSpout</a><<a href="../../../../../org/apache/storm/jms/trident/JmsBatch.html" title="class in org.apache.storm.jms.trident">JmsBatch</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>txStateId</code> - stream id</dd> |
| <dd><code>conf</code> - Storm config map</dd> |
| <dd><code>context</code> - topology context</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>spout emitter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getComponentConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentConfiguration</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getComponentConfiguration()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html#getComponentConfiguration--">getComponentConfiguration</a></code> in interface <code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout">ITridentSpout</a><<a href="../../../../../org/apache/storm/jms/trident/JmsBatch.html" title="class in org.apache.storm.jms.trident">JmsBatch</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOutputFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getOutputFields</h4> |
| <pre>public <a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> getOutputFields()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html#getOutputFields--">getOutputFields</a></code> in interface <code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout">ITridentSpout</a><<a href="../../../../../org/apache/storm/jms/trident/JmsBatch.html" title="class in org.apache.storm.jms.trident">JmsBatch</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TridentJmsSpout.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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/storm/jms/trident/JmsUpdater.html" title="class in org.apache.storm.jms.trident"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/jms/trident/TridentJmsSpout.html" target="_top">Frames</a></li> |
| <li><a href="TridentJmsSpout.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
