Package org.graylog2.streams

Class StreamRouterEngine

java.lang.Object

org.graylog2.streams.StreamRouterEngine

public class StreamRouterEngine
extends Object

Stream routing engine to select matching streams for a message. This class is NOT thread-safe! Use one instance per thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamRouterEngine.Factory
static class	StreamRouterEngine.StreamTestMatch	Contains matching results for a stream.

Constructor Summary

Constructors

Constructor	Description
StreamRouterEngine(List<Stream> streams, ExecutorService executorService, StreamFaultManager streamFaultManager, StreamMetrics streamMetrics, javax.inject.Provider<Stream> defaultStreamProvider, com.codahale.metrics.MetricRegistry metricRegistry)

Method Summary

Modifier and Type	Method	Description
String	getFingerprint()	Returns the fingerprint of the engine instance.
List<Stream>	getStreams()	Returns the list of streams that are processed by the engine.
List<Stream>	match(Message message)	Returns a list of matching streams for the given message.
List<StreamRouterEngine.StreamTestMatch>	testMatch(Message message)	Returns a list of stream rule matches.

Methods inherited from class java.lang.Object

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

Constructor Details

StreamRouterEngine

@Inject
public StreamRouterEngine(List<Stream> streams,
 ExecutorService executorService,
 StreamFaultManager streamFaultManager,
 StreamMetrics streamMetrics,
 javax.inject.Provider<Stream> defaultStreamProvider,
 com.codahale.metrics.MetricRegistry metricRegistry)

Method Details

getStreams

public List<Stream> getStreams()

Returns the list of streams that are processed by the engine.

Returns:

the list of streams

getFingerprint

public String getFingerprint()

Returns the fingerprint of the engine instance.

Returns:

the fingerprint

match

public List<Stream> match(Message message)

Returns a list of matching streams for the given message.

Parameters:

message - the message

Returns:

the list of matching streams

testMatch

public List<StreamRouterEngine.StreamTestMatch> testMatch(Message message)

Returns a list of stream rule matches. Can be used to test streams and stream rule matches. This is meant for testing, do NOT use in production processing pipeline! (use match instead)

Parameters:

message - the message to match streams on