Open Kilda Java Documentation
org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig > Class Template Referenceabstract
Inheritance diagram for org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >:
org.openkilda.wfm.topology.Topology org.openkilda.simulator.SimulatorTopology org.openkilda.wfm.topology.cache.CacheTopology org.openkilda.wfm.topology.event.OfEventWfmTopology org.openkilda.wfm.topology.flow.FlowTopology org.openkilda.wfm.topology.islstats.IslStatsTopology org.openkilda.wfm.topology.nbworker.NbWorkerTopology org.openkilda.wfm.topology.opentsdb.OpenTSDBTopology org.openkilda.wfm.topology.portstate.PortStateTopology org.openkilda.wfm.topology.stats.StatsTopology org.openkilda.wfm.topology.utils.KafkaFilerTopology org.openkilda.wfm.topology.utils.KafkaLoggerTopology

Public Member Functions

final String getTopologyName ()
 
final T getConfig ()
 
- Public Member Functions inherited from org.openkilda.wfm.topology.Topology
StormTopology createTopology () throws NameCollisionException
 

Static Public Attributes

static final String SPOUT_ID_CTRL = "ctrl.in"
 
static final String BOLT_ID_CTRL_ROUTE = "ctrl.route"
 
static final String BOLT_ID_CTRL_OUTPUT = "ctrl.out"
 
static final String MESSAGE_FIELD = "message"
 
static final Fields fieldMessage = new Fields(MESSAGE_FIELD)
 

Protected Member Functions

 AbstractTopology (LaunchEnvironment env, Class< T > topologyConfigClass)
 
String getDefaultTopologyName ()
 
void setup () throws TException, NameCollisionException
 
Config makeStormConfig ()
 
void localExecutionMainLoop ()
 
void checkAndCreateTopic (final String topic)
 
KafkaSpout< String, String > createKafkaSpout (String topic, String spoutId)
 
KafkaBolt createKafkaBolt (final String topic)
 
void createCtrlBranch (TopologyBuilder builder, List< CtrlBoltRef > targets) throws StreamNameCollisionException
 
void createHealthCheckHandler (TopologyBuilder builder, String prefix)
 
KafkaSpoutConfig.Builder< String, String > makeKafkaSpoutConfigBuilder (String spoutId, String topic)
 

Static Protected Member Functions

static int handleLaunchException (Exception error)
 

Protected Attributes

final String topologyName
 
final KafkaNamingStrategy kafkaNamingStrategy
 
final TopologyNamingStrategy topoNamingStrategy
 
final ConfigurationProvider configurationProvider
 
final T topologyConfig
 

Additional Inherited Members

- Public Attributes inherited from org.openkilda.wfm.topology.Topology
String TOPOLOGY_PROPERTIES = "/topology.properties"
 
String TOPOLOGY_PROPERTIES_DEFAULTS_PREFIX = "defaults."
 

Detailed Description

Represents abstract topology.

Definition at line 60 of file AbstractTopology.java.

Constructor & Destructor Documentation

◆ AbstractTopology()

org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.AbstractTopology ( LaunchEnvironment  env,
Class< T >  topologyConfigClass 
)
protected

Definition at line 79 of file AbstractTopology.java.

Member Function Documentation

◆ checkAndCreateTopic()

void org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.checkAndCreateTopic ( final String  topic)
protected

Creates Kafka topic if it does not exist.

Parameters
topicKafka topic

Definition at line 205 of file AbstractTopology.java.

◆ createCtrlBranch()

void org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.createCtrlBranch ( TopologyBuilder  builder,
List< CtrlBoltRef targets 
) throws StreamNameCollisionException
protected

Definition at line 235 of file AbstractTopology.java.

◆ createHealthCheckHandler()

void org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.createHealthCheckHandler ( TopologyBuilder  builder,
String  prefix 
)
protected

Creates health-check handler spout and bolts.

Parameters
buildertopology builder
prefixcomponent id

Definition at line 266 of file AbstractTopology.java.

◆ createKafkaBolt()

KafkaBolt org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.createKafkaBolt ( final String  topic)
protected

Creates Kafka bolt.

Parameters
topicKafka topic
Returns
KafkaBolt

Definition at line 228 of file AbstractTopology.java.

◆ createKafkaSpout()

KafkaSpout<String, String> org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.createKafkaSpout ( String  topic,
String  spoutId 
)
protected

Creates Kafka spout.

Parameters
topicKafka topic
Returns
KafkaSpout

Definition at line 215 of file AbstractTopology.java.

◆ getConfig()

Definition at line 196 of file AbstractTopology.java.

◆ getDefaultTopologyName()

String org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.getDefaultTopologyName ( )
protected

Definition at line 99 of file AbstractTopology.java.

◆ getTopologyName()

final String org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.getTopologyName ( )

Implements org.openkilda.wfm.topology.Topology.

Definition at line 191 of file AbstractTopology.java.

◆ handleLaunchException()

static int org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.handleLaunchException ( Exception  error)
staticprotected

Definition at line 132 of file AbstractTopology.java.

◆ localExecutionMainLoop()

void org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.localExecutionMainLoop ( )
protected

Definition at line 181 of file AbstractTopology.java.

◆ makeKafkaSpoutConfigBuilder()

KafkaSpoutConfig.Builder<String, String> org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.makeKafkaSpoutConfigBuilder ( String  spoutId,
String  topic 
)
protected

Definition at line 281 of file AbstractTopology.java.

◆ makeStormConfig()

Config org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.makeStormConfig ( )
protected

Definition at line 170 of file AbstractTopology.java.

◆ setup()

void org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.setup ( ) throws TException, NameCollisionException
protected

Definition at line 103 of file AbstractTopology.java.

Member Data Documentation

◆ BOLT_ID_CTRL_OUTPUT

final String org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.BOLT_ID_CTRL_OUTPUT = "ctrl.out"
static

Definition at line 65 of file AbstractTopology.java.

◆ BOLT_ID_CTRL_ROUTE

final String org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.BOLT_ID_CTRL_ROUTE = "ctrl.route"
static

Definition at line 64 of file AbstractTopology.java.

◆ configurationProvider

Definition at line 74 of file AbstractTopology.java.

◆ fieldMessage

final Fields org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.fieldMessage = new Fields(MESSAGE_FIELD)
static

Definition at line 68 of file AbstractTopology.java.

◆ kafkaNamingStrategy

Definition at line 72 of file AbstractTopology.java.

◆ MESSAGE_FIELD

final String org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.MESSAGE_FIELD = "message"
static

Definition at line 67 of file AbstractTopology.java.

◆ SPOUT_ID_CTRL

final String org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.SPOUT_ID_CTRL = "ctrl.in"
static

Definition at line 63 of file AbstractTopology.java.

◆ topologyConfig

final T org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.topologyConfig
protected

Definition at line 76 of file AbstractTopology.java.

◆ topologyName

final String org.openkilda.wfm.topology.AbstractTopology< T extends AbstractTopologyConfig >.topologyName
protected

Definition at line 70 of file AbstractTopology.java.

◆ topoNamingStrategy

Definition at line 73 of file AbstractTopology.java.


The documentation for this class was generated from the following file: