org.thales.punch.libraries.storm.spout

Class AbstractSocketInput<T>

java.lang.Object

org.apache.storm.topology.base.BaseComponent

org.apache.storm.topology.base.BaseRichSpout

org.thales.punch.libraries.storm.api.BaseInputNode

org.thales.punch.libraries.storm.spout.AbstractSocketInput<T>

Type Parameters:

T - type the netty tuple comtent.

All Implemented Interfaces:

Serializable, org.apache.storm.spout.ISpout, org.apache.storm.topology.IComponent, org.apache.storm.topology.IRichSpout

Direct Known Subclasses:

HttpInput, LumberjackInput, RelpInput, SyslogInput

public abstract class AbstractSocketInput<T>
extends org.thales.punch.libraries.storm.api.BaseInputNode

Base class for socket servers spouts : http, lumberjack relp and plain syslog.

Refer to each for its javadoc documentation.

Author:

dimi

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Charset	charset

Fields inherited from class org.thales.punch.libraries.storm.api.BaseInputNode

collector, exitCondition, latencyRecordSender, loadController, metricContext, myself, nodeSettings

Constructor Summary

Constructors

Constructor and Description
AbstractSocketInput(org.thales.punch.libraries.storm.api.NodeSettings spoutSettings, org.apache.logging.log4j.Logger subLogger) A Spout constructor is in charge of setting the fields that will be required later on when the spout will be effectively started and run somewhere in the cluster.

Method Summary

Modifier and Type	Method and Description
void	ack(Object o)
void	fail(Object o)
protected String	getSocketHostAddress(InetSocketAddress addr)
void	open(Map stormSettings, org.apache.storm.task.TopologyContext topologyContext, org.apache.storm.spout.SpoutOutputCollector collector) Setup this spout before it starts receiving data and emitting tuples into the topology.

Methods inherited from class org.thales.punch.libraries.storm.api.BaseInputNode

close, deactivate, declareOutputFields, getPublishedStreams, regulate, sendLatencyRecord

Methods inherited from class org.apache.storm.topology.base.BaseRichSpout

activate

Methods inherited from class org.apache.storm.topology.base.BaseComponent

getComponentConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.thales.punch.libraries.storm.api.ISpout

registerNextTupleCallback

Methods inherited from interface org.apache.storm.spout.ISpout

activate, nextTuple

Methods inherited from interface org.apache.storm.topology.IComponent

getComponentConfiguration

Field Detail

charset

protected transient Charset charset

Constructor Detail

AbstractSocketInput

public AbstractSocketInput(org.thales.punch.libraries.storm.api.NodeSettings spoutSettings,
                           org.apache.logging.log4j.Logger subLogger)

A Spout constructor is in charge of setting the fields that will be required later on when the spout will be effectively started and run somewhere in the cluster. Each field set here must be serializable. Here we use a simple scheme: the complete settings, passed as Json, are serialized as a string. We only check that the mandatory properties are present.

Parameters:

spoutSettings - the spout configuration

subLogger - a logger ot make it easier to identify trhe source class

Method Detail

open

public void open(Map stormSettings,
                 org.apache.storm.task.TopologyContext topologyContext,
                 org.apache.storm.spout.SpoutOutputCollector collector)

Setup this spout before it starts receiving data and emitting tuples into the topology.

This is called by the Storm runtime at topology activation.

Specified by:

open in interface org.apache.storm.spout.ISpout

Overrides:

open in class org.thales.punch.libraries.storm.api.BaseInputNode

Parameters:

stormSettings - storm configuration

topologyContext - the storm topology context

collector - the output collector for emitting tuples.

ack

public void ack(Object o)

Specified by:

ack in interface org.apache.storm.spout.ISpout

Overrides:

ack in class org.thales.punch.libraries.storm.api.BaseInputNode

fail

public void fail(Object o)

Specified by:

fail in interface org.apache.storm.spout.ISpout

Overrides:

fail in class org.thales.punch.libraries.storm.api.BaseInputNode

getSocketHostAddress

protected String getSocketHostAddress(InetSocketAddress addr)