org.thales.punch.libraries.punchlang.impl

Class RuntimeContext

java.lang.Object

org.thales.punch.libraries.punchlang.impl.RuntimeContext

All Implemented Interfaces:

IRuntimeContext

public class RuntimeContext
extends Object
implements IRuntimeContext

The RuntimeContext stores everything we need to execute a punchlet.

To execute a punchlet we must keep track of a few things:
- All the regexes (grok, named or plain), compiled of courses.
- Indicator for debugging/tracing or reporting errors
- The top level tuple given to the PunchPlatform program for transformation.
- Compiled Siddhi rules

An instance of this class is created when the PunchPlatform program is compiled, and used then at each invocation.

Author:

dimi

Field Summary

Fields

Modifier and Type	Field and Description
io.krakens.grok.api.Grok[]	grokArray The array of compiled grok/regexes expressions.
static String	LOCAL_RESOURCES_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
RuntimeContext()
RuntimeContext(boolean isAsynchronous, List<Map.Entry<String,Tuple>> resources, List<Map.Entry<String,String>> siddhiRules, Map<String,String> strings, io.krakens.grok.api.Grok[] groks, org.apache.commons.net.util.SubnetUtils[] subnets, org.joda.time.format.DateTimeFormatter[] dateFormats, org.logstash.dissect.Dissector[] dissectors, String[] dateFormatStrings)
RuntimeContext(io.krakens.grok.api.Grok[] groks, org.apache.commons.net.util.SubnetUtils[] subnets, org.joda.time.format.DateTimeFormatter[] dateFormats, org.logstash.dissect.Dissector[] dissectors, String[] dateFormatStrings) Ctor.

Method Summary

Modifier and Type	Method and Description
void	addEvent(Tuple tuple) Adds a new asynchronous event to the queue.
void	addEventCallback(PunchletEventCallback callback) Register a user callback to process asynchronous events.
void	addRuntimeData(Object source, int key, Object o) Add a new object as part of the runtime context of a punchlet.
CidrMatchOperator	cidrmatch(int index) Return a CidrMatch operator for the corresponding index.
CidrMatchOperator	cidrmatch(Tuple cidr) Return a CidrMatch operator for the corresponding index.
Object	computeIfAbsent(String key, Function<? super String,?> mappingFunction)
DateOperator	date()
DateOperator	date(int index)
DateOperator	date(int dstIndex, int srcIndex)
void	debug()
DissectOperator	dissect(int index)
void	fireEvents(Punchlet punchlet) Notify the caller from the firing of some events.
Object	getAttachment(String key)
Tuple	getJsonResource(String name) Return a the content of a Json resource file, loaded as an in memory tuple
int	getLeadingLineNumber()
org.thales.punch.libraries.metrics.api.IMetricContext	getMetricsContext()
Tuple	getRootTuple()
String	getRule(String name) Return a siddhi rule defined as part of resource attached to this punchlet
Object	getRuntimeData(Object source, int key) Return a runtime object attached to a running punchlet.
String	getStringResource(String name) Return a the content of a string resource file content, loaded as an in memory tuple
GrokOperator	grok(GrokArgs... args)
boolean	isAsynchronous()
boolean	isVerbose()
void	remove(Tuple tuple) Remove a tuple.
void	schedule(Runnable r)
void	setAttachment(String key, Object value) Set an attachment
void	setLeadingLineNumber(int leadingLinesNumber)
void	setMetricContext(org.thales.punch.libraries.metrics.api.IMetricContext metricsContext)
void	setRootTuple(Tuple tuple) Set the top level tuple.
void	setVerbose(boolean verbose)
DateOperator	toDate() Return a date format operator for implicit date format.
DateOperator	toDate(int index) Return a pre-compiled date format operator for a the corresponding index.
DateOperator	toDate(int dstIndex, int srcIndex) Return a pre-compiled date format operator for a the corresponding source and destination index.

Methods inherited from class java.lang.Object

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

Field Detail

LOCAL_RESOURCES_DIRECTORY

public static String LOCAL_RESOURCES_DIRECTORY

grokArray

public final io.krakens.grok.api.Grok[] grokArray

The array of compiled grok/regexes expressions.

Constructor Detail

RuntimeContext

public RuntimeContext()

RuntimeContext

public RuntimeContext(boolean isAsynchronous,
                      List<Map.Entry<String,Tuple>> resources,
                      List<Map.Entry<String,String>> siddhiRules,
                      Map<String,String> strings,
                      io.krakens.grok.api.Grok[] groks,
                      org.apache.commons.net.util.SubnetUtils[] subnets,
                      org.joda.time.format.DateTimeFormatter[] dateFormats,
                      org.logstash.dissect.Dissector[] dissectors,
                      String[] dateFormatStrings)

Parameters:

isAsynchronous - true if the punchlet generates asynchronous events

resources - the resource tuples provided by configuration

siddhiRules - the siddhi rules

strings - the static string (i.e. file content)

groks - the grok patterns

subnets - the subnet utils compiled from the punchlet

dateFormats - the date formatter compiled from the punchlet

dissectors - the compiled dissectors

dateFormatStrings - the compiled date formats

RuntimeContext

public RuntimeContext(io.krakens.grok.api.Grok[] groks,
                      org.apache.commons.net.util.SubnetUtils[] subnets,
                      org.joda.time.format.DateTimeFormatter[] dateFormats,
                      org.logstash.dissect.Dissector[] dissectors,
                      String[] dateFormatStrings)

Ctor.

Parameters:

groks - the array of compiled regexes.

subnets - the compiled subnetutils.

dateFormats - the compiled date formatters

dissectors - the compiled dissectors

dateFormatStrings - the compiled date format array

Method Detail

addRuntimeData

public void addRuntimeData(Object source,
                           int key,
                           Object o)

Add a new object as part of the runtime context of a punchlet. Object are referenced by a source Object (typically a Tuple but can be anything) and an integer (typically a hash).

Specified by:

addRuntimeData in interface IRuntimeContext

Parameters:

source - source object

key - the object key

o - the target object

getMetricsContext

public org.thales.punch.libraries.metrics.api.IMetricContext getMetricsContext()

getJsonResource

public Tuple getJsonResource(String name)

Return a the content of a Json resource file, loaded as an in memory tuple

Parameters:

name - the name of the resource.

Returns:

the corresponding in memory tuple

getStringResource

public String getStringResource(String name)

Return a the content of a string resource file content, loaded as an in memory tuple

Parameters:

name - the name of the resource.

Returns:

the corresponding in memory string

getRule

public String getRule(String name)

Return a siddhi rule defined as part of resource attached to this punchlet

Parameters:

name - the name of the rule

Returns:

the corresponding siddhi rule

dissect

public DissectOperator dissect(int index)

cidrmatch

public CidrMatchOperator cidrmatch(int index)

Return a CidrMatch operator for the corresponding index.

This is called directly by the punchlet at runtime. Return a CidrMatch operator ready to be used, already compiled. The index corresponds to a setup SubnetUtils object.

Parameters:

index - the index of the compiled subnet utils.

Returns:

a ready to use operator.

cidrmatch

public CidrMatchOperator cidrmatch(Tuple cidr)

Return a CidrMatch operator for the corresponding index.

This is called directly by the punchlet at runtime. Return a CidrMatch operator ready to be used, already compiled. The index corresponds to a setup SubnetUtils object.

Parameters:

cidr - the tuple where to find the input value

Returns:

a ready to use operator.

date

public DateOperator date()

date

public DateOperator date(int index)

date

public DateOperator date(int dstIndex,
                         int srcIndex)

debug

public void debug()

getRootTuple

public Tuple getRootTuple()

Returns:

the root tuple of your punchlet.

getRuntimeData

public Object getRuntimeData(Object source,
                             int key)

Return a runtime object attached to a running punchlet.

Specified by:

getRuntimeData in interface IRuntimeContext

Parameters:

source - the source object that requires an attachment

key - the name of the property that will be used for the query

Returns:

the runtime attachment

grok

public GrokOperator grok(GrokArgs... args)

isVerbose

public boolean isVerbose()

remove

public void remove(Tuple tuple)

Remove a tuple. That means removing a child tuple from his father map. It has no effect on a root tuple but to make it empty.

Parameters:

tuple - the tuple to remove

schedule

public void schedule(Runnable r)

setRootTuple

public void setRootTuple(Tuple tuple)

Set the top level tuple. This is called before executing a PunchPlatform program. Every time a logs or a tuple is injected.

Parameters:

tuple - the tuple to use as root tuple

setVerbose

public void setVerbose(boolean verbose)

toDate

public DateOperator toDate()

Return a date format operator for implicit date format.

This is called directly by the punchlet at runtime.

Returns:

a date operator ready to be used.

toDate

public DateOperator toDate(int index)

Return a pre-compiled date format operator for a the corresponding index.

This is called directly by the punchlet at runtime.

Parameters:

index - the index of the compiled date format

Returns:

a date operator ready to be used.

toDate

public DateOperator toDate(int dstIndex,
                           int srcIndex)

Return a pre-compiled date format operator for a the corresponding source and destination index.

This is called directly by the punchlet at runtime.

Parameters:

dstIndex - the index of the destination date

srcIndex - the index of the target date

Returns:

a date operator ready to be used.

addEventCallback

public void addEventCallback(PunchletEventCallback callback)

Register a user callback to process asynchronous events.

Parameters:

callback - the event callback

addEvent

public void addEvent(Tuple tuple)

Adds a new asynchronous event to the queue. It will be reprocessed later.

Parameters:

tuple - the event as a tuple

fireEvents

public void fireEvents(Punchlet punchlet)

Notify the caller from the firing of some events.

Parameters:

punchlet - the corresponding caller punchlet.

isAsynchronous

public boolean isAsynchronous()

Returns:

true if the punchlet generates some asynchronous events. As of now only punchlet using siddhi do that.

getAttachment

public Object getAttachment(String key)

Parameters:

key - the attachment key

Returns:

the corresponding attachment or null if not found

computeIfAbsent

public Object computeIfAbsent(String key,
                              Function<? super String,?> mappingFunction)

Parameters:

key - the attachment key

mappingFunction - the mapping function called if absent

Returns:

the corresponding attachment or null if not found

setAttachment

public void setAttachment(String key,
                          Object value)

Set an attachment

Parameters:

key - the key

value - the attached value

setMetricContext

public void setMetricContext(org.thales.punch.libraries.metrics.api.IMetricContext metricsContext)

setLeadingLineNumber

public void setLeadingLineNumber(int leadingLinesNumber)

getLeadingLineNumber

public int getLeadingLineNumber()