Package org.thales.punch.libraries.punchlang.api

Punch package documentation.

See: Description

Interface Summary

Interface	Description
IResourceBuilder	Utility interface to build useful in memory structures from remote resource files.
IRuntimeContext	Interface used by operators to register and retrieve runtime context data.
PunchletEventCallback	Some punchlets (i.e.
RotatingMap.ExpiredCallback<K,V>
Tuple	Tuples provide punchlet with a new basic type that makes working with a json document extra easy.

Class Summary

Class	Description
AbstractRemoteResourceHandlerBuilder<T>	So called remote handlers are in charge of loading, once or periodically, remote resource files and transform them in tuples.
Entry	Entries used when iterating over sets or maps of tuples.
IpList	This class embeds an interval tree, and provides a ready to use black or white list service.
PunchBloomFilter<T>	A light wrap up of the orestes bloom filter.
Punchlet	A punchlet is a punch program executed in a punchlet container.
PunchletBlockDeclarator	A block of punchlets represent a sequence of one or several punchlets, that you request to execute in one or several dedicated thread, and with an optional affinity string if it needs to receive input data from the previous block with some affinity.
PunchletDag	A punchlet dag is a lightweight topology like engine that runs a directed graph of several layers of punchlets, each in its own thread.
Punchlets	Most often several punchlets are grouped as one executable unit.
PunchletSequence	The PunchletSequence class chains several punchlets.
PunchletSequenceDeclarator	A PunchletSequenceDeclarator is used to represent a sequence of punchlet, to be executed in the same thread, one after the other.
RemoteResourceHandlerBuilder	Use this builder to create a local, remote file or HTTP(S) resource handler.
RotatingMap<K,V>	Expires keys that have not been updated in the configured number of seconds.
S3ResourceHandlerBuilder	Use this builder to create a S3 remote resource handler.
TupleAvroEncoder
TupleBuilder	New builder-style class to create tuples.
TupleFactory	Use this class to create and convert punch tuples.

Enum Summary

Enum	Description
IResourceBuilder.CompactionType	very large resource files are common.

Exception Summary

Exception	Description
PunchRuntimeException	A PunchRuntimeException is raised whenever a punchlet encounters an error.
PunchTupleFailureException	A PunchTupleFailureException is raised for test purposes, when a specially designed (usually stateful) punchlet wants to cause a failure of some tuple (but probably not all, and not occurrences, or the input flow will never be fully processed, but this could be the test case...

Package org.thales.punch.libraries.punchlang.api Description

Punch package documentation.

Punch is a java based language to code and run Json document processing using an easy and natural syntax. Refer to your PunchPlatform punch programming user guide for an easy tutorial.

In addition, check out these samples for a quick look:

• tuple.punch for basic tuple and control flow usage.
• collection.punch for arrays and sets
• tuple.punch for understanding find by key and interval operators.

You can run them from their source directory using the punchplatform-puncher.sh tool. A punchlet is a punch program that can be further deployed and run inside a Storm topology. To write a punchlet, refer to the following documentation

• The Tuple interface lists all the operations supported by the new Tuple type.
• The Punchlet class lists the short notation to use punch operators, as well as the lifecycle related punchlet methods.

To execute a punchlet, try the punchplatform-puncher.sh tool. It has a manual page installed (if, of course, you installed punchplatform). Have fun !