public class TransactionalSpoutCoordinator extends BaseRichSpout
Modifier and Type | Field and Description |
---|---|
static BigInteger |
INIT_TXID |
static org.slf4j.Logger |
LOG |
static String |
TRANSACTION_BATCH_STREAM_ID |
static String |
TRANSACTION_COMMIT_STREAM_ID |
Constructor and Description |
---|
TransactionalSpoutCoordinator(ITransactionalSpout spout) |
Modifier and Type | Method and Description |
---|---|
void |
ack(Object msgId)
Storm has determined that the tuple emitted by this spout with the msgId identifier
has been fully processed.
|
void |
close()
Called when an ISpout is going to be shutdown.
|
void |
declareOutputFields(OutputFieldsDeclarer declarer)
Declare the output schema for all the streams of this topology.
|
void |
fail(Object msgId)
The tuple emitted by this spout with the msgId identifier has failed to be
fully processed.
|
Map<String,Object> |
getComponentConfiguration()
Declare configuration specific to this component.
|
ITransactionalSpout |
getSpout() |
void |
nextTuple()
When this method is called, Storm is requesting that the Spout emit tuples to the
output collector.
|
void |
open(Map conf,
TopologyContext context,
SpoutOutputCollector collector)
Called when a task for this component is initialized within a worker on the cluster.
|
activate, deactivate
public static final org.slf4j.Logger LOG
public static final BigInteger INIT_TXID
public static final String TRANSACTION_BATCH_STREAM_ID
public static final String TRANSACTION_COMMIT_STREAM_ID
public TransactionalSpoutCoordinator(ITransactionalSpout spout)
public ITransactionalSpout getSpout()
public void open(Map conf, TopologyContext context, SpoutOutputCollector collector)
ISpout
This includes the:
conf
- The Storm configuration for this spout. This is the configuration provided to the topology merged in with cluster configuration on this machine.context
- 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.collector
- 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.public void close()
ISpout
The one context where close is guaranteed to be called is a topology is killed when running Storm in local mode.
close
in interface ISpout
close
in class BaseRichSpout
public void nextTuple()
ISpout
public void ack(Object msgId)
ISpout
ack
in interface ISpout
ack
in class BaseRichSpout
public void fail(Object msgId)
ISpout
fail
in interface ISpout
fail
in class BaseRichSpout
public void declareOutputFields(OutputFieldsDeclarer declarer)
IComponent
declarer
- this is used to declare output stream ids, output fields, and whether or not each output stream is a direct streampublic Map<String,Object> getComponentConfiguration()
IComponent
TopologyBuilder
getComponentConfiguration
in interface IComponent
getComponentConfiguration
in class BaseComponent
Copyright © 2016 The Apache Software Foundation. All Rights Reserved.