org.thales.punch.libraries.storm.spout.impl

Class TcpSyslogServer<T>

java.lang.Object

org.thales.punch.libraries.storm.spout.impl.TcpSyslogServer<T>

All Implemented Interfaces:

AutoCloseable, Runnable, ISyslogServer, org.thales.punch.netty.api.INettyReaderCallback<T>

public class TcpSyslogServer<T>
extends Object
implements org.thales.punch.netty.api.INettyReaderCallback<T>, ISyslogServer

This syslog server puts all the received log lines in a queue, ready to be consumed by a storm spout. In addition, it provides different codecs : XML, Json, Multiline .. prefix. All the caller has to do is to regularly call the tick() method so that a single log received with no subsequent line gets emitted after a timeout.

T is the type of the handled data. As of today it is always a String.

Author:

dimi

Constructor Summary

Constructors

Constructor and Description
TcpSyslogServer(org.thales.punch.settings.api.ISettingsMap settings, org.thales.punch.libraries.metrics.api.IMetricContext metricsContext, ISyslogReceiver<T> receiver)

Method Summary

Modifier and Type	Method and Description
TcpSyslogServer<T>	addListeningAddress(org.thales.punch.settings.api.ISettingsMap settings, ISyslogReceiver<T> receiver) Add a listening address to this server.
void	close() Close the server
static <T> org.thales.punch.punchlang.util.ICodec<T>	getCodec(org.thales.punch.settings.api.ISettingsMap settings) Build specific codec from the caller configuration.
Class<?>	getType()
void	onActive(io.netty.channel.ChannelHandlerContext channelHandlerContext)
void	onInactive(io.netty.channel.ChannelHandlerContext channelHandlerContext)
void	onReceive(io.netty.channel.ChannelHandlerContext channelHandlerContext, org.thales.punch.netty.api.INettyTuple<T> tuple)
void	run()
void	tick() Flush buffers after timeout, tick is only implemented for multiline codecs

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.netty.api.INettyReaderCallback

onThrowable

Constructor Detail

TcpSyslogServer

public TcpSyslogServer(org.thales.punch.settings.api.ISettingsMap settings,
                       org.thales.punch.libraries.metrics.api.IMetricContext metricsContext,
                       ISyslogReceiver<T> receiver)

Method Detail

tick

public void tick()

Flush buffers after timeout, tick is only implemented for multiline codecs

Specified by:

tick in interface ISyslogServer

onActive

public void onActive(io.netty.channel.ChannelHandlerContext channelHandlerContext)

Specified by:

onActive in interface org.thales.punch.netty.api.INettyReaderCallback<T>

onInactive

public void onInactive(io.netty.channel.ChannelHandlerContext channelHandlerContext)

Specified by:

onInactive in interface org.thales.punch.netty.api.INettyReaderCallback<T>

onReceive

public void onReceive(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                      org.thales.punch.netty.api.INettyTuple<T> tuple)

Specified by:

onReceive in interface org.thales.punch.netty.api.INettyReaderCallback<T>

run

public void run()

Specified by:

run in interface Runnable

close

public void close()

Close the server

Specified by:

close in interface AutoCloseable

getCodec

public static <T> org.thales.punch.punchlang.util.ICodec<T> getCodec(org.thales.punch.settings.api.ISettingsMap settings)

Build specific codec from the caller configuration.

Parameters:

settings - the settings map with host port properties

Returns:

codec

addListeningAddress

public TcpSyslogServer<T> addListeningAddress(org.thales.punch.settings.api.ISettingsMap settings,
                                              ISyslogReceiver<T> receiver)

Add a listening address to this server. This register one more listening host/port to the underlying single thread netty channel.

Parameters:

settings - the settings map that includes the listenings host port properties

receiver - the receiver interested by the data

Returns:

this server

getType

public Class<?> getType()

Specified by:

getType in interface org.thales.punch.netty.api.INettyReaderCallback<T>