/
IOpaquePartitionedTridentSpout.java
97 lines (84 loc) · 4.06 KB
/
IOpaquePartitionedTridentSpout.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.storm.trident.spout;
import org.apache.storm.task.TopologyContext;
import org.apache.storm.trident.operation.TridentCollector;
import org.apache.storm.trident.topology.TransactionAttempt;
import org.apache.storm.tuple.Fields;
import java.util.List;
import java.util.Map;
/**
* This defines a transactional spout which does *not* necessarily
* replay the same batch every time it emits a batch for a transaction id.
*
* @param <M> The type of metadata object passed to the Emitter when emitting a new batch based on a previous batch. This type must be JSON
* serializable by json-simple.
* @param <Partitions> The type of metadata object used by the coordinator to describe partitions. This type must be JSON serializable by
* json-simple.
*/
public interface IOpaquePartitionedTridentSpout<Partitions, Partition extends ISpoutPartition, M>
extends ITridentDataSource {
/**
* Coordinator for batches. Trident will only begin committing once at least one coordinator is ready.
*
* @param <Partitions> The type of metadata object used by the coordinator to describe partitions. This type must be JSON serializable
* by json-simple.
*/
interface Coordinator<Partitions> {
/**
* Indicates whether this coordinator is ready to commit the given transaction.
* The master batch coordinator will only begin committing if at least one coordinator indicates it is ready to commit.
* @param txid The transaction id
* @return true if this coordinator is ready to commit, false otherwise.
*/
boolean isReady(long txid);
/**
* Gets the partitions for the following batches. The emitter will be asked to refresh partitions when this value changes.
* @return The partitions for the following batches.
*/
Partitions getPartitionsForBatch();
void close();
}
interface Emitter<Partitions, Partition extends ISpoutPartition, M> {
/**
* Emit a batch of tuples for a partition/transaction.
*
* Return the metadata describing this batch that will be used as lastPartitionMeta
* for defining the parameters of the next batch.
*/
M emitPartitionBatch(TransactionAttempt tx, TridentCollector collector, Partition partition, M lastPartitionMeta);
/**
* This method is called when this task is responsible for a new set of partitions. Should be used
* to manage things like connections to brokers.
*/
void refreshPartitions(List<Partition> partitionResponsibilities);
/**
* @return The oredered list of partitions being processed by all the tasks
*/
List<Partition> getOrderedPartitions(Partitions allPartitionInfo);
/**
* @return The list of partitions that are to be processed by the task with id {@code taskId}
*/
List<Partition> getPartitionsForTask(int taskId, int numTasks, Partitions allPartitionInfo);
void close();
}
Emitter<Partitions, Partition, M> getEmitter(Map conf, TopologyContext context);
Coordinator<Partitions> getCoordinator(Map conf, TopologyContext context);
Map<String, Object> getComponentConfiguration();
Fields getOutputFields();
}