org.thales.punch.libraries.punchlang.impl

Class PunchletResources

java.lang.Object

org.thales.punch.libraries.punchlang.impl.PunchletResources

public final class PunchletResources
extends Object

This singleton class holds all the punchlet resources, corresponding to the $PUNCHPLATFORM_CONF_DIR tree configuration layout.

Method Summary

Modifier and Type	Method and Description
static void	addStaticGrokResource(String grok) Registers in a enrichment json tuple.
static void	addStaticSiddhiRule(String name, String value) Registers in a siddhi rule.
static void	addStaticString(Map<String,String> stringResources) Registers in a string resource rule.
static Map<String,String>	getFiles() Punchlets can have associated files as resources.
static String	getGroks() Return the groks associated to this punchlet.
static Properties	getProperties()
static List<Map.Entry<String,String>>	getRulesByShortNames()
static List<Map.Entry<String,String>>	getStringsByName()
static List<Map.Entry<String,Tuple>>	getTuplesByShortNames(Map<String,Tuple> jsonResources) Simple conversion
static void	reset() Test method, lets you flush the static per jvm resources.

Methods inherited from class java.lang.Object

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

Method Detail

addStaticSiddhiRule

public static void addStaticSiddhiRule(String name,
                                       String value)

Registers in a siddhi rule.

Watch out the '.rule' extension, if present, is removed from the name

Parameters:

name - the tuple key

value - the tuple value

addStaticString

public static void addStaticString(Map<String,String> stringResources)

Registers in a string resource rule. Each resource is identified by a path. It can be "file.json" or "resource/standard/file.json" or "//tmp/file.json". From a punchlet, each resource can be resolved using that path or using only the last part (i.e. "file.json").

Parameters:

stringResources - resources to add

addStaticGrokResource

public static void addStaticGrokResource(String grok)

Registers in a enrichment json tuple.

Parameters:

grok - one or several grok pattern, "\n" separated.

getGroks

public static String getGroks()

Return the groks associated to this punchlet.

Returns:

"" if not grok pattern was found

getRulesByShortNames

public static List<Map.Entry<String,String>> getRulesByShortNames()

Returns:

rules as a list of entries.

getStringsByName

public static List<Map.Entry<String,String>> getStringsByName()

Returns:

strings as a list of entries.

getTuplesByShortNames

public static List<Map.Entry<String,Tuple>> getTuplesByShortNames(Map<String,Tuple> jsonResources)

Simple conversion

Parameters:

jsonResources - the json resources to add

Returns:

json resource tuples as a list of entries.

getFiles

public static Map<String,String> getFiles()

Punchlets can have associated files as resources.

Returns:

a map containing the punchlet file resources

getProperties

public static Properties getProperties()

Returns:

the properties associated to the punchlets

reset

public static void reset()

Test method, lets you flush the static per jvm resources.