Punchlet (Punch Punch Language Runtime Library 6.4.4 API)

java.lang.Object
- org.thales.punch.libraries.punchlang.impl.PunchletContext
- - org.thales.punch.libraries.punchlang.api.Punchlet

Direct Known Subclasses:

Punchlets, TestPunchlet
```
public class Punchlet
extends PunchletContext
```
A punchlet is a punch program executed in a punchlet container. To write a punchlet, you can use either the compact syntax, or write a full-blown punchlet with more capabilities. The compact form is a simple block of statements, like this :
```
 
 {
        [es_type] = \"apache\";
 }
 
 
```
That simple punchlet will be executed for each receiving json document, passed as the (so-called) root tuple. What it does is simply to add an 'es_type' property with value "apache" to that root document. Compact punchlets are fine for simple stateless punchlets, only acting on the document content. Say for example you want a punchlet that counts the number of documents it receives, and every 1000 documents, insert a property in the traversed document.
```
 
 public class MyPunchlet extends Punchlet {
        long count = 0L;
        public void execute(Tuple root) {
                count ++;
                if ((count % 1000) == 0) {
                        [root][counter] = count;
        }
    }
 
 
```
Check out the examples, you can do many things like sending alerts, compute statistics, generate new documents, and more.
Punchlets can also be injected with resources : plain files, json or properties files. Json files are provided to your punchlets directly as tuples. For example say you have a file called locations.json containing
```
 
 [
    {"location": {"code": "FR", "name": "France"}, "interval": ["10.0.0.0", "10.0.0.30"]},
    {"location": {"code": "PT", "name": "Portugal"}}, "interval": ["10.0.0.31", "10.0.0.60"]}
 ]
 
 
```
If you put that file in the (adequate) resource directory, you can refer to it in your punchlet directly as a tuple. The next example uses that tuple to perform a lookup by interval using the findByInterval(Tuple) operator.
```
 
 {
    Tuple tuple;
    findByInterval(locations).on("10.0.0.3").into(tuple);
    // tuple contains {"location": {"code": "FR", "name": "France"}, "interval": ["10.0.0.0", "10.0.0.30"]}
 }
 
 
```
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.
can be expressed using a compact syntax
Punch provide operators for performing various complex tuple transformations. Operators are invoked from punchlets using a short notation. For example the key-value operator is invoked like this.
```
 String log = "name=\"bob\" age=23";
 Tuple tuple;
 kv().on(log).into(tuple);
 
```
the result of running this gives you the Tuple 'tuple' holding
```
 {"age":23,"name":"bob"}
 
```
In this page you will find the invocation method for all Punch operators. Refer to the documentation of each operator for further options.

Field Summary

Fields
Modifier and Type Field and Description

static ThreadLocal<Punchlet> _threadLocal
this thread local stores the punchlet itself

static org.apache.logging.log4j.Logger LOG
- Fields inherited from class org.thales.punch.libraries.punchlang.impl.PunchletContext
  child, code, eventCount, metricRegistry, r, uuidGenerator, world

Fields
Modifier and Type	Field and Description
`static ThreadLocal<Punchlet>`	`_threadLocal` this thread local stores the punchlet itself
`static org.apache.logging.log4j.Logger`	`LOG`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Punchlet(RuntimeContext runtimeContext)
Ctor

Constructors
Modifier	Constructor and Description
`protected`	`Punchlet(RuntimeContext runtimeContext)` Ctor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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.
`void`	`attach(String key, Object value)` Attach a resource to this punchlet for later reuse.
`BugOperator`	`bug()`
`static CefOperator`	`cef()`
`CidrRangeOperator`	`cidrRange()`
`CidrRangeOperator`	`cidrRange(String url)` Deprecated.
`Object`	`coalesce(Object... args)` Return the first non empty object in a list.
`ContainsOperator`	`contains(String resourceName, String... keys)` Return a `ContainsOperator` operator.
`ContainsOperator`	`contains(Tuple map, String... keys)` Return a `ContainsOperator` operator.
`static ConvertorOperator`	`convert(String input)` Return a convertor operator, transforming XML or JSON strings into tuples.
`static ConvertorOperator`	`convert(Tuple input)` Return a convertor operator, transforming XML or JSON strings into tuples.
`static CsvOperator`	`csv(String... fields)`
`static long`	`currentTimeMillis()`
`static long`	`currentTimeNanos()`
`static DateOperator`	`date()`
`static DateOperator`	`date(String dstDateFormat)` Return a date operator with a destination time format.
`static DateOperator`	`date(String dstDateFormat, String srcDateFormat)` Return a date operator with a destination and source time format.
`static DissectOperator`	`dissect(String pattern)` Return a `DissectOperator` for a given pattern.
`static void`	`dump(Tuple t)` Dump to stdout a plain String representation of a tuple.
`FetchCsvOperator`	`fetchCsv()` Return a fetchCsv operator.
`FetchCsvOperator`	`fetchCsv(String url)` Return a fetchCsv operator.
`FetchJsonOperator`	`fetchJson()` Return a fetchJson operator.
`FetchJsonOperator`	`fetchJson(String url)` Deprecated.
`FindByIntervalOperator`	`findByInterval(Tuple map)` Return a FindByIntervalOperator, acting on the passed json map.
`static FindByIntervalOperator`	`findByInterval(Tuple map, String key)` Return a FindByIntervalOperator, acting on the passed json map.
`static FindByIntervalOperator`	`findByInterval(Tuple map, String min, String max)` Return a `FindByIntervalOperator` operator with min and max property interval boundaries.
`FindByKeyOperator`	`findByKey(String resourceName, String... keys)` Return a `FindByKeyOperator` operator.
`FindByKeyOperator`	`findByKey(Tuple map, String... keys)` Return a `FindByKeyOperator` operator.
`GeoOperator`	`geo()` Return a ready to use geo operator.
`static GeoIpOperator`	`geoip()`
`static GeoOperator`	`geoOperator()` Get GeoOperator to make geoOperation
`Object`	`getAttachement(String key)`
`String`	`getCode()` Return the original punchlet code.
`static String`	`getHostIp()`
`static String`	`getHostName()`
`ResourceOperator`	`getResource(String resourceName)`
`String`	`getResourceString(String name)` Return a resource string value.
`Tuple`	`getResourceTuple(String name)` Return a resource json tuple.
`String`	`getUniqueMessageId()` Return a unique id ready to be used as an ElasticSearch (or any other database) unique key.
`static GrokOperator`	`grok(String pattern)` Return a grok operator for the corresponding grok pattern
`HttpOperator`	`http(String url)` Returns an http operator.
`IpMatchOperator`	`ipmatch(String path)` This variant takes in the name of your resource tuple.
`IpMatchOperator`	`ipmatch(Tuple resource)` the ipmatch method lets you check if an IP address is contained in a list.
`IpRangeOperator`	`ipRange()` Use this method to get an IPV4 or IPV6 range operator.
`IpRangeOperator`	`ipv4Range()` Deprecated.
`IpRangeOperator`	`ipv4Range(String url)` Deprecated.
`IpRangeOperator`	`ipv6Range()` Deprecated.
`IpRangeOperator`	`ipv6Range(String url)` Deprecated.
`static IsOperator`	`is(Object o)` Called directly by the dsl at runtime.
`boolean`	`isAsynchronous()` Some punchlets generate asynchronous events.
`static KvOperator`	`kv()`
`org.apache.logging.log4j.Logger`	`logger()` You can log message using standard java logging.
`static MailOperator`	`mail()` Get a mail operator to parse mail headers and content.
`com.codahale.metrics.Meter`	`meter(String name)` Return a new com.codahale.metrics.Meter, registered to metrics registry (if any) using the passed name.
`static MoveOperator`	`move(Tuple tuple)` Get a move operator to move a tuple from one place to another.
`NifiOperator`	`nifi()` Get a new nifi operator.
`static void`	`print(String s)` print a string to standard output.
`static void`	`print(Tuple... tuples)` Pretty print a tuple.
`static void`	`raise(String message)` Raise a punch exception.
`static void`	`remove(Tuple tuple)` Remove a tuple.
`Punchlet`	`setMetricContext(org.thales.punch.libraries.metrics.api.IMetricContext metricsContext)` Associate a metric context with this punchlet.
`String`	`sha1(Object... values)` Return a SHA1 hash on the given arguments.
`static void`	`sleep(long ms)` Sleep for some milliseconds
`static SplitOperator`	`split()`
`static SyslogHeaderOperator`	`syslogHeader()`
`Object[]`	`toArray(Object... args)` Return an array of arbitrary object.
`static boolean`	`toBoolean(Tuple tuple)` The toDouble operator returns a long value contained in a tuple.
`static double`	`toDouble(Tuple tuple)` The toDouble operator returns a double value contained in a tuple.
`static ToFlatTupleOperator`	`toFlatTuple()`
`static ToKvOperator`	`toKv()`
`static long`	`toLong(Tuple tuple)` The toDouble operator returns a long value contained in a tuple.
`static void`	`toLowerCase(Tuple... tuples)` Change tuple(s) content to lower case
`static void`	`toUpperCase(Tuple... tuples)` Change tuple(s) content to upper case.
`Long`	`tryEpochMs(Tuple t)` Convert a date to an epoch timestamp in seconds.
`Long`	`tryEpochMs(Tuple t, long defaultValue)` Convert a date to an epoch timestamp in seconds.
`Long`	`tryEpochSec(Tuple t)` Convert a date to an epoch timestamp in millisecond.
`Long`	`tryEpochSec(Tuple t, long defaultValue)` Convert a date to an epoch timestamp in millisecond.
`static Tuple`	`tuple()` Return a new tuple
`static Tuple`	`tuple(Object... elements)` Construct a new tuple.
`static UnflatTupleOperator`	`unflatTuple()` Unflat a tuple.
`ValidateSchemaOperator`	`validateSchema(String... schemas)`

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
  - LOG
```
public static final org.apache.logging.log4j.Logger LOG
```
  - _threadLocal
```
public static final ThreadLocal<Punchlet> _threadLocal
```
    this thread local stores the punchlet itself
- Constructor Detail
  - Punchlet
```
protected Punchlet(RuntimeContext runtimeContext)
```
    Ctor
    
    Parameters:
    
    runtimeContext - the associated runtime context
- Method Detail
  - cef
```
public static CefOperator cef()
```
    Returns:
    
    a CefOperator operator.
  - convert
```
public static ConvertorOperator convert(String input)
```
    Return a convertor operator, transforming XML or JSON strings into tuples.
    
    Parameters:
    
    input - the input string
    
    Returns:
    
    a ConvertorOperator
  - tryEpochSec
```
public Long tryEpochSec(Tuple t)
```
    Convert a date to an epoch timestamp in millisecond.
    
    Parameters:
    
    t - the input tuple
    
    Returns:
    
    null if conversion is not possible
  - tryEpochMs
```
public Long tryEpochMs(Tuple t)
```
    Convert a date to an epoch timestamp in seconds.
    
    Parameters:
    
    t - the input tuple
    
    Returns:
    
    null if conversion is not possible
  - tryEpochSec
```
public Long tryEpochSec(Tuple t,
                        long defaultValue)
```
    Convert a date to an epoch timestamp in millisecond.
    
    Parameters:
    
    t - the input tuple
    
    defaultValue - the default value
    
    Returns:
    
    null if conversion is not possible
  - tryEpochMs
```
public Long tryEpochMs(Tuple t,
                       long defaultValue)
```
    Convert a date to an epoch timestamp in seconds.
    
    Parameters:
    
    t - the input tuple
    
    defaultValue - the default value
    
    Returns:
    
    null if conversion is not possible
  - convert
```
public static ConvertorOperator convert(Tuple input)
```
    Return a convertor operator, transforming XML or JSON strings into tuples.
    
    Parameters:
    
    input - the input tuple, expected to hold a string leaf
    
    Returns:
    
    a ConvertorOperator
  - csv
```
public static CsvOperator csv(String... fields)
```
    Parameters:
    
    fields - the field name to name extracted values
    
    Returns:
    
    a CsvOperator operator.
  - date
```
public static DateOperator date()
```
    Returns:
    
    a date operator without any source or destination date format
  - date
```
public static DateOperator date(String dstDateFormat)
```
    Return a date operator with a destination time format. I.e. the operator will apply the passed date format to generate new dates.
    
    Parameters:
    
    dstDateFormat - a standard time format
    
    Returns:
    
    a date operator
  - date
```
public static DateOperator date(String dstDateFormat,
                                String srcDateFormat)
```
    Return a date operator with a destination and source time format. I.e. the operator will apply the passed date formats to parse input dates and to generate or transform new dates.
    
    Parameters:
    
    dstDateFormat - a standard time format
    
    srcDateFormat - a standard time format
    
    Returns:
    
    a date operator
  - currentTimeMillis
```
public static long currentTimeMillis()
```
    Returns:
    
    the local time in milliseconds
  - currentTimeNanos
```
public static long currentTimeNanos()
```
    Returns:
    
    the local time in nanoseconds
  - dissect
```
public static DissectOperator dissect(String pattern)
```
    Return a DissectOperator for a given pattern.
    
    Parameters:
    
    pattern - your dissect pattern
    
    Returns:
    
    a new dissect operator
  - dump
```
public static void dump(Tuple t)
```
    Dump to stdout a plain String representation of a tuple. In contrast to the print method this does not convert the tuple to a Json representation.
    
    Parameters:
    
    t - the tuple to dump
  - findByInterval
```
public static FindByIntervalOperator findByInterval(Tuple map,
                                                    String key)
```
    Return a FindByIntervalOperator, acting on the passed json map.
    The passed tuple must contain an array of elements each containing an interval with min and max (long) value. From there the findByInterval operator builds an efficient data structure to perform lookups for all elements whose interval encloses a given value.
    
    Parameters:
    
    map - the source json interval tree.
    
    key - the key indicating the interval in there
    
    Returns:
    
    a FindByIntervalOperator operator.
  - findByInterval
```
public static FindByIntervalOperator findByInterval(Tuple map,
                                                    String min,
                                                    String max)
```
    Return a FindByIntervalOperator operator with min and max property interval boundaries.
    
    Parameters:
    
    map - the input map
    
    min - low range
    
    max - high range
    
    Returns:
    
    a ready to use operator.
  - geoip
```
public static GeoIpOperator geoip()
```
    Returns:
    
    a new GeoIpOperator
  - getHostIp
```
public static String getHostIp()
```
    Returns:
    
    the local host IP address string in textual presentation.
  - getHostName
```
public static String getHostName()
```
    Returns:
    
    the local host name.
  - grok
```
public static GrokOperator grok(String pattern)
```
    Return a grok operator for the corresponding grok pattern
    
    Parameters:
    
    pattern - a valid grok expression
    
    Returns:
    
    a grok operator
  - is
```
public static IsOperator is(Object o)
```
    Called directly by the dsl at runtime.
    
    Parameters:
    
    o - the object to check for containment
    
    Returns:
    
    the operator
  - kv
```
public static KvOperator kv()
```
    Returns:
    
    a key value operator
  - move
```
public static MoveOperator move(Tuple tuple)
```
    Get a move operator to move a tuple from one place to another.
    
    Parameters:
    
    tuple - the tuple to move
    
    Returns:
    
    the operator
  - mail
```
public static MailOperator mail()
```
    Get a mail operator to parse mail headers and content.
    
    Returns:
    
    the mail operator
  - geoOperator
```
public static GeoOperator geoOperator()
```
    Get GeoOperator to make geoOperation
    
    Returns:
    
    the GeoOperator
  - print
```
public static void print(String s)
```
    print a string to standard output.
    
    Parameters:
    
    s - the string
  - print
```
public static void print(Tuple... tuples)
```
    Pretty print a tuple. Note that this method return a Json representation of a tuple. In particular inner String (key or values) will be escaped.
    
    Parameters:
    
    tuples - the tuple to print
  - raise
```
public static void raise(String message)
```
    Raise a punch exception. Use this to interrupt your punchlet, should you encounter some unexpected conditions. Typically you receive data not at the expected format.
    
    Parameters:
    
    message - a message associated the resulting exception
  - remove
```
public static 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
  - sleep
```
public static void sleep(long ms)
```
    Sleep for some milliseconds
    
    Parameters:
    
    ms - the delay in milliseconds
  - split
```
public static SplitOperator split()
```
    Returns:
    
    a split operator.
  - syslogHeader
```
public static SyslogHeaderOperator syslogHeader()
```
    Returns:
    
    a new SyslogHeaderOperator.
  - toBoolean
```
public static boolean toBoolean(Tuple tuple)
```
    The toDouble operator returns a long value contained in a tuple. In contrast to Tuple.asDouble() method, a tuple with a string representation of a double is accepted.
    
    Parameters:
    
    tuple - the input tuple, expected to contain a boolean value, "true" or "false"
    
    Returns:
    
    the boolean value
    
    Throws:
    
    PunchRuntimeException - if the tupel contain other types of value
  - toDouble
```
public static double toDouble(Tuple tuple)
```
    The toDouble operator returns a double value contained in a tuple. In contrast to Tuple.asDouble() method, a tuple with a string representation of a double is accepted.
    
    Parameters:
    
    tuple - the input tuple, expected to contain a double value or a valid double String representation.
    
    Returns:
    
    the double value
    
    Throws:
    
    PunchRuntimeException - if the tupel contain other types of value
  - toFlatTuple
```
public static ToFlatTupleOperator toFlatTuple()
```
    Returns:
    
    a ToFlatTupleOperator
  - toKv
```
public static ToKvOperator toKv()
```
    Returns:
    
    a ToKvOperator
  - toLong
```
public static long toLong(Tuple tuple)
```
    The toDouble operator returns a long value contained in a tuple. In contrast to the Tuple.asLong() method, a tuple with a string representation of a double is accepted.
    
    Parameters:
    
    tuple - the input tuple, expected to contain a long value or a valid long String representation.
    
    Returns:
    
    the double value
    
    Throws:
    
    PunchRuntimeException - if the tupel contain other types of value
  - toLowerCase
```
public static void toLowerCase(Tuple... tuples)
```
    Change tuple(s) content to lower case
    
    Parameters:
    
    tuples - one or several tuples
  - toUpperCase
```
public static void toUpperCase(Tuple... tuples)
```
    Change tuple(s) content to upper case. This works with String tuples, or with tuples containing array of String.
    
    Parameters:
    
    tuples - one or several tuples
  - tuple
```
public static Tuple tuple()
```
    Return a new tuple
    
    Returns:
    
    a new empty tuple
  - tuple
```
public static Tuple tuple(Object... elements)
```
    Construct a new tuple. Note that this method automatically converts json string to parsed tuples.
    Here are examples
    
    Parameters:
    
    elements - the element(s) to be transformed. If you have more than one an array tuple will be constructed
    
    Returns:
    
    Tuple
  - unflatTuple
```
public static UnflatTupleOperator unflatTuple()
```
    Unflat a tuple.
    
    Returns:
    
    a ToTupleOperator
  - __isChained
```
public boolean __isChained()
```
    some punchlet are made of a chain of several punchlets.
    
    Returns:
    
    true is this punchlet is a chained one
  - activate
```
public void activate()
```
    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.
  - addEventCallback
```
public Punchlet addEventCallback(PunchletEventCallback callback)
```
    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.
    
    Parameters:
    
    callback - the callback to be notified upon fired events
    
    Returns:
    
    this punchlet
  - attach
```
public void attach(String key,
                   Object value)
```
    Attach a resource to this punchlet for later reuse.
    
    Parameters:
    
    key - the resource key
    
    value - the corresponding value
  - bug
```
public BugOperator bug()
```
    Returns:
    
    a new bug operator
  - coalesce
```
public Object coalesce(Object... args)
```
    Return the first non empty object in a list.
    A tuple will be returned only if it is not empty
    
    Parameters:
    
    args - the input array of tuples or objects
    
    Returns:
    
    the first non null or non empty object, or null
  - contains
```
public ContainsOperator contains(String resourceName,
                                 String... keys)
```
    Return a ContainsOperator operator.
    This variant takes the name of a json resource. The contains operator will throw a PunchRuntimeException if no tuple is defined for the resource name
    
    Parameters:
    
    resourceName - the name of the json resource
    
    keys - the keys to look for.
    
    Returns:
    
    the requested operator
  - contains
```
public ContainsOperator contains(Tuple map,
                                 String... keys)
```
    Return a ContainsOperator operator.
    Note that the ContainsOperator operator does not require precompilation. It uses a JIT strategy so that repeated calls with the same key will result in efficient lookup.
    
    Parameters:
    
    map - input map
    
    keys - the key to look for
    
    Returns:
    
    the requested operator
  - findByInterval
```
public FindByIntervalOperator findByInterval(Tuple map)
```
    Return a FindByIntervalOperator, acting on the passed json map.
    The passed tuple must contain an array of elements each containing an interval with min and max (long) value. From there the findByInterval operator builds an efficient data structure to perform lookups for all elements whose interval encloses a given value.
    
    Parameters:
    
    map - the source json interval tree.
    
    Returns:
    
    a FindByIntervalOperator operator.
  - findByKey
```
public FindByKeyOperator findByKey(String resourceName,
                                   String... keys)
```
    Return a FindByKeyOperator operator.
    This variant takes the name of a json resource. The findByKey operator will throw a PunchRuntimeException if no tuple is defined for the resource name
    
    Parameters:
    
    resourceName - the name of the json resource
    
    keys - the keys to look for.
    
    Returns:
    
    the requested operator
  - findByKey
```
public FindByKeyOperator findByKey(Tuple map,
                                   String... keys)
```
    Return a FindByKeyOperator operator.
    Note that the FindByKeyOperator operator does not require precompilation. It uses a JIT strategy so that repeated calls with the same key will result in efficient lookup.
    
    Parameters:
    
    map - input map
    
    keys - the key to look for
    
    Returns:
    
    the requested operator
  - getAttachement
```
public Object getAttachement(String key)
```
    Parameters:
    
    key - the key of a previously attached resource
    
    Returns:
    
    the corresponding ressource or null if not found
  - getCode
```
public String getCode()
```
    Return the original punchlet code.
    
    Returns:
    
    the punchlet code
  - getResourceTuple
```
public Tuple getResourceTuple(String name)
```
    Return a resource json tuple. A resource tuple corresponds to an input resource file associated to your punchlet by configuration. Beware: if the corresponding resource is not found, this method throws an exception.
    Resource files must be associated to your punchlet with a path relative to the "$PUNCHPLATFORM_CONF_DIR/resources/punch/" directory.
    The name of the resource is the resource file name without the file extension. For example, if you have in your topology :
```
   
          "bolt_settings" : {
            "punchlet_json_resources" : [
                "some/location/your_resource.json"
             ],
             "punchlet" : "some/location/your_punchlet.punch"
          },
   
 
```
    Then in your punchlet you should use :
```
   
           Tuple t = getResourceTuple("your_resource");
    
 
```
    Parameters:
    
    name - the tuple name
    
    Returns:
    
    the requested tuple or null if none found for that name
    
    Throws:
    
    PunchRuntimeException - if the json resource is not found in your context
  - getResourceString
```
public String getResourceString(String name)
```
    Return a resource string value. A resource string corresponds to an input resource file associated to your punchlet by configuration. Beware: if the corresponding string is not found, this method throws an exception.
    Resource files must be associated to your punchlet with a path relative to the "$PUNCHPLATFORM_CONF_DIR/resources/punch/" directory.
    The name of the resource is the resource file name with the file extension if any. For example, if you have in your topology :
```
   
          "bolt_settings" : {
            "punchlet_file_resources" : [
                "some/location/your_resource.json"
             ],
             "punchlet" : "some/location/your_punchlet.punch"
          },
   
 
```
    Then in your punchlet you should use :
```
   
           String s = getResourceString("your_resource.json");
    
 
```
    Parameters:
    
    name - the resource original file name
    
    Returns:
    
    the requested string
    
    Throws:
    
    PunchRuntimeException - if the string resource is not found in your context
  - fetchCsv
```
public FetchCsvOperator fetchCsv(String url)
```
    Return a fetchCsv operator. Refer to FetchCsvOperator.
    
    Parameters:
    
    url - the remote resource file URL.
    
    Returns:
    
    a fetch operator
  - fetchCsv
```
public FetchCsvOperator fetchCsv()
```
    Return a fetchCsv operator. Refer to FetchCsvOperator.
    
    Returns:
    
    a fetch operator
  - cidrRange
```
@Deprecated
public CidrRangeOperator cidrRange(String url)
```
    Deprecated.
    
    Return a cidrRange operator. Refer to CidrRangeOperator documentation.
    Prefer the {cidrRange() variant.
    
    Parameters:
    
    url - the remote or local resource file url.
    
    Returns:
    
    a CidrRangeOperator
  - cidrRange
```
public CidrRangeOperator cidrRange()
```
  - ipv4Range
```
@Deprecated
public IpRangeOperator ipv4Range()
```
    Deprecated.
    
    Return an IPV4 range tree operator, pre-loaded with the punch provided geoip database. Refer to IpRangeOperator documentation.
    
    Parameters:
    
    url - the remote or local resource file url.
    
    Returns:
    
    a IpRangeOperator .
  - ipv6Range
```
@Deprecated
public IpRangeOperator ipv6Range()
```
    Deprecated.
    
    Return an IPV6 range tree operator, pre-loaded with the punch provided geoip database. Refer to IpRangeOperator documentation.
    
    Parameters:
    
    url - the remote or local resource file url.
    
    Returns:
    
    a IpRangeOperator .
  - ipv4Range
```
@Deprecated
public IpRangeOperator ipv4Range(String url)
```
    Deprecated.
    
    Return an IPV4 range tree operator. Refer to IpRangeOperator documentation.
    This variant requires you provide on your platform the ipv4 csv file.
    
    Parameters:
    
    url - the remote or local resource file url.
    
    Returns:
    
    a IpRangeOperator .
  - ipv6Range
```
@Deprecated
public IpRangeOperator ipv6Range(String url)
```
    Deprecated.
    
    Return an IPV6 range tree operator. Refer to IpRangeOperator documentation.
    @Deprecated prefer using the ipRange() method.
    
    Parameters:
    
    url - the remote or local resource file url.
    
    Returns:
    
    an IPV6 IpRangeOperator.
  - ipRange
```
public IpRangeOperator ipRange()
```
    Use this method to get an IPV4 or IPV6 range operator. Check the IpRangeOperator documentation.
    
    Returns:
    
    an IP range operator.
  - fetchJson
```
@Deprecated
public FetchJsonOperator fetchJson(String url)
```
    Deprecated.
    
    Return a fetchJson operator. Refer to FetchCsvOperator documentation.
    This method is deprecated prefer the {fetchJson() variant.
    
    Parameters:
    
    url - the remote resource file URL.
    
    Returns:
    
    a fetch operator
  - fetchJson
```
public FetchJsonOperator fetchJson()
```
    Return a fetchJson operator. Refer to FetchCsvOperator documentation.
    
    Returns:
    
    a fetch operator
  - http
```
public HttpOperator http(String url)
```
    Returns an http operator. Refer to HttpOperator documentation.
    
    Parameters:
    
    url - - the remote url
    
    Returns:
    
    an http operator
  - getUniqueMessageId
```
public String getUniqueMessageId()
```
    Return a unique id ready to be used as an ElasticSearch (or any other database) unique key.
    The returned identifier is both unique and compact.
    
    Returns:
    
    the unique id
  - ipmatch
```
public IpMatchOperator ipmatch(String path)
```
    This variant takes in the name of your resource tuple.
    
    Parameters:
    
    path - the resource tuple.
    
    Returns:
    
    a new IpMatchOperator
  - ipmatch
```
public IpMatchOperator ipmatch(Tuple resource)
```
    the ipmatch method lets you check if an IP address is contained in a list. You must provide the list as a resource tuple containing either exact dotted notation IP addresses, or CIDR notations. Refer to the IpMatchOperator documentation for examples.
    
    Parameters:
    
    resource - the resource tuple.
    
    Returns:
    
    a new IpMatchOperator
  - isAsynchronous
```
public boolean isAsynchronous()
```
    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.
    
    Returns:
    
    true if this punchlet will or may generate asynchronous events.
  - logger
```
public org.apache.logging.log4j.Logger logger()
```
    You can log message using standard java logging.
```
 
 if (logger().isInfoEnabled()) {
   logger().info("an info message {}", [message].size());
 }
 
 
```
    Returns:
    
    a logger.
  - meter
```
public com.codahale.metrics.Meter meter(String name)
```
    Return a new com.codahale.metrics.Meter, registered to metrics registry (if any) using the passed name.
    
    Parameters:
    
    name - the name of the meter
    
    Returns:
    
    the new meter
  - sha1
```
public String sha1(Object... values)
```
    Return a SHA1 hash on the given arguments. Accepted arguments are of type String or Tuple.
    
    Parameters:
    
    values - the values to concatenate and hash.
    
    Returns:
    
    a sha1 String
  - nifi
```
public NifiOperator nifi()
```
    Get a new nifi operator. A typical usage is illustrated next.
```
 nifi().addOutputRoutes("success").into(root)
 
```
    Returns:
    
    a new NifiOperator.
  - toArray
```
public Object[] toArray(Object... args)
```
    Return an array of arbitrary object. This is handy to write something like
```
 
 [array] = toArray(1,2,3);
 
 
```
    Parameters:
    
    args - the objects to be returned as an array
    
    Returns:
    
    the corresponding array of object
  - geo
```
public GeoOperator geo()
```
    Return a ready to use geo operator. In turn you can the access all the geo functions like distance etc..
    
    Returns:
    
    a geo operator
  - setMetricContext
```
public Punchlet setMetricContext(org.thales.punch.libraries.metrics.api.IMetricContext metricsContext)
```
    Associate a metric context with this punchlet.
    
    Parameters:
    
    metricsContext - the provided metric context
    
    Returns:
    
    this punchlet.
  - validateSchema
```
public ValidateSchemaOperator validateSchema(String... schemas)
```
    Returns:
    
    a validate operator.
  - getResource
```
public ResourceOperator getResource(String resourceName)
```
    Returns:
    
    a validate operator.

Class Punchlet

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

LOG

_threadLocal

Constructor Detail

Punchlet

Method Detail

cef

convert

tryEpochSec

tryEpochMs

tryEpochSec

tryEpochMs

convert

csv

date

date

date

currentTimeMillis

currentTimeNanos

dissect

dump

findByInterval

findByInterval

geoip

getHostIp

getHostName

grok

is

kv

move

mail

geoOperator

print

print

raise

remove

sleep

split

syslogHeader

toBoolean

toDouble

toFlatTuple

toKv

toLong

toLowerCase

toUpperCase

tuple

tuple

unflatTuple

__isChained

activate

addEventCallback

attach

bug

coalesce

contains

contains

findByInterval

findByKey

findByKey

getAttachement

getCode

getResourceTuple

getResourceString

fetchCsv

fetchCsv

cidrRange

cidrRange

ipv4Range

ipv6Range

ipv4Range

ipv6Range

ipRange