org.thales.punch.libraries.storm.bolt.factory

Class PunchBoltFactory

java.lang.Object

org.thales.punch.libraries.storm.bolt.factory.PunchBoltFactory

All Implemented Interfaces:

org.thales.punch.libraries.storm.api.IBoltFactory

public class PunchBoltFactory
extends Object
implements org.thales.punch.libraries.storm.api.IBoltFactory

Punch Node factory class. It build a punch node, loading all the required resources.

Author:

dimi

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The key referencing the associated bolt.

Constructor Summary

Constructors

Constructor and Description
PunchBoltFactory() Default constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.storm.topology.IRichBolt	createBolt(org.thales.punch.platform.api.IPlatform platform, org.thales.punch.libraries.storm.api.NodeSettings config, org.thales.punch.libraries.storm.api.ITopologySettings topoConfig)
static PunchletConfig	getPunchletConfig(org.thales.punch.settings.api.ISettingsMap nodeSettings, org.thales.punch.libraries.storm.api.ITopologySettings topoSettings, String defaultGrokPatterns)
static PunchletConfig	getPunchletConfig(org.thales.punch.settings.api.ISettingsMap nodeSettings, String tenantName, String channelName, org.thales.punch.libraries.storm.api.ITopologySettings topoConfig) Load all the required resource and punchlet files and return a ready to use PunchletConfig.
static PunchletConfig	getPunchletConfig(org.thales.punch.settings.api.ISettingsMap nodeSettings, String tenantName, String channelName, org.thales.punch.libraries.storm.api.ITopologySettings topoSettings, String defaultGrokPatterns, Path defaultResourcePath) This method looks for punchlets in a local configuration directory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.thales.punch.libraries.storm.api.IBoltFactory

getPublishedStreamConfig, getStaticResources

Field Detail

TYPE

public static final String TYPE

The key referencing the associated bolt.

See Also:

Constant Field Values

Constructor Detail

PunchBoltFactory

public PunchBoltFactory()

Default constructor.

Method Detail

createBolt

public org.apache.storm.topology.IRichBolt createBolt(org.thales.punch.platform.api.IPlatform platform,
                                                      org.thales.punch.libraries.storm.api.NodeSettings config,
                                                      org.thales.punch.libraries.storm.api.ITopologySettings topoConfig)

Specified by:

createBolt in interface org.thales.punch.libraries.storm.api.IBoltFactory

getPunchletConfig

public static PunchletConfig getPunchletConfig(org.thales.punch.settings.api.ISettingsMap nodeSettings,
                                               String tenantName,
                                               String channelName,
                                               org.thales.punch.libraries.storm.api.ITopologySettings topoConfig)

Load all the required resource and punchlet files and return a ready to use PunchletConfig.

A dry compilation run is also performed to detect upfront invalid punchlets.

Parameters:

platform - platform

nodeSettings - componentSettings

tenantName - tenantName

channelName - channelName

topoConfig - topoConfig

Returns:

the punchlet configuration

Throws:

org.thales.punch.exceptions.ConfigurationException

IOException

getPunchletConfig

public static PunchletConfig getPunchletConfig(org.thales.punch.settings.api.ISettingsMap nodeSettings,
                                               String tenantName,
                                               String channelName,
                                               org.thales.punch.libraries.storm.api.ITopologySettings topoSettings,
                                               String defaultGrokPatterns,
                                               Path defaultResourcePath)
                                        throws IOException

This method looks for punchlets in a local configuration directory. This will work only on standalone or shiva platforms. Not on Kubernetes.

Parameters:

nodeSettings - the punch node settings

tenantName - the tenant name

channelName - the channel name

topoSettings -

defaultResourcePath - the default location where to look for resources.

Returns:

a punchlet configuration

Throws:

IOException - in case resource or punchlet files could not be loaded.

getPunchletConfig

public static PunchletConfig getPunchletConfig(org.thales.punch.settings.api.ISettingsMap nodeSettings,
                                               org.thales.punch.libraries.storm.api.ITopologySettings topoSettings,
                                               String defaultGrokPatterns)
                                        throws IOException

Throws:

IOException