org.thales.punch.libraries.punchlang.impl

Class PunchletContext

java.lang.Object

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

Direct Known Subclasses:

Punchlet

public class PunchletContext
extends Object

This is the base class to be implemented by punchlets. It provides the API to invoke the punchlet at runtime, and Punch operators acts on one or several tuples.

Field Summary

Fields

Modifier and Type	Field and Description
Tuple	child
protected String	code The original punchlet code
protected long	eventCount
protected com.codahale.metrics.MetricRegistry	metricRegistry The associated codahale metric registry
RuntimeContext	r The punchlet runtime context
protected org.thales.punch.libraries.utils.api.IUUIDGenerator	uuidGenerator Our generator of short yet unique message identifier.
Tuple	world The world tuple allows for generic communications with the external environments

Constructor Summary

Constructors

Constructor and Description
PunchletContext(RuntimeContext r) The runtime context is passed.

Method Summary

Modifier and Type	Method and Description
String	ecount() Return a counter, increased everytime you call it.
boolean	every(long number) For testing performance punchlets it is handy to have something like this.
void	execute(Tuple root) Execute the punchlet.
String	getPath()
String	getPersistentId() Deprecated.
Properties	getProperties() Return the properties associated to this punchlet, i.e.
String	getRuntimeId() Return a runtime identifier.
Tuple	getWorldTuple() Return the world tuple associated to your punchlet
void	invoke(Tuple root) This method only invoke the punchlet execute method and takes care of catching all exception to make them transformed as punch runtime exceptions.
void	setCode(String code) Set the original punchlet code.
void	setPath(String path) Associate a path to this punchlet.
PunchletContext	setPersistentId(String puid) Set this punchlet persistent identifier
PunchletContext	setProperties(Properties properties) A punchlet can have properties associated.
PunchletContext	setRuntimeId(String ruid) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

metricRegistry

protected com.codahale.metrics.MetricRegistry metricRegistry

The associated codahale metric registry

world

public Tuple world

The world tuple allows for generic communications with the external environments

child

public Tuple child

r

public final RuntimeContext r

The punchlet runtime context

eventCount

protected long eventCount

uuidGenerator

protected org.thales.punch.libraries.utils.api.IUUIDGenerator uuidGenerator

Our generator of short yet unique message identifier.

code

protected String code

The original punchlet code

Constructor Detail

PunchletContext

public PunchletContext(RuntimeContext r)

The runtime context is passed. It holds data private to this instance of punchlet.

Watch out, the runtime context can be null for a punchlet instance.

Parameters:

r - the runtime context associated to the punchlet

Method Detail

setPath

public void setPath(String path)

Associate a path to this punchlet. Useful to have error message contain the path of the corresponding punchlet

Parameters:

path - the punchlet path

getPath

public String getPath()

Returns:

the path of the corresponding punchlet.

setCode

public void setCode(String code)

Set the original punchlet code.

Parameters:

code - the punchlet code

ecount

public String ecount()

Return a counter, increased everytime you call it.

The corresponding counter starts at 0, and is associated to your punchlet.

Returns:

a String representation of an increasing counter.

invoke

public void invoke(Tuple root)

This method only invoke the punchlet execute method and takes care of catching all exception to make them transformed as punch runtime exceptions.

Parameters:

root - the input tuple

execute

public void execute(Tuple root)

Execute the punchlet. Every punchlet implement this method. This is usually not visible to punch programmer as they write simple punchlet providing only a block of instructions, i.e

 {
        [es_type] = \"apache\";
 }
 

These simple punchlet are compiled into a running punchlet implementing this class.

Note that a punchlet can be injected with additional json resource tuples, i.e. tuple that hold the content of static json files, containing configuration data. These are automatically injected as fields in your punchlet.

Parameters:

root - the root tuple. This one is mandatory

getPersistentId

@Deprecated
public String getPersistentId()

Deprecated.

Each punchlet receives from its creator a persistent identifier. Persistent means that the same identifier will be given across restart. You can use this persistent identifier should you wish to trace which punchlet transformed your document.

Returns:

the punchlet persistent identifier

getRuntimeId

public String getRuntimeId()

Return a runtime identifier. This identifier changes everytime the punchlet is recreated. You can use it to generate an id tight to the lifetime of your punchlet

Returns:

a runtime identifier

getWorldTuple

public Tuple getWorldTuple()

Return the world tuple associated to your punchlet

Returns:

the world tuple

setPersistentId

public PunchletContext setPersistentId(String puid)

Set this punchlet persistent identifier

Parameters:

puid - the persistent identifier

Returns:

this punchlet context

getProperties

public Properties getProperties()

Return the properties associated to this punchlet, i.e. injected from a property file.

Returns:

the punchlet properties or an empty Properties.

setRuntimeId

@Deprecated
public PunchletContext setRuntimeId(String ruid)

Deprecated.

Set the runtime identifier associated to your punchlet. If you do not call this method the value used is String.valueof(System.nanotime())

Use this with caution. It is most useful for testing purpose.

Parameters:

ruid - a String supposed to be a runtime identifier of your punchlet.

Returns:

this context

setProperties

public PunchletContext setProperties(Properties properties)

A punchlet can have properties associated.

Parameters:

properties - the declared properties

Returns:

the punchlet context

every

public boolean every(long number)

For testing performance punchlets it is handy to have something like this.

Parameters:

number - number

Returns:

true once every number times