ScriptingComponentHelper (nifi-scripting-processors 1.13.2 API)

java.lang.Object
- org.apache.nifi.script.ScriptingComponentHelper

```
public class ScriptingComponentHelper
extends Object
```
This class contains variables and methods common to scripting processors, reporting tasks, etc.

Field Summary

Fields
Modifier and Type	Field and Description
`private List<PropertyDescriptor>`	`descriptors`
`private List<AllowableValue>`	`engineAllowableValues`
`BlockingQueue<ScriptEngine>`	`engineQ`
`AtomicBoolean`	`isInitialized`
`private String[]`	`modules`
`PropertyDescriptor`	`SCRIPT_ENGINE`
`private String`	`scriptBody`
`Map<String,ScriptEngineConfigurator>`	`scriptEngineConfiguratorMap`
`Map<String,ScriptEngineFactory>`	`scriptEngineFactoryMap`
`private String`	`scriptEngineName`
`private String`	`scriptPath`

Constructor Summary

Constructors
Constructor and Description

ScriptingComponentHelper()

Constructors
Constructor and Description
`ScriptingComponentHelper()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createResources()` This method creates all resources needed for the script processor to function, such as script engines, script file reloader threads, etc.
`protected ScriptEngine`	`createScriptEngine()` Provides a ScriptEngine corresponding to the currently selected script engine name.
`Collection<ValidationResult>`	`customValidate(ValidationContext validationContext)` Custom validation for ensuring exactly one of Script File or Script Body is populated
`List<PropertyDescriptor>`	`getDescriptors()`
`String[]`	`getModules()`
`String`	`getScriptBody()`
`List<AllowableValue>`	`getScriptEngineAllowableValues()`
`String`	`getScriptEngineName()`
`String`	`getScriptPath()`
`static boolean`	`isFile(String path)` Determines whether the given path refers to a valid file
`void`	`setDescriptors(List<PropertyDescriptor> descriptors)`
`void`	`setModules(String[] modules)`
`void`	`setScriptBody(String scriptBody)`
`void`	`setScriptEngineName(String scriptEngineName)`
`void`	`setScriptPath(String scriptPath)`
`void`	`setup(int numberOfScriptEngines, ComponentLog log)` Performs common setup operations when the processor is scheduled to run.
`protected void`	`setupEngines(int numberOfScriptEngines, ComponentLog log)` Configures the specified script engine.
`void`	`setupVariables(PropertyContext context)`
`void`	`stop()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SCRIPT_ENGINE
```
public PropertyDescriptor SCRIPT_ENGINE
```
  - scriptEngineConfiguratorMap
```
public final Map<String,ScriptEngineConfigurator> scriptEngineConfiguratorMap
```
  - isInitialized
```
public final AtomicBoolean isInitialized
```
  - scriptEngineFactoryMap
```
public Map<String,ScriptEngineFactory> scriptEngineFactoryMap
```
  - scriptEngineName
```
private String scriptEngineName
```
  - scriptPath
```
private String scriptPath
```
  - scriptBody
```
private String scriptBody
```
  - modules
```
private String[] modules
```
  - descriptors
```
private List<PropertyDescriptor> descriptors
```
  - engineAllowableValues
```
private List<AllowableValue> engineAllowableValues
```
  - engineQ
```
public BlockingQueue<ScriptEngine> engineQ
```
- Constructor Detail
  - ScriptingComponentHelper
```
public ScriptingComponentHelper()
```
- Method Detail
  - getScriptEngineName
```
public String getScriptEngineName()
```
  - setScriptEngineName
```
public void setScriptEngineName(String scriptEngineName)
```
  - getScriptPath
```
public String getScriptPath()
```
  - setScriptPath
```
public void setScriptPath(String scriptPath)
```
  - getScriptBody
```
public String getScriptBody()
```
  - setScriptBody
```
public void setScriptBody(String scriptBody)
```
  - getModules
```
public String[] getModules()
```
  - setModules
```
public void setModules(String[] modules)
```
  - getDescriptors
```
public List<PropertyDescriptor> getDescriptors()
```
  - getScriptEngineAllowableValues
```
public List<AllowableValue> getScriptEngineAllowableValues()
```
  - setDescriptors
```
public void setDescriptors(List<PropertyDescriptor> descriptors)
```
  - customValidate
```
public Collection<ValidationResult> customValidate(ValidationContext validationContext)
```
    Custom validation for ensuring exactly one of Script File or Script Body is populated
    
    Parameters:
    
    validationContext - provides a mechanism for obtaining externally managed values, such as property values and supplies convenience methods for operating on those values
    
    Returns:
    
    A collection of validation results
  - createResources
```
public void createResources()
```
    This method creates all resources needed for the script processor to function, such as script engines, script file reloader threads, etc.
  - isFile
```
public static boolean isFile(String path)
```
    Determines whether the given path refers to a valid file
    
    Parameters:
    
    path - a path to a file
    
    Returns:
    
    true if the path refers to a valid file, false otherwise
  - setup
```
public void setup(int numberOfScriptEngines,
                  ComponentLog log)
```
    Performs common setup operations when the processor is scheduled to run. This method assumes the member variables associated with properties have been filled.
    
    Parameters:
    
    numberOfScriptEngines - number of engines to setup
  - setupEngines
```
protected void setupEngines(int numberOfScriptEngines,
                            ComponentLog log)
```
    Configures the specified script engine. First, the engine is loaded and instantiated using the JSR-223 javax.script APIs. Then, if any script configurators have been defined for this engine, their init() method is called, and the configurator is saved for future calls.
    
    Parameters:
    
    numberOfScriptEngines - number of engines to setup
    
    See Also:
    
    ScriptEngineConfigurator
  - setupVariables
```
public void setupVariables(PropertyContext context)
```
  - createScriptEngine
```
protected ScriptEngine createScriptEngine()
```
    Provides a ScriptEngine corresponding to the currently selected script engine name. ScriptEngineManager.getEngineByName() doesn't use find ScriptEngineFactory.getName(), which is what we used to populate the list. So just search the list of factories until a match is found, then create and return a script engine.
    
    Returns:
    
    a Script Engine corresponding to the currently specified name, or null if none is found.
  - stop
```
public void stop()
```

Class ScriptingComponentHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCRIPT_ENGINE

scriptEngineConfiguratorMap

isInitialized

scriptEngineFactoryMap

scriptEngineName

scriptPath

scriptBody

modules

descriptors

engineAllowableValues

engineQ

Constructor Detail

ScriptingComponentHelper

Method Detail

getScriptEngineName

setScriptEngineName

getScriptPath

setScriptPath

getScriptBody

setScriptBody

getModules

setModules

getDescriptors

getScriptEngineAllowableValues

setDescriptors

customValidate

createResources

isFile

setup

setupEngines

setupVariables

createScriptEngine

stop