org.apache.nifi.reporting.script

Class ScriptedReportingTask

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.reporting.AbstractReportingTask

org.apache.nifi.reporting.script.ScriptedReportingTask

All Implemented Interfaces:

ConfigurableComponent, ReportingTask

@Tags(value={"reporting","script","execute","groovy","python","jython","jruby","ruby","javascript","js","lua","luaj"})
 @CapabilityDescription(value="Provides reporting and status information to a script. ReportingContext, ComponentLog, and VirtualMachineMetrics objects are made available as variables (context, log, and vmMetrics, respectively) to the script for further processing. The context makes various information available such as events, provenance, bulletins, controller services, process groups, Java Virtual Machine metrics, etc.")
 @DynamicProperty(name="A script engine property to update",
                 value="The value to set it to",
                 supportsExpressionLanguage=true,
                 description="Updates a script engine property specified by the Dynamic Property\'s key with the value specified by the Dynamic Property\'s value")
 @Restricted(value="Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.")
public class ScriptedReportingTask
extends AbstractReportingTask

A Reporting task whose body is provided by a script (via supported JSR-223 script engines)

Field Summary

Fields

Modifier and Type	Field and Description
protected ScriptingComponentHelper	scriptingComponentHelper

Constructor Summary

Constructors

Constructor and Description
ScriptedReportingTask()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<ValidationResult>	customValidate(ValidationContext validationContext) Allows subclasses to perform their own validation on the already set properties.
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName) Returns a PropertyDescriptor for the given name.
protected java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Returns a list of property descriptors supported by this processor.
void	onTrigger(ReportingContext context) This method is called on a scheduled interval to allow the Reporting Task to perform its tasks.
void	setup(ConfigurationContext context) Performs setup operations when the processor is scheduled to run.

Methods inherited from class org.apache.nifi.reporting.AbstractReportingTask

getControllerServiceLookup, getIdentifier, getLogger, getName, getSchedulingPeriod, init, initialize

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

scriptingComponentHelper

protected volatile ScriptingComponentHelper scriptingComponentHelper

Constructor Detail

ScriptedReportingTask

public ScriptedReportingTask()

Method Detail

getSupportedPropertyDescriptors

protected java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Returns a list of property descriptors supported by this processor. The list always includes properties such as script engine name, script file name, script body name, script arguments, and an external module path. If the scripted processor also defines supported properties, those are added to the list as well.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

a List of PropertyDescriptor objects supported by this processor

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName)

Returns a PropertyDescriptor for the given name. This is for the user to be able to define their own properties which will be available as variables in the script

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

Parameters:

propertyDescriptorName - used to lookup if any property descriptors exist for that name

Returns:

a PropertyDescriptor object corresponding to the specified dynamic property name

customValidate

protected java.util.Collection<ValidationResult> customValidate(ValidationContext validationContext)

Description copied from class: AbstractConfigurableComponent

Allows subclasses to perform their own validation on the already set properties. Since each property is validated as it is set this allows validation of groups of properties together. Default return is an empty set. This method will be called only when it has been determined that all property values are valid according to their corresponding PropertyDescriptor's validators.

Overrides:

customValidate in class AbstractConfigurableComponent

Parameters:

validationContext - provides a mechanism for obtaining externally managed values, such as property values and supplies convenience methods for operating on those values

Returns:

Collection of ValidationResult objects that will be added to any other validation findings - may be null

setup

@OnScheduled
public void setup(ConfigurationContext context)

Performs setup operations when the processor is scheduled to run. This includes evaluating the processor's properties, as well as reloading the script (from file or the "Script Body" property)

Parameters:

context - the context in which to perform the setup operations

onTrigger

public void onTrigger(ReportingContext context)

Description copied from interface: ReportingTask

This method is called on a scheduled interval to allow the Reporting Task to perform its tasks.

Parameters:

context - reporting context