Package org.apache.plc4x.java.scraper.triggeredscraper.triggerhandler

Class TriggerConfiguration

java.lang.Object

org.apache.plc4x.java.scraper.triggeredscraper.triggerhandler.TriggerConfiguration

public class TriggerConfiguration
extends Object

basic configuration for all available triggers and handling of regarding condition

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TriggerConfiguration.Comparator
static class	TriggerConfiguration.ConcatType
static class	TriggerConfiguration.TriggerElement
static class	TriggerConfiguration.TriggerType

Constructor Summary

Constructors

Constructor	Description
TriggerConfiguration(TriggerConfiguration.TriggerType triggerType, String scrapeInterval)	default constructor when scheduled trigger shall be performed
TriggerConfiguration(TriggerConfiguration.TriggerType triggerType, String scrapeInterval, List<TriggerConfiguration.TriggerElement> triggerElementList, TriggeredScrapeJobImpl triggeredScrapeJobImpl)	default constructor when a tag should be used for triggering

Method Summary

Modifier and Type	Method	Description
static TriggerConfiguration	createConfiguration(String jobTriggerStrategy, TriggeredScrapeJobImpl triggeredScrapeJob)	creates the TriggerConfiguration for a given ScrapeJob from triggerConfig-String
long	getScrapeInterval()
List<TriggerConfiguration.TriggerElement>	getTriggerElementList()

Methods inherited from class java.lang.Object

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

Constructor Detail

TriggerConfiguration

public TriggerConfiguration(TriggerConfiguration.TriggerType triggerType,
                            String scrapeInterval,
                            List<TriggerConfiguration.TriggerElement> triggerElementList,
                            TriggeredScrapeJobImpl triggeredScrapeJobImpl)
                     throws ScraperConfigurationException

default constructor when a tag should be used for triggering

Parameters:

triggerType - type of trigger from enum

scrapeInterval - scrape interval of triggered variable

triggerElementList - list of triggerElements with concat that combined is used as trigger

triggeredScrapeJobImpl - the job which is valid for the configuration

Throws:

ScraperConfigurationException - when something goes wrong with configuration

TriggerConfiguration

public TriggerConfiguration(TriggerConfiguration.TriggerType triggerType,
                            String scrapeInterval)
                     throws ScraperConfigurationException

default constructor when scheduled trigger shall be performed

Parameters:

triggerType - type of trigger from enum

scrapeInterval - scrape interval of data from block

Throws:

ScraperConfigurationException - when something goes wrong with configuration

Method Detail

createConfiguration

public static TriggerConfiguration createConfiguration(String jobTriggerStrategy,
                                                       TriggeredScrapeJobImpl triggeredScrapeJob)
                                                throws ScraperConfigurationException

creates the TriggerConfiguration for a given ScrapeJob from triggerConfig-String

Parameters:

jobTriggerStrategy - config-string from file

triggeredScrapeJob - job belonging to the config

Returns:

created TriggerConfiguration

Throws:

ScraperConfigurationException - when something goes wrong

getScrapeInterval

public long getScrapeInterval()

getTriggerElementList

public List<TriggerConfiguration.TriggerElement> getTriggerElementList()