RubanetraSystemConfigurationBaseListenerImpl (Rubanetra 0.0.6 API)

java.lang.Object
- at.jku.fim.rubanetra.config.RubanetraSystemConfigurationBaseListener
- - at.jku.fim.rubanetra.config.model.impl.RubanetraSystemConfigurationBaseListenerImpl

All Implemented Interfaces:

RubanetraSystemConfigurationListener, org.antlr.v4.runtime.tree.ParseTreeListener
```
public class RubanetraSystemConfigurationBaseListenerImpl
extends RubanetraSystemConfigurationBaseListener
```
This class represents the implementation of the listener interface that was created previously by the ANTLRv4 parser. One of the first step of the system is to parse its own configuration. This implementation may be used to parse all main configuration parts, i.e. input/output, protocol and Drools specific settings can be handled by this class.
A RubanetraSystemConfigurationBuilder is mainly utilized, including a KrakenProtocolConfigurationBuilderImpl to perform the construction of the main configuration that may be used to further initialize the system. In order to allow further customizations this listener does not invoke the final call to RubanetraSystemConfigurationBuilder.create(), therefore it is the objects instantiator's obligation to ensure completeness of the configuration and the construction of the RubanetraSystemConfiguration.
An appropriate ANTLR parser object can be created by calling the static method createConfigurationFileParser(java.io.File) by passing a valid a configuration file. The parser should then be pointed to the root node, i.e.:
RubanetraSystemConfigurationParser systemConfigParser = RubanetraSystemConfigurationBaseListenerImpl.createConfigurationFileParser(mainConfigFile); RubanetraSystemConfigurationParser.SystemContext systemContext = systemConfigParser.system();
And finally a ParseTreeWalker may then be used to traverse the parse tree of the general configuration:
ParseTreeWalker.DEFAULT.walk(systemConfigBaseListener, systemContext.generalConfig(0));

Constructor Summary

Constructors
Constructor and Description
`RubanetraSystemConfigurationBaseListenerImpl(RubanetraSystemConfigurationBuilder systemConfigBuilder)` Creates a new listener instance, which may be used to react to parsing event generated by a `RubanetraSystemConfigurationParser`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RubanetraSystemConfigurationParser`	`createConfigurationFileParser(File configurationFile)`
`void`	`enterBpfFilterString(RubanetraSystemConfigurationParser.BpfFilterStringContext ctx)` ********************************************************************** General configuration options will be parsed by the following methods.
`void`	`enterBpfNetmask(RubanetraSystemConfigurationParser.BpfNetmaskContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.bpfNetmask()`.
`void`	`enterBpfOptimize(RubanetraSystemConfigurationParser.BpfOptimizeContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.bpfOptimize()`.
`void`	`enterDroolsBaseModelName(RubanetraSystemConfigurationParser.DroolsBaseModelNameContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.droolsBaseModelName()`.
`void`	`enterDroolsConfigurationFile(RubanetraSystemConfigurationParser.DroolsConfigurationFileContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.droolsConfigurationFile()`.
`void`	`enterDroolsSessionModelName(RubanetraSystemConfigurationParser.DroolsSessionModelNameContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.droolsSessionModelName()`.
`void`	`enterInputConfigurationFileSetting(RubanetraSystemConfigurationParser.InputConfigurationFileSettingContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.inputConfigurationFileSetting()`.
`void`	`enterInputFormat(RubanetraSystemConfigurationParser.InputFormatContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.inputFormat()`.
`void`	`enterInputSpecification(RubanetraSystemConfigurationParser.InputSpecificationContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.inputSpecification()`.
`void`	`enterOutputConfigurationFileSetting(RubanetraSystemConfigurationParser.OutputConfigurationFileSettingContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.outputConfigurationFileSetting()`.
`void`	`enterOutputFormat(RubanetraSystemConfigurationParser.OutputFormatContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.outputFormat()`.
`void`	`enterOutputSpecification(RubanetraSystemConfigurationParser.OutputSpecificationContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.outputSpecification()`.
`void`	`enterPortSpecification(RubanetraSystemConfigurationParser.PortSpecificationContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.portSpecification()`.
`void`	`enterProtocolConfig(RubanetraSystemConfigurationParser.ProtocolConfigContext ctx)` This method will be called by a `ParseTreeWalker` only if the protocol configuration section was specified within the main system configuration file and not in a separate file.
`void`	`enterProtocolConfigurationFileSetting(RubanetraSystemConfigurationParser.ProtocolConfigurationFileSettingContext ctx)` This method will be called by a `ParseTreeWalker` only if the optional protocol configuration file setting was specified by the user in the main system configuration file.
`void`	`enterProtocolSetting(RubanetraSystemConfigurationParser.ProtocolSettingContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.protocolSetting()`.
`void`	`enterSortByFirstTimestamp(RubanetraSystemConfigurationParser.SortByFirstTimestampContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.sortByFirstTimestamp()`.
`void`	`enterSystem(RubanetraSystemConfigurationParser.SystemContext ctx)` Enter a parse tree produced by `RubanetraSystemConfigurationParser.system()`.
`void`	`exitInputConfig(RubanetraSystemConfigurationParser.InputConfigContext ctx)` ********************************************************************** Dynamic I/O configuration options will be parsed by the following methods.
`void`	`exitSystem(RubanetraSystemConfigurationParser.SystemContext ctx)` Exit a parse tree produced by `RubanetraSystemConfigurationParser.system()`.

Methods inherited from class at.jku.fim.rubanetra.config.RubanetraSystemConfigurationBaseListener
enterEveryRule, enterFilePath, enterGeneralConfig, enterGeneralSetting, enterInputConfig, enterInputSetting, enterIpv4, enterIpv6, enterMultiplePorts, enterOptIPv6Trailer, enterOutputConfig, enterOutputSetting, enterPortRange, enterProtocolBinding, enterProtocolHeader, enterProtocolId, enterRegexFlag, enterSinglePort, enterTransportLayerMappingSetting, enterTransportLayerMappingStrategy, exitBpfFilterString, exitBpfNetmask, exitBpfOptimize, exitDroolsBaseModelName, exitDroolsConfigurationFile, exitDroolsSessionModelName, exitEveryRule, exitFilePath, exitGeneralConfig, exitGeneralSetting, exitInputConfigurationFileSetting, exitInputFormat, exitInputSetting, exitInputSpecification, exitIpv4, exitIpv6, exitMultiplePorts, exitOptIPv6Trailer, exitOutputConfig, exitOutputConfigurationFileSetting, exitOutputFormat, exitOutputSetting, exitOutputSpecification, exitPortRange, exitPortSpecification, exitProtocolBinding, exitProtocolConfig, exitProtocolConfigurationFileSetting, exitProtocolHeader, exitProtocolId, exitProtocolSetting, exitRegexFlag, exitSinglePort, exitSortByFirstTimestamp, exitTransportLayerMappingSetting, exitTransportLayerMappingStrategy, visitErrorNode, visitTerminal

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RubanetraSystemConfigurationBaseListenerImpl
```
public RubanetraSystemConfigurationBaseListenerImpl(RubanetraSystemConfigurationBuilder systemConfigBuilder)
```
    Creates a new listener instance, which may be used to react to parsing event generated by a RubanetraSystemConfigurationParser.
    
    Parameters:
    
    systemConfigBuilder - an instance of a builder which will be used to setup the system configuration, may not be null
    
    Throws:
    
    IllegalArgumentException - if parser errors are encountered
- Method Detail
  - createConfigurationFileParser
```
public static RubanetraSystemConfigurationParser createConfigurationFileParser(File configurationFile)
```
  - enterSystem
```
public void enterSystem(@NotNull
                        RubanetraSystemConfigurationParser.SystemContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.system().
    The default implementation does nothing.
    
    Specified by:
    
    enterSystem in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterSystem in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - exitSystem
```
public void exitSystem(@NotNull
                       RubanetraSystemConfigurationParser.SystemContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Exit a parse tree produced by RubanetraSystemConfigurationParser.system().
    The default implementation does nothing.
    
    Specified by:
    
    exitSystem in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    exitSystem in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterProtocolConfig
```
public void enterProtocolConfig(@NotNull
                                RubanetraSystemConfigurationParser.ProtocolConfigContext ctx)
```
    This method will be called by a ParseTreeWalker only if the protocol configuration section was specified within the main system configuration file and not in a separate file.
    
    Specified by:
    
    enterProtocolConfig in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterProtocolConfig in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterProtocolSetting
```
public void enterProtocolSetting(@NotNull
                                 RubanetraSystemConfigurationParser.ProtocolSettingContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.protocolSetting().
    The default implementation does nothing.
    
    Specified by:
    
    enterProtocolSetting in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterProtocolSetting in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterPortSpecification
```
public void enterPortSpecification(@NotNull
                                   RubanetraSystemConfigurationParser.PortSpecificationContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.portSpecification().
    The default implementation does nothing.
    
    Specified by:
    
    enterPortSpecification in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterPortSpecification in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterBpfFilterString
```
public void enterBpfFilterString(@NotNull
                                 RubanetraSystemConfigurationParser.BpfFilterStringContext ctx)
```
    ********************************************************************** General configuration options will be parsed by the following methods. Semantic checks will be performed by the RubanetraSystemConfigurationBuilder only. **********************************************************************
    
    Specified by:
    
    enterBpfFilterString in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterBpfFilterString in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterBpfNetmask
```
public void enterBpfNetmask(@NotNull
                            RubanetraSystemConfigurationParser.BpfNetmaskContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.bpfNetmask().
    The default implementation does nothing.
    
    Specified by:
    
    enterBpfNetmask in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterBpfNetmask in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterBpfOptimize
```
public void enterBpfOptimize(@NotNull
                             RubanetraSystemConfigurationParser.BpfOptimizeContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.bpfOptimize().
    The default implementation does nothing.
    
    Specified by:
    
    enterBpfOptimize in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterBpfOptimize in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterDroolsBaseModelName
```
public void enterDroolsBaseModelName(@NotNull
                                     RubanetraSystemConfigurationParser.DroolsBaseModelNameContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.droolsBaseModelName().
    The default implementation does nothing.
    
    Specified by:
    
    enterDroolsBaseModelName in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterDroolsBaseModelName in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterDroolsSessionModelName
```
public void enterDroolsSessionModelName(@NotNull
                                        RubanetraSystemConfigurationParser.DroolsSessionModelNameContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.droolsSessionModelName().
    The default implementation does nothing.
    
    Specified by:
    
    enterDroolsSessionModelName in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterDroolsSessionModelName in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterProtocolConfigurationFileSetting
```
public void enterProtocolConfigurationFileSetting(@NotNull
                                                  RubanetraSystemConfigurationParser.ProtocolConfigurationFileSettingContext ctx)
```
    This method will be called by a ParseTreeWalker only if the optional protocol configuration file setting was specified by the user in the main system configuration file. It will be assumed that there will not follow a separate protocol configuration section within the main configuration file, i.e. the enterProtocolConfig(at.jku.fim.rubanetra.config.RubanetraSystemConfigurationParser.ProtocolConfigContext) will not be called by the ParseTreeWalker (otherwise the user has specified two separate protocol configuration sections, one within the main system configuration and one in a different file, which is not allowed).
    
    Specified by:
    
    enterProtocolConfigurationFileSetting in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterProtocolConfigurationFileSetting in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterDroolsConfigurationFile
```
public void enterDroolsConfigurationFile(@NotNull
                                         RubanetraSystemConfigurationParser.DroolsConfigurationFileContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.droolsConfigurationFile().
    The default implementation does nothing.
    
    Specified by:
    
    enterDroolsConfigurationFile in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterDroolsConfigurationFile in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterInputConfigurationFileSetting
```
public void enterInputConfigurationFileSetting(@NotNull
                                               RubanetraSystemConfigurationParser.InputConfigurationFileSettingContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.inputConfigurationFileSetting().
    The default implementation does nothing.
    
    Specified by:
    
    enterInputConfigurationFileSetting in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterInputConfigurationFileSetting in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterOutputConfigurationFileSetting
```
public void enterOutputConfigurationFileSetting(@NotNull
                                                RubanetraSystemConfigurationParser.OutputConfigurationFileSettingContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.outputConfigurationFileSetting().
    The default implementation does nothing.
    
    Specified by:
    
    enterOutputConfigurationFileSetting in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterOutputConfigurationFileSetting in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - exitInputConfig
```
public void exitInputConfig(@NotNull
                            RubanetraSystemConfigurationParser.InputConfigContext ctx)
```
    ********************************************************************** Dynamic I/O configuration options will be parsed by the following methods. Semantic checks will be performed by the RubanetraSystemConfigurationBuilder only. **********************************************************************
    
    Specified by:
    
    exitInputConfig in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    exitInputConfig in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterInputSpecification
```
public void enterInputSpecification(@NotNull
                                    RubanetraSystemConfigurationParser.InputSpecificationContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.inputSpecification().
    The default implementation does nothing.
    
    Specified by:
    
    enterInputSpecification in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterInputSpecification in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterInputFormat
```
public void enterInputFormat(@NotNull
                             RubanetraSystemConfigurationParser.InputFormatContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.inputFormat().
    The default implementation does nothing.
    
    Specified by:
    
    enterInputFormat in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterInputFormat in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterSortByFirstTimestamp
```
public void enterSortByFirstTimestamp(@NotNull
                                      RubanetraSystemConfigurationParser.SortByFirstTimestampContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.sortByFirstTimestamp().
    The default implementation does nothing.
    
    Specified by:
    
    enterSortByFirstTimestamp in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterSortByFirstTimestamp in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterOutputSpecification
```
public void enterOutputSpecification(@NotNull
                                     RubanetraSystemConfigurationParser.OutputSpecificationContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.outputSpecification().
    The default implementation does nothing.
    
    Specified by:
    
    enterOutputSpecification in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterOutputSpecification in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree
  - enterOutputFormat
```
public void enterOutputFormat(@NotNull
                              RubanetraSystemConfigurationParser.OutputFormatContext ctx)
```
    Description copied from class: RubanetraSystemConfigurationBaseListener
    
    Enter a parse tree produced by RubanetraSystemConfigurationParser.outputFormat().
    The default implementation does nothing.
    
    Specified by:
    
    enterOutputFormat in interface RubanetraSystemConfigurationListener
    
    Overrides:
    
    enterOutputFormat in class RubanetraSystemConfigurationBaseListener
    
    Parameters:
    
    ctx - the parse tree

Class RubanetraSystemConfigurationBaseListenerImpl

Constructor Summary

Method Summary

Methods inherited from class at.jku.fim.rubanetra.config.RubanetraSystemConfigurationBaseListener

Methods inherited from class java.lang.Object

Constructor Detail

RubanetraSystemConfigurationBaseListenerImpl

Method Detail

createConfigurationFileParser

enterSystem

exitSystem

enterProtocolConfig

enterProtocolSetting

enterPortSpecification

enterBpfFilterString

enterBpfNetmask

enterBpfOptimize

enterDroolsBaseModelName

enterDroolsSessionModelName

enterProtocolConfigurationFileSetting

enterDroolsConfigurationFile

enterInputConfigurationFileSetting

enterOutputConfigurationFileSetting

exitInputConfig

enterInputSpecification

enterInputFormat

enterSortByFirstTimestamp

enterOutputSpecification

enterOutputFormat