org.apache.nifi.lookup.script

Class BaseScriptedLookupService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.script.AbstractScriptedControllerService

org.apache.nifi.lookup.script.BaseScriptedLookupService

All Implemented Interfaces:

ConfigurableComponent, ControllerService

Direct Known Subclasses:

ScriptedLookupService, SimpleScriptedLookupService

public class BaseScriptedLookupService
extends AbstractScriptedControllerService

Field Summary

Fields

Modifier and Type	Field and Description
protected File	kerberosConfigFile
protected File	kerberosServiceKeytab
protected String	kerberosServicePrincipal
protected AtomicReference<LookupService>	lookupService

Fields inherited from class org.apache.nifi.script.AbstractScriptedControllerService

configurationContext, scriptEngine, scriptingComponentHelper, scriptNeedsReload, validationResults

Constructor Summary

Constructors

Constructor and Description
BaseScriptedLookupService()

Method Summary

Modifier and Type	Method and Description
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName) Returns a PropertyDescriptor for the given name.
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors() Returns a list of property descriptors supported by this processor.
protected void	init(ControllerServiceInitializationContext context)
void	onDisabled(ConfigurationContext context)
void	onEnabled(ConfigurationContext context)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue) Handles changes to this processor's properties.
protected boolean	reloadScript(String scriptBody) Reloads the script RecordReaderFactory.
void	setup()

Methods inherited from class org.apache.nifi.script.AbstractScriptedControllerService

customValidate, reloadScriptBody, reloadScriptFile

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, initialize, isEnabled

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

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, 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, validate

Field Detail

lookupService

protected final AtomicReference<LookupService> lookupService

kerberosServicePrincipal

protected volatile String kerberosServicePrincipal

kerberosConfigFile

protected volatile File kerberosConfigFile

kerberosServiceKeytab

protected volatile File kerberosServiceKeytab

Constructor Detail

BaseScriptedLookupService

public BaseScriptedLookupService()

Method Detail

init

protected void init(ControllerServiceInitializationContext context)

Overrides:

init in class AbstractControllerService

getSupportedPropertyDescriptors

protected 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 AbstractScriptedControllerService

Returns:

a List of PropertyDescriptor objects supported by this processor

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(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 AbstractScriptedControllerService

Parameters:

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

Returns:

a PropertyDescriptor object corresponding to the specified dynamic property name

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               String oldValue,
                               String newValue)

Handles changes to this processor's properties. If changes are made to script- or engine-related properties, the script will be reloaded.

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractScriptedControllerService

Parameters:

descriptor - of the modified property

oldValue - non-null property value (previous)

newValue - the new property value or if null indicates the property

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)

Overrides:

onEnabled in class AbstractScriptedControllerService

onDisabled

@OnDisabled
public void onDisabled(ConfigurationContext context)

setup

public void setup()

Specified by:

setup in class AbstractScriptedControllerService

reloadScript

protected boolean reloadScript(String scriptBody)

Reloads the script RecordReaderFactory. This must be called within the lock.

Specified by:

reloadScript in class AbstractScriptedControllerService

Parameters:

scriptBody - An input stream associated with the script content

Returns:

Whether the script was successfully reloaded