nl.basjes.parse.httpdlog.dissectors.tokenformat

Class TokenFormatDissector

java.lang.Object

nl.basjes.parse.core.Dissector

nl.basjes.parse.httpdlog.dissectors.tokenformat.TokenFormatDissector

Direct Known Subclasses:

ApacheHttpdLogFormatDissector, NginxHttpdLogFormatDissector

public abstract class TokenFormatDissector
extends Dissector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenFormatDissector.FixedStringTokenParser

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIXED_STRING_TYPE

Constructor Summary

Constructors

Constructor and Description
TokenFormatDissector()
TokenFormatDissector(String logFormat)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	cleanupLogFormat(String tokenLogFormat) This should be overridden if there is a need to cleanup the actual logformat before parsing.
protected abstract List<TokenParser>	createAllTokenParsers()
abstract String	decodeExtractedValue(String tokenName, String value)
void	dissect(Parsable<?> parsable, String inputname)
String	getInputType()
String	getLogFormat()
String	getLogFormatRegEx()
List<String>	getPossibleOutput()
boolean	initializeFromSettingsParameter(String settings)
protected void	initializeNewInstance(Dissector newInstance)
EnumSet<Casts>	prepareForDissect(String inputName, String outputName)
void	prepareForRun()
protected void	setInputType(String newInputType)
void	setLogFormat(String logformat)

Methods inherited from class nl.basjes.parse.core.Dissector

getNewInstance

Methods inherited from class java.lang.Object

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

Field Detail

FIXED_STRING_TYPE

public static final String FIXED_STRING_TYPE

See Also:

Constant Field Values

Constructor Detail

TokenFormatDissector

public TokenFormatDissector(String logFormat)

TokenFormatDissector

public TokenFormatDissector()

Method Detail

initializeFromSettingsParameter

public boolean initializeFromSettingsParameter(String settings)

Specified by:

initializeFromSettingsParameter in class Dissector

initializeNewInstance

protected void initializeNewInstance(Dissector newInstance)

Specified by:

initializeNewInstance in class Dissector

setLogFormat

public void setLogFormat(String logformat)

getLogFormat

public String getLogFormat()

getLogFormatRegEx

public String getLogFormatRegEx()

prepareForDissect

public EnumSet<Casts> prepareForDissect(String inputName,
                               String outputName)

Specified by:

prepareForDissect in class Dissector

prepareForRun

public void prepareForRun()
                   throws InvalidDissectorException

Specified by:

prepareForRun in class Dissector

Throws:

InvalidDissectorException

setInputType

protected void setInputType(String newInputType)

getInputType

public String getInputType()

Specified by:

getInputType in class Dissector

getPossibleOutput

public List<String> getPossibleOutput()

Specified by:

getPossibleOutput in class Dissector

decodeExtractedValue

public abstract String decodeExtractedValue(String tokenName,
                          String value)

Parameters:

tokenName - Name of the token that was found

value - The actual value as it is present in the logline

Returns:

The cleaned/decoded/interpreted version of the value.

dissect

public void dissect(Parsable<?> parsable,
           String inputname)
             throws DissectionFailure

Specified by:

dissect in class Dissector

Throws:

DissectionFailure

cleanupLogFormat

protected String cleanupLogFormat(String tokenLogFormat)

This should be overridden if there is a need to cleanup the actual logformat before parsing.

Parameters:

tokenLogFormat - the 'dirty' logformat

Returns:

the cleaned version of the tokenLogFormat.

createAllTokenParsers

protected abstract List<TokenParser> createAllTokenParsers()