at.jku.fim.rubanetra.config.model

Interface RubanetraSystemConfiguration

public interface RubanetraSystemConfiguration

The generic specification of the system configuration itself. This may be considered to constitute many of the essential settings, i.e. how and where to write the derived data, the Pcap packet input stream, the input files, the Drools knowledge session. Use a RubanetraSystemConfigurationBuilder to obtain an implementation instance programmatically.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RubanetraSystemConfiguration.InputFormat The enumeration of possible input formats, used for defining the appropriate input file handler without guessing
static class	RubanetraSystemConfiguration.OutputFormat The enumeration of possible output formats, used for transforming derived data before it is written to the output stream.

Method Summary

Modifier and Type	Method and Description
Set<File>	getInputFiles() The set of input files possibly adhering to a PCAP-specification.
RubanetraSystemConfiguration.InputFormat	getInputFormat() The format of all input files (currently always PCAP)
org.kie.api.runtime.KieSession	getKieSession() The Drools knowledge session reference, used to pass new facts to the rule engine decoded by the protocol parsers.
RubanetraSystemConfiguration.OutputFormat	getOutputFormat() The format that is used to transform the derived data before it is written to the output-stream.
OutputStream	getOutputStream() The main output stream that is used to write all derived information to.
OutputWriterStrategy	getOutputWriterStrategy() The writer strategy that is used to transform (using getOutputFormat()) and finally write (using getOutputStream()) the derived data (delivered from getKieSession()).
PcapFileHandler<?>	getPcapHandler() The Pcap packet input stream handler that is used to parse and react to Pcap-information from the set of defined input files.
Set<KrakenProtocolConfiguration>	getProtocolSettings() The set of all defined protocol configurations, each representing the complete configuration of a Kraken protocol parser/decoder, containing protocol mappings (ETHERNET->IPv4->...->...).

Method Detail

getOutputStream

OutputStream getOutputStream()

The main output stream that is used to write all derived information to. The format of this data is defined by the RubanetraSystemConfiguration.OutputFormat, seegetOutputFormat(). The point of time that defines when the data is actually written to this stream, is controlled by the OutputWriterStrategy, see getOutputWriterStrategy(), and the Drools knowledge session (i.e. the Rule engine and custom rules).

Returns:

the main output stream of the derived information

getOutputFormat

RubanetraSystemConfiguration.OutputFormat getOutputFormat()

The format that is used to transform the derived data before it is written to the output-stream.

Returns:

the format to use for data transformation

See Also:

getOutputStream()

getOutputWriterStrategy

OutputWriterStrategy getOutputWriterStrategy()

The writer strategy that is used to transform (using getOutputFormat()) and finally write (using getOutputStream()) the derived data (delivered from getKieSession()).

Returns:

the defined writer strategy

See Also:

getOutputStream(), getOutputFormat()

getProtocolSettings

Set<KrakenProtocolConfiguration> getProtocolSettings()

The set of all defined protocol configurations, each representing the complete configuration of a Kraken protocol parser/decoder, containing protocol mappings (ETHERNET->IPv4->...->...).

Returns:

the immutable set of defined Kraken protocol parser configurations

getPcapHandler

PcapFileHandler<?> getPcapHandler()

The Pcap packet input stream handler that is used to parse and react to Pcap-information from the set of defined input files.

Returns:

the pcap input stream handler

getInputFiles

Set<File> getInputFiles()

The set of input files possibly adhering to a PCAP-specification.

Returns:

the set of pcap input files used for parsing pcap-packets

getInputFormat

RubanetraSystemConfiguration.InputFormat getInputFormat()

The format of all input files (currently always PCAP)

Returns:

the common input format of all files

getKieSession

org.kie.api.runtime.KieSession getKieSession()

The Drools knowledge session reference, used to pass new facts to the rule engine decoded by the protocol parsers.

Returns:

the Drools knowledge session reference