Package org.apache.nifi.processor.util.pattern

Class PutGroup<FC,C extends AutoCloseable,FFG extends PartialFunctions.FlowFileGroup>

java.lang.Object

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

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

Type Parameters:

FC - Function context class.

C - Connection class.

FFG - FlowFileGroup class.

public class PutGroup<FC,C extends AutoCloseable,FFG extends PartialFunctions.FlowFileGroup>
extends Put<FC,C>

Extended Put pattern capable of handling FlowFile groups.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutGroup.GroupFlowFiles<FC,C,FFG>
static interface	PutGroup.PutFlowFiles<FC,C,FFG>

Nested classes/interfaces inherited from class org.apache.nifi.processor.util.pattern.Put

Put.PutFlowFile<FC,C>

Field Summary

Fields

Modifier and Type	Field	Description
private PutGroup.GroupFlowFiles<FC,C,FFG>	groupFlowFiles
private PutGroup.PutFlowFiles<FC,C,FFG>	putFlowFiles

Fields inherited from class org.apache.nifi.processor.util.pattern.Put

adjustFailed, adjustRoute, cleanup, fetchFlowFiles, initConnection, logger, onCompleted, onFailed, putFlowFile, transferFlowFiles

Constructor Summary

Constructors

Constructor	Description
PutGroup()

Method Summary

Modifier and Type	Method	Description
void	groupFetchedFlowFiles(PutGroup.GroupFlowFiles<FC,C,FFG> f)	Specify a function that groups input FlowFiles into FlowFile groups.
void	putFlowFile(Put.PutFlowFile<FC,C> putFlowFile)	PutGroup does not support PutFileFile function for single FlowFile.
protected void	putFlowFiles(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session, FC functionContext, C connection, List<org.apache.nifi.flowfile.FlowFile> flowFiles, RoutingResult result)	Put fetched FlowFiles to a data storage.
void	putFlowFiles(PutGroup.PutFlowFiles<FC,C,FFG> f)	Specify a function that puts an input FlowFile group to a target storage using a given connection.
protected void	validateCompositePattern()

Methods inherited from class org.apache.nifi.processor.util.pattern.Put

adjustFailed, adjustRoute, cleanup, fetchFlowFiles, initConnection, onCompleted, onFailed, onTrigger, setLogger, transferFlowFiles

Methods inherited from class java.lang.Object

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

Field Details

groupFlowFiles

private PutGroup.GroupFlowFiles<FC,C extends AutoCloseable,FFG extends PartialFunctions.FlowFileGroup> groupFlowFiles

putFlowFiles

private PutGroup.PutFlowFiles<FC,C extends AutoCloseable,FFG extends PartialFunctions.FlowFileGroup> putFlowFiles

Constructor Details

PutGroup

public PutGroup()

Method Details

validateCompositePattern

protected void validateCompositePattern()

Overrides:

validateCompositePattern in class Put<FC,C extends AutoCloseable>

putFlowFile

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

PutGroup does not support PutFileFile function for single FlowFile. Throws UnsupportedOperationException if called.

Overrides:

putFlowFile in class Put<FC,C extends AutoCloseable>

Parameters:

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

groupFetchedFlowFiles

public void groupFetchedFlowFiles(PutGroup.GroupFlowFiles<FC,C,FFG> f)

Specify a function that groups input FlowFiles into FlowFile groups.

putFlowFiles

public void putFlowFiles(PutGroup.PutFlowFiles<FC,C,FFG> f)

Specify a function that puts an input FlowFile group to a target storage using a given connection.

putFlowFiles

protected void putFlowFiles(org.apache.nifi.processor.ProcessContext context,
 org.apache.nifi.processor.ProcessSession session,
 FC functionContext,
 C connection,
 List<org.apache.nifi.flowfile.FlowFile> flowFiles,
 RoutingResult result)
                     throws org.apache.nifi.processor.exception.ProcessException

Description copied from class: Put

Put fetched FlowFiles to a data storage.

Overrides:

putFlowFiles in class Put<FC,C extends AutoCloseable>

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:

org.apache.nifi.processor.exception.ProcessException