Element Summary

Element	Description	Class
all	The stream is	com.hmsonline.storm.osgi.subscription.AllDistribution
basicBolt	A basic configurable bolt.	com.hmsonline.storm.osgi.bolt.BasicBoltDefinition
basicSpout	Implements a basic	com.hmsonline.storm.osgi.spout.BasicSpoutDefinition
bolt	The parent definition for bolts, it should be subclassed to make it easier to assign a tag configuration for each implementation.	com.hmsonline.storm.osgi.bolt.BoltDefinition
fieldSet	The stream is	com.hmsonline.storm.osgi.subscription.FieldSetDistribution
global	The entire stream	com.hmsonline.storm.osgi.subscription.GlobalDistribution
localOrShuffle	If the target bolt	com.hmsonline.storm.osgi.subscription.LocalOrShuffleDistribution
none	This is a special kind of	com.hmsonline.storm.osgi.subscription.DirectDistribution
pollingSpout	A Spout which will call it's	com.hmsonline.storm.osgi.spout.PollingSpoutDefinition
properties	Properties for configuring a topology.	com.hmsonline.storm.osgi.impl.TopologyProperties
shellBolt	A bolt that can be configured to run a shell command.	com.hmsonline.storm.osgi.bolt.ShellBoltDefinition
shuffle	Tuples are randomly	com.hmsonline.storm.osgi.subscription.ShuffleDistribution
spout		com.hmsonline.storm.osgi.spout.SpoutDefinition
stream		com.hmsonline.storm.osgi.tuple.TupleStream
subscribes	Represents the	com.hmsonline.storm.osgi.topology.Subscription
topology	Represents the definition of a Storm topology	com.hmsonline.storm.osgi.topology.TopologyDefinition

Element Detail

Element: all

Element: basicBolt

Attribute	Type	Description
debug	xs:boolean	When set to true, Storm will log every message that's emitted.
maxSpoutPending	xs:integer	The maximum number of tuples that can be pending on a spout task at any given time. This config applies to individual tasks, not to spouts or topologies as a whole. A pending tuple is one that has been emitted from a spout but has not been acked or failed yet. Note that this config parameter has no effect for unreliable spouts that don't tag their tuples with a message id.
maxTaskParallelism	xs:integer	The maximum parallelism allowed for a component in this topology. This configuration is typically used in testing to limit the number of threads spawned in local mode.
name	xs:string	The name of this component.
numTasks	xs:integer	How many instances to create for a spout/bolt. A task runs on a thread with zero or more other tasks for the same spout/bolt. The number of tasks for a spout/bolt is always the same throughout the lifetime of a topology, but the number of executors (threads) for a spout/bolt can change over time. This allows a topology to scale to more or less resources without redeploying the topology or violating the constraints of Storm (such as a fields grouping guaranteeing that the same value goes to the same task).

Element	Type	Description
executor	<spring:bean/>
parallelismHint	<spring:bean/>	The initial number of executors (threads) this component should have.
schema	(<spring:bean/>)*	The set of fields output by this component.
subscription	subscribes	The details of what this bolt is subscribed to.

Element: basicSpout

Attribute	Type	Description
debug	xs:boolean	When set to true, Storm will log every message that's emitted.
maxSpoutPending	xs:integer	The maximum number of tuples that can be pending on a spout task at any given time. This config applies to individual tasks, not to spouts or topologies as a whole. A pending tuple is one that has been emitted from a spout but has not been acked or failed yet. Note that this config parameter has no effect for unreliable spouts that don't tag their tuples with a message id.
maxTaskParallelism	xs:integer	The maximum parallelism allowed for a component in this topology. This configuration is typically used in testing to limit the number of threads spawned in local mode.
name	xs:string	The name of this component.
numTasks	xs:integer	How many instances to create for a spout/bolt. A task runs on a thread with zero or more other tasks for the same spout/bolt. The number of tasks for a spout/bolt is always the same throughout the lifetime of a topology, but the number of executors (threads) for a spout/bolt can change over time. This allows a topology to scale to more or less resources without redeploying the topology or violating the constraints of Storm (such as a fields grouping guaranteeing that the same value goes to the same task).

Element	Type	Description
parallelismHint	<spring:bean/>	The initial number of executors (threads) this component should have.
schema	(<spring:bean/>)*	The set of fields output by this component.
source	<spring:bean/>

Element: bolt

Attribute	Type	Description
debug	xs:boolean	When set to true, Storm will log every message that's emitted.
maxSpoutPending	xs:integer	The maximum number of tuples that can be pending on a spout task at any given time. This config applies to individual tasks, not to spouts or topologies as a whole. A pending tuple is one that has been emitted from a spout but has not been acked or failed yet. Note that this config parameter has no effect for unreliable spouts that don't tag their tuples with a message id.
maxTaskParallelism	xs:integer	The maximum parallelism allowed for a component in this topology. This configuration is typically used in testing to limit the number of threads spawned in local mode.
name	xs:string	The name of this component.
numTasks	xs:integer	How many instances to create for a spout/bolt. A task runs on a thread with zero or more other tasks for the same spout/bolt. The number of tasks for a spout/bolt is always the same throughout the lifetime of a topology, but the number of executors (threads) for a spout/bolt can change over time. This allows a topology to scale to more or less resources without redeploying the topology or violating the constraints of Storm (such as a fields grouping guaranteeing that the same value goes to the same task).

Element	Type	Description
executor	<spring:bean/>
parallelismHint	<spring:bean/>	The initial number of executors (threads) this component should have.
schema	(<spring:bean/>)*	The set of fields output by this component.
subscription	subscribes	The details of what this bolt is subscribed to.

Element: fieldSet

Element	Type	Description
fields	(<spring:bean/>)*

Element: global

Element: localOrShuffle

Element: none

Element: pollingSpout

Attribute	Type	Description
debug	xs:boolean	When set to true, Storm will log every message that's emitted.
interval	xs:integer
maxSpoutPending	xs:integer	The maximum number of tuples that can be pending on a spout task at any given time. This config applies to individual tasks, not to spouts or topologies as a whole. A pending tuple is one that has been emitted from a spout but has not been acked or failed yet. Note that this config parameter has no effect for unreliable spouts that don't tag their tuples with a message id.
maxTaskParallelism	xs:integer	The maximum parallelism allowed for a component in this topology. This configuration is typically used in testing to limit the number of threads spawned in local mode.
name	xs:string	The name of this component.
numTasks	xs:integer	How many instances to create for a spout/bolt. A task runs on a thread with zero or more other tasks for the same spout/bolt. The number of tasks for a spout/bolt is always the same throughout the lifetime of a topology, but the number of executors (threads) for a spout/bolt can change over time. This allows a topology to scale to more or less resources without redeploying the topology or violating the constraints of Storm (such as a fields grouping guaranteeing that the same value goes to the same task).

Element	Type	Description
parallelismHint	<spring:bean/>	The initial number of executors (threads) this component should have.
schema	(<spring:bean/>)*	The set of fields output by this component.
source	<spring:bean/>
unit	<spring:bean/>

Element: properties

Attribute	Type	Description
debug	xs:boolean	When set to true, Storm will log every message that's emitted.

Element	Type	Description
workers	<spring:bean/>	How many processes should be spawned around the cluster to execute this topology. Each process will execute some number of tasks as threads within them. This parameter should be used in conjunction with the parallelism hints on each component in the topology to tune the performance of a topology.

Element: shellBolt

Attribute	Type	Description
debug	xs:boolean	When set to true, Storm will log every message that's emitted.
maxSpoutPending	xs:integer	The maximum number of tuples that can be pending on a spout task at any given time. This config applies to individual tasks, not to spouts or topologies as a whole. A pending tuple is one that has been emitted from a spout but has not been acked or failed yet. Note that this config parameter has no effect for unreliable spouts that don't tag their tuples with a message id.
maxTaskParallelism	xs:integer	The maximum parallelism allowed for a component in this topology. This configuration is typically used in testing to limit the number of threads spawned in local mode.
name	xs:string	The name of this component.
numTasks	xs:integer	How many instances to create for a spout/bolt. A task runs on a thread with zero or more other tasks for the same spout/bolt. The number of tasks for a spout/bolt is always the same throughout the lifetime of a topology, but the number of executors (threads) for a spout/bolt can change over time. This allows a topology to scale to more or less resources without redeploying the topology or violating the constraints of Storm (such as a fields grouping guaranteeing that the same value goes to the same task).

Element	Type	Description
command	(<spring:bean/>)*
executor	<spring:bean/>
parallelismHint	<spring:bean/>	The initial number of executors (threads) this component should have.
schema	(<spring:bean/>)*	The set of fields output by this component.
subscription	subscribes	The details of what this bolt is subscribed to.

Element: shuffle

Element: spout

Attribute	Type	Description
debug	xs:boolean	When set to true, Storm will log every message that's emitted.
maxSpoutPending	xs:integer	The maximum number of tuples that can be pending on a spout task at any given time. This config applies to individual tasks, not to spouts or topologies as a whole. A pending tuple is one that has been emitted from a spout but has not been acked or failed yet. Note that this config parameter has no effect for unreliable spouts that don't tag their tuples with a message id.
maxTaskParallelism	xs:integer	The maximum parallelism allowed for a component in this topology. This configuration is typically used in testing to limit the number of threads spawned in local mode.
name	xs:string	The name of this component.
numTasks	xs:integer	How many instances to create for a spout/bolt. A task runs on a thread with zero or more other tasks for the same spout/bolt. The number of tasks for a spout/bolt is always the same throughout the lifetime of a topology, but the number of executors (threads) for a spout/bolt can change over time. This allows a topology to scale to more or less resources without redeploying the topology or violating the constraints of Storm (such as a fields grouping guaranteeing that the same value goes to the same task).

Element	Type	Description
parallelismHint	<spring:bean/>	The initial number of executors (threads) this component should have.
schema	(<spring:bean/>)*	The set of fields output by this component.
source	<spring:bean/>

Element: stream

Attribute	Type	Description
id	xs:string

Element	Type	Description
schema	(<spring:bean/>)*

Element: subscribes

Attribute	Type	Description
to	xs:string

Element	Type	Description
distribution	all \| fieldSet \| global \| localOrShuffle \| none \| shuffle
stream	stream

Element: topology

Attribute	Type	Description
name	xs:string

Element	Type	Description
bolts	(<spring:bean/>)*
configuration	properties
spouts	(<spring:bean/>)*