org.apache.nifi.processor.util.pattern

Class Put<FC,C extends AutoCloseable>

java.lang.Object

org.apache.nifi.processor.util.pattern.Put<FC,C>

Type Parameters:

FC - Class of context instance which is passed to each partial functions. Lifetime of an function context should be limited for a single onTrigger method.

C - Class of connection to a data storage that this pattern puts data into.

Direct Known Subclasses:

PutGroup

public class Put<FC,C extends AutoCloseable>
extends Object

Abstract Put pattern class with a generic onTrigger method structure, composed with various partial functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Put.PutFlowFile<FC,C>

Field Summary

Fields

Modifier and Type	Field and Description
protected PartialFunctions.AdjustRoute<FC>	adjustRoute
protected PartialFunctions.Cleanup<FC,C>	cleanup
protected PartialFunctions.FetchFlowFiles<FC>	fetchFlowFiles
protected PartialFunctions.InitConnection<FC,C>	initConnection
protected ComponentLog	logger
protected PartialFunctions.OnCompleted<FC,C>	onCompleted
protected PartialFunctions.OnFailed<FC,C>	onFailed
protected Put.PutFlowFile<FC,C>	putFlowFile
protected PartialFunctions.TransferFlowFiles<FC>	transferFlowFiles

Constructor Summary

Constructors

Constructor and Description
Put()

Method Summary

Modifier and Type	Method and Description
void	adjustRoute(PartialFunctions.AdjustRoute<FC> f) Specify an optional function that adjust routed FlowFiles before transfer it.
void	cleanup(PartialFunctions.Cleanup<FC,C> f) Specify an optional function which will be called in a finally block.
void	fetchFlowFiles(PartialFunctions.FetchFlowFiles<FC> f) Specify an optional function that fetches incoming FlowFIles.
void	initConnection(PartialFunctions.InitConnection<FC,C> f) Specify a function that establishes a connection to target data storage.
void	onCompleted(PartialFunctions.OnCompleted<FC,C> f) Specify an optional function which will be called if input FlowFiles were successfully put to a target storage.
void	onFailed(PartialFunctions.OnFailed<FC,C> f) Specify an optional function which will be called if input FlowFiles failed being put to a target storage.
void	onTrigger(ProcessContext context, ProcessSession session, FC functionContext) Processor using this pattern is expected to call this method from its onTrigger.
void	putFlowFile(Put.PutFlowFile<FC,C> f) Specify a function that puts an incoming FlowFile to target data storage.
protected void	putFlowFiles(ProcessContext context, ProcessSession session, FC functionContext, C connection, List<FlowFile> flowFiles, RoutingResult result) Put fetched FlowFiles to a data storage.
void	setLogger(ComponentLog logger)
void	transferFlowFiles(PartialFunctions.TransferFlowFiles<FC> f) Specify an optional function responsible for transferring routed FlowFiles.
protected void	validateCompositePattern()

Methods inherited from class java.lang.Object

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

Field Detail

initConnection

protected PartialFunctions.InitConnection<FC,C extends AutoCloseable> initConnection

fetchFlowFiles

protected PartialFunctions.FetchFlowFiles<FC> fetchFlowFiles

putFlowFile

protected Put.PutFlowFile<FC,C extends AutoCloseable> putFlowFile

transferFlowFiles

protected PartialFunctions.TransferFlowFiles<FC> transferFlowFiles

adjustRoute

protected PartialFunctions.AdjustRoute<FC> adjustRoute

onCompleted

protected PartialFunctions.OnCompleted<FC,C extends AutoCloseable> onCompleted

onFailed

protected PartialFunctions.OnFailed<FC,C extends AutoCloseable> onFailed

cleanup

protected PartialFunctions.Cleanup<FC,C extends AutoCloseable> cleanup

logger

protected ComponentLog logger

Constructor Detail

Put

public Put()

Method Detail

putFlowFiles

protected void putFlowFiles(ProcessContext context,
                            ProcessSession session,
                            FC functionContext,
                            C connection,
                            List<FlowFile> flowFiles,
                            RoutingResult result)
                     throws ProcessException

Put fetched FlowFiles to a data storage.

Parameters:

context - process context passed from a Processor onTrigger.

session - process session passed from a Processor onTrigger.

functionContext - function context passed from a Processor onTrigger.

connection - connection to data storage, established by PartialFunctions.InitConnection.

flowFiles - FlowFiles fetched from PartialFunctions.FetchFlowFiles.

result - Route incoming FlowFiles if necessary.

Throws:

ProcessException

validateCompositePattern

protected void validateCompositePattern()

onTrigger

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

Processor using this pattern is expected to call this method from its onTrigger.

Typical usage would be constructing a process pattern instance at a processor method which is annotated with OnScheduled, and use pattern.onTrigger from processor.onTrigger.

PartialFunctions.InitConnection is required at least. In addition to any functions required by an implementation class.

Parameters:

context - process context passed from a Processor onTrigger.

session - process session passed from a Processor onTrigger.

functionContext - function context should be instantiated per onTrigger call.

Throws:

ProcessException - Each partial function can throw ProcessException if onTrigger should stop immediately.

fetchFlowFiles

public void fetchFlowFiles(PartialFunctions.FetchFlowFiles<FC> f)

Specify an optional function that fetches incoming FlowFIles. If not specified, single FlowFile is fetched on each onTrigger.

Parameters:

f - Function to fetch incoming FlowFiles.

initConnection

public void initConnection(PartialFunctions.InitConnection<FC,C> f)

Specify a function that establishes a connection to target data storage. This function will be called when there is valid incoming FlowFiles. The created connection instance is automatically closed when onTrigger is finished.

Parameters:

f - Function to initiate a connection to a data storage.

putFlowFile

public void putFlowFile(Put.PutFlowFile<FC,C> f)

Specify a function that puts an incoming FlowFile to target data storage.

Parameters:

f - a function to put a FlowFile to target storage.

adjustRoute

public void adjustRoute(PartialFunctions.AdjustRoute<FC> f)

Specify an optional function that adjust routed FlowFiles before transfer it.

Parameters:

f - a function to adjust route.

transferFlowFiles

public void transferFlowFiles(PartialFunctions.TransferFlowFiles<FC> f)

Specify an optional function responsible for transferring routed FlowFiles. If not specified routed FlowFiles are simply transferred to its destination by default.

Parameters:

f - a function to transfer routed FlowFiles.

onCompleted

public void onCompleted(PartialFunctions.OnCompleted<FC,C> f)

Specify an optional function which will be called if input FlowFiles were successfully put to a target storage.

Parameters:

f - Function to be called when a put operation finishes successfully.

onFailed

public void onFailed(PartialFunctions.OnFailed<FC,C> f)

Specify an optional function which will be called if input FlowFiles failed being put to a target storage.

Parameters:

f - Function to be called when a put operation failed.

cleanup

public void cleanup(PartialFunctions.Cleanup<FC,C> f)

Specify an optional function which will be called in a finally block. Typically useful when a special cleanup operation is needed for the connection.

Parameters:

f - Function to be called when a put operation finished regardless of whether it succeeded or not.

setLogger

public void setLogger(ComponentLog logger)