org.apache.nifi.documentation.example

Class FullyDocumentedProcessor

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.documentation.example.FullyDocumentedProcessor

All Implemented Interfaces:

ConfigurableComponent, Processor

@Tags(value={"one","two","three"})
 @CapabilityDescription(value="This is a processor that is used to test documentation.")
 @WritesAttribute(attribute="first",description="this is the first attribute i write") @WritesAttribute(attribute="second")
 @ReadsAttribute(attribute="incoming",
                description="this specifies the format of the thing")
 @SeeAlso(value={FullyDocumentedControllerService.class,FullyDocumentedReportingTask.class},
         classNames="org.apache.nifi.processor.ExampleProcessor")
 @DynamicProperty(name="Relationship Name",
                 supportsExpressionLanguage=true,
                 value="some XPath",
                 description="Routes FlowFiles to relationships based on XPath")
 @DynamicRelationship(name="name from dynamic property",
                     description="all files that match the properties XPath")
 @Stateful(scopes={CLUSTER,LOCAL},
          description="state management description")
 @Restricted(value="processor restriction description")
 @InputRequirement(value=INPUT_FORBIDDEN)
public class FullyDocumentedProcessor
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	DIRECTORY
static PropertyDescriptor	OPTIONAL_PROPERTY
static PropertyDescriptor	POLLING_INTERVAL
static PropertyDescriptor	RECURSE
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
static PropertyDescriptor	SERVICE_PROPERTY
static PropertyDescriptor	TYPE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
FullyDocumentedProcessor()

Method Summary

Modifier and Type	Method and Description
int	getOnRemovedArgs()
int	getOnRemovedNoArgs()
int	getOnShutdownArgs()
int	getOnShutdownNoArgs()
java.util.Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName) Used to allow subclasses to determine what PropertyDescriptor if any to use when a property is requested for which a descriptor is not already registered.
protected java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
protected void	init(ProcessorInitializationContext context) Provides subclasses the ability to perform initialization logic
void	onRemovedArgs(ProcessContext context)
void	onRemovedNoArgs()
void	onShutdownArgs(ProcessContext context)
void	onShutdownNoArgs()
void	onTrigger(ProcessContext context, ProcessSession session)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

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

DIRECTORY

public static final PropertyDescriptor DIRECTORY

RECURSE

public static final PropertyDescriptor RECURSE

POLLING_INTERVAL

public static final PropertyDescriptor POLLING_INTERVAL

OPTIONAL_PROPERTY

public static final PropertyDescriptor OPTIONAL_PROPERTY

TYPE_PROPERTY

public static final PropertyDescriptor TYPE_PROPERTY

SERVICE_PROPERTY

public static final PropertyDescriptor SERVICE_PROPERTY

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

Constructor Detail

FullyDocumentedProcessor

public FullyDocumentedProcessor()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Description copied from class: AbstractSessionFactoryProcessor

Provides subclasses the ability to perform initialization logic

Overrides:

init in class AbstractSessionFactoryProcessor

Parameters:

context - in which to perform initialization

getSupportedPropertyDescriptors

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

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

getRelationships

public java.util.Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

Returns:

Set of all relationships this processor expects to transfer a flow file to. An empty set indicates this processor does not have any destination relationships. Guaranteed non null.

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName)

Description copied from class: AbstractConfigurableComponent

Used to allow subclasses to determine what PropertyDescriptor if any to use when a property is requested for which a descriptor is not already registered. By default this method simply returns a null descriptor. By overriding this method processor implementations can support dynamic properties since this allows them to register properties on demand. It is acceptable for a dynamically generated property to indicate it is required so long as it is understood it is only required once set. Dynamic properties by definition cannot be required until used.

This method should be side effect free in the subclasses in terms of how often it is called for a given property name because there is guarantees how often it will be called for a given property name.

Default is null.

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

Parameters:

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

Returns:

new property descriptor if supported

onRemovedNoArgs

@OnRemoved
public void onRemovedNoArgs()

onRemovedArgs

@OnRemoved
public void onRemovedArgs(ProcessContext context)

onShutdownNoArgs

@OnShutdown
public void onShutdownNoArgs()

onShutdownArgs

@OnShutdown
public void onShutdownArgs(ProcessContext context)

getOnRemovedNoArgs

public int getOnRemovedNoArgs()

getOnRemovedArgs

public int getOnRemovedArgs()

getOnShutdownNoArgs

public int getOnShutdownNoArgs()

getOnShutdownArgs

public int getOnShutdownArgs()