org.thales.punch.libraries.punchlang.api

Class Punchlets

java.lang.Object

org.thales.punch.libraries.punchlang.impl.PunchletContext

org.thales.punch.libraries.punchlang.api.Punchlet

org.thales.punch.libraries.punchlang.api.Punchlets

Direct Known Subclasses:

PunchletDag, PunchletSequence

public abstract class Punchlets
extends Punchlet

Most often several punchlets are grouped as one executable unit.

There are two variants : a sequence of punchlet, or more advanced dags of punchlet whenver multi-threaded partallelism is required.

Author:

dimi

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Punchlet>	punchletList The list of individual punchlets

Fields inherited from class org.thales.punch.libraries.punchlang.api.Punchlet

_threadLocal, LOG

Fields inherited from class org.thales.punch.libraries.punchlang.impl.PunchletContext

child, code, eventCount, metricRegistry, r, uuidGenerator, world

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Punchlets(RuntimeContext runtimeContext)

Method Summary

Modifier and Type	Method and Description
boolean	__isChained() some punchlet are made of a chain of several punchlets.
void	activate() The activate method is called after startup, and before receiving input tuples.
Punchlet	addEventCallback(PunchletEventCallback callback) This method is not meant to be executed from within a punchlet.
boolean	isAsynchronous() Some punchlets generate asynchronous events.
Punchlet	setMetricContext(org.thales.punch.libraries.metrics.api.IMetricContext metricsContext) Associate a metric context with this punchlet.

Methods inherited from class org.thales.punch.libraries.punchlang.api.Punchlet

attach, bug, cef, cidrRange, cidrRange, coalesce, contains, contains, convert, convert, csv, currentTimeMillis, currentTimeNanos, date, date, date, dissect, dump, fetchCsv, fetchCsv, fetchJson, fetchJson, findByInterval, findByInterval, findByInterval, findByKey, findByKey, geo, geoip, geoOperator, getAttachement, getCode, getHostIp, getHostName, getResource, getResourceString, getResourceTuple, getUniqueMessageId, grok, http, ipmatch, ipmatch, ipRange, ipv4Range, ipv4Range, ipv6Range, ipv6Range, is, kv, logger, mail, meter, move, nifi, print, print, raise, remove, sha1, sleep, split, syslogHeader, toArray, toBoolean, toDouble, toFlatTuple, toKv, toLong, toLowerCase, toUpperCase, tryEpochMs, tryEpochMs, tryEpochSec, tryEpochSec, tuple, tuple, unflatTuple, validateSchema

Methods inherited from class org.thales.punch.libraries.punchlang.impl.PunchletContext

ecount, every, execute, getPath, getPersistentId, getProperties, getRuntimeId, getWorldTuple, invoke, setCode, setPath, setPersistentId, setProperties, setRuntimeId

Methods inherited from class java.lang.Object

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

Field Detail

punchletList

protected List<Punchlet> punchletList

The list of individual punchlets

Constructor Detail

Punchlets

protected Punchlets(RuntimeContext runtimeContext)

Method Detail

addEventCallback

public Punchlet addEventCallback(PunchletEventCallback callback)

Description copied from class: Punchlet

This method is not meant to be executed from within a punchlet. It is used by the punchlet engines to deal properly with tuples generated by punchlets.

Register a callback to this punchlet. This is used for asynchronous style punchlets that generate events asynchronously, for example a punchlet with a time based siddhi rule. These events are represented as Tuples.

If you run punchlet from a java applicatin using the punchlet library, you must implement this in order to re-invoke yor punchlet with the raised events.

Overrides:

addEventCallback in class Punchlet

Parameters:

callback - the callback to be notified upon fired events

Returns:

this punchlet

isAsynchronous

public boolean isAsynchronous()

Description copied from class: Punchlet

Some punchlets generate asynchronous events. For example the ones relying on siddhi rules. This method lets you check if a punchlet does that. If yes,you must register a PunchletEventCallback to be notified.

Overrides:

isAsynchronous in class Punchlet

Returns:

true if this punchlet will or may generate asynchronous events.

activate

public void activate()

Description copied from class: Punchlet

The activate method is called after startup, and before receiving input tuples. It lets you initialize fields. You are free to implement this method for example to initialize static or regular fields of your punchlet.

Overrides:

activate in class Punchlet

setMetricContext

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

Description copied from class: Punchlet

Associate a metric context with this punchlet.

Overrides:

setMetricContext in class Punchlet

Parameters:

metricsContext - the provided metric context

Returns:

this punchlet.

__isChained

public boolean __isChained()

some punchlet are made of a chain of several punchlets.

Overrides:

__isChained in class Punchlet

Returns:

true is this punchlet is a chained one