org.apache.nifi.processor.util.put

Class AbstractPutEventProcessor

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.util.put.AbstractPutEventProcessor

All Implemented Interfaces:

ConfigurableComponent, Processor

public abstract class AbstractPutEventProcessor
extends AbstractSessionFactoryProcessor

A base class for processors that send data to an external system using TCP or UDP.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractPutEventProcessor.FlowFileMessageBatch A wrapper to hold the ranges of a FlowFile that were successful and ranges that failed, and then transfer those ranges appropriately.
protected static class	AbstractPutEventProcessor.PruneResult The results from pruning connections.
protected static class	AbstractPutEventProcessor.Range Represents a range of messages from a FlowFile.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<AbstractPutEventProcessor.FlowFileMessageBatch>	activeBatches
static PropertyDescriptor	CHARSET
protected BlockingQueue<AbstractPutEventProcessor.FlowFileMessageBatch>	completeBatches
static PropertyDescriptor	CONNECTION_PER_FLOWFILE
private List<PropertyDescriptor>	descriptors
static PropertyDescriptor	HOSTNAME
static PropertyDescriptor	IDLE_EXPIRATION
static PropertyDescriptor	MAX_SOCKET_SEND_BUFFER_SIZE
static PropertyDescriptor	MESSAGE_DELIMITER
static PropertyDescriptor	OUTGOING_MESSAGE_DELIMITER
static PropertyDescriptor	PORT
static PropertyDescriptor	PROTOCOL
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
protected BlockingQueue<ChannelSender>	senderPool
static PropertyDescriptor	SSL_CONTEXT_SERVICE
static AllowableValue	TCP_VALUE
static PropertyDescriptor	TIMEOUT
protected String	transitUri
static AllowableValue	UDP_VALUE

Constructor Summary

Constructors

Constructor and Description
AbstractPutEventProcessor()

Method Summary

Modifier and Type	Method and Description
protected ChannelSender	acquireSender(ProcessContext context, ProcessSession session, FlowFile flowFile) Helper method to acquire an available ChannelSender from the pool.
void	closeSenders()
protected abstract ChannelSender	createSender(ProcessContext context) Sub-classes create a ChannelSender given a context.
protected ChannelSender	createSender(String protocol, String host, int port, int timeout, int maxSendBufferSize, SSLContext sslContext) Helper for sub-classes to create a sender.
protected abstract String	createTransitUri(ProcessContext context) Sub-classes construct a transit uri for provenance events.
protected List<PropertyDescriptor>	getAdditionalProperties() Override to provide additional properties for the processor.
protected List<Relationship>	getAdditionalRelationships() Override to provide additional relationships for the processor.
protected String	getOutgoingMessageDelimiter(ProcessContext context, FlowFile flowFile) Gets the current value of the "Outgoing Message Delimiter" property and parses the special characters.
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onScheduled(ProcessContext context)
protected AbstractPutEventProcessor.PruneResult	pruneIdleSenders(long idleThreshold) Close any senders that haven't been active with in the given threshold
protected void	relinquishSender(ChannelSender sender) Helper method to relinquish the ChannelSender back to the pool.

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, getSupportedDynamicPropertyDescriptor, 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.processor.Processor

onTrigger

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

HOSTNAME

public static final PropertyDescriptor HOSTNAME

PORT

public static final PropertyDescriptor PORT

MAX_SOCKET_SEND_BUFFER_SIZE

public static final PropertyDescriptor MAX_SOCKET_SEND_BUFFER_SIZE

IDLE_EXPIRATION

public static final PropertyDescriptor IDLE_EXPIRATION

TCP_VALUE

public static final AllowableValue TCP_VALUE

UDP_VALUE

public static final AllowableValue UDP_VALUE

PROTOCOL

public static final PropertyDescriptor PROTOCOL

MESSAGE_DELIMITER

public static final PropertyDescriptor MESSAGE_DELIMITER

CHARSET

public static final PropertyDescriptor CHARSET

TIMEOUT

public static final PropertyDescriptor TIMEOUT

OUTGOING_MESSAGE_DELIMITER

public static final PropertyDescriptor OUTGOING_MESSAGE_DELIMITER

CONNECTION_PER_FLOWFILE

public static final PropertyDescriptor CONNECTION_PER_FLOWFILE

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

relationships

private Set<Relationship> relationships

descriptors

private List<PropertyDescriptor> descriptors

transitUri

protected volatile String transitUri

senderPool

protected volatile BlockingQueue<ChannelSender> senderPool

completeBatches

protected final BlockingQueue<AbstractPutEventProcessor.FlowFileMessageBatch> completeBatches

activeBatches

protected final Set<AbstractPutEventProcessor.FlowFileMessageBatch> activeBatches

Constructor Detail

AbstractPutEventProcessor

public AbstractPutEventProcessor()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getAdditionalRelationships

protected List<Relationship> getAdditionalRelationships()

Override to provide additional relationships for the processor.

Returns:

a list of relationships

getAdditionalProperties

protected List<PropertyDescriptor> getAdditionalProperties()

Override to provide additional properties for the processor.

Returns:

a list of properties

getRelationships

public final Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws IOException

Throws:

IOException

closeSenders

@OnStopped
public void closeSenders()

createTransitUri

protected abstract String createTransitUri(ProcessContext context)

Sub-classes construct a transit uri for provenance events. Called from @OnScheduled method of this class.

Parameters:

context - the current context

Returns:

the transit uri

createSender

protected abstract ChannelSender createSender(ProcessContext context)
                                       throws IOException

Sub-classes create a ChannelSender given a context.

Parameters:

context - the current context

Returns:

an implementation of ChannelSender

Throws:

IOException - if an error occurs creating the ChannelSender

pruneIdleSenders

protected AbstractPutEventProcessor.PruneResult pruneIdleSenders(long idleThreshold)

Close any senders that haven't been active with in the given threshold

Parameters:

idleThreshold - the threshold to consider a sender as idle

Returns:

the number of connections that were closed as a result of being idle

createSender

protected ChannelSender createSender(String protocol,
                                     String host,
                                     int port,
                                     int timeout,
                                     int maxSendBufferSize,
                                     SSLContext sslContext)
                              throws IOException

Helper for sub-classes to create a sender.

Parameters:

protocol - the protocol for the sender

host - the host to send to

port - the port to send to

timeout - the timeout for connecting and communicating over the channel

maxSendBufferSize - the maximum size of the socket send buffer

sslContext - an SSLContext, or null if not using SSL

Returns:

a ChannelSender based on the given properties

Throws:

IOException - if an error occurs creating the sender

acquireSender

protected ChannelSender acquireSender(ProcessContext context,
                                      ProcessSession session,
                                      FlowFile flowFile)

Helper method to acquire an available ChannelSender from the pool. If the pool is empty then the a new sender is created.

Parameters:

context - - the current process context.

session - - the current process session.

flowFile - - the FlowFile being processed in this session.

Returns:

ChannelSender - the sender that has been acquired or null if no sender is available and a new sender cannot be created.

relinquishSender

protected void relinquishSender(ChannelSender sender)

Helper method to relinquish the ChannelSender back to the pool. If the sender is disconnected or the pool is full then the sender is closed and discarded.

Parameters:

sender - the sender to return or close

getOutgoingMessageDelimiter

protected String getOutgoingMessageDelimiter(ProcessContext context,
                                             FlowFile flowFile)

Gets the current value of the "Outgoing Message Delimiter" property and parses the special characters.

Parameters:

context - - the current process context.

flowFile - - the FlowFile being processed.

Returns:

String containing the Delimiter value.