org.apache.nifi.processors.standard

Class PutTCP

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

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

org.apache.nifi.processors.standard.PutTCP

All Implemented Interfaces:

ConfigurableComponent, Processor

@CapabilityDescription(value="The PutTCP processor receives a FlowFile and transmits the FlowFile content over a TCP connection to the configured TCP server. By default, the FlowFiles are transmitted over the same TCP connection (or pool of TCP connections if multiple input threads are configured). To assist the TCP server with determining message boundaries, an optional \"Outgoing Message Delimiter\" string can be configured which is appended to the end of each FlowFiles content when it is transmitted over the TCP connection. An optional \"Connection Per FlowFile\" parameter can be specified to change the behaviour so that each FlowFiles content is transmitted over a single TCP connection which is opened when the FlowFile is received and closed after the FlowFile has been sent. This option should only be used for low message volume scenarios, otherwise the platform may run out of TCP sockets.")
 @InputRequirement(value=INPUT_REQUIRED)
 @SeeAlso(value=ListenTCP.class)
 @Tags(value={"remote","egress","put","tcp"})
 @TriggerWhenEmpty
public class PutTCP
extends AbstractPutEventProcessor

The PutTCP processor receives a FlowFile and transmits the FlowFile content over a TCP connection to the configured TCP server. By default, the FlowFiles are transmitted over the same TCP connection (or pool of TCP connections if multiple input threads are configured). To assist the TCP server with determining message boundaries, an optional "Outgoing Message Delimiter" string can be configured which is appended to the end of each FlowFiles content when it is transmitted over the TCP connection. An optional "Connection Per FlowFile" parameter can be specified to change the behaviour so that each FlowFiles content is transmitted over a single TCP connection which is opened when the FlowFile is received and closed after the FlowFile has been sent. This option should only be used for low message volume scenarios, otherwise the platform may run out of TCP sockets.

This processor has the following required properties:

• Hostname - The IP address or host name of the destination TCP server.
• Port - The TCP port of the destination TCP server.

This processor has the following optional properties:

• Connection Per FlowFile - Specifies that each FlowFiles content will be transmitted on a separate TCP connection.
• Idle Connection Expiration - The time threshold after which a TCP sender is deemed eligible for pruning - the associated TCP connection will be closed after this timeout.
• Max Size of Socket Send Buffer - The maximum size of the socket send buffer that should be used. This is a suggestion to the Operating System to indicate how big the socket buffer should be. If this value is set too low, the buffer may fill up before the data can be read, and incoming data will be dropped.
• Outgoing Message Delimiter - A string to append to the end of each FlowFiles content to indicate the end of the message to the TCP server.
• Timeout - The timeout period for determining an error has occurred whilst connecting or sending data.

The following relationships are required:

• failure - Where to route FlowFiles that failed to be sent.
• success - Where to route FlowFiles after they were successfully sent to the TCP server.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.nifi.processor.util.put.AbstractPutEventProcessor

AbstractPutEventProcessor.FlowFileMessageBatch, AbstractPutEventProcessor.Range

Field Summary

Fields inherited from class org.apache.nifi.processor.util.put.AbstractPutEventProcessor

activeBatches, CHARSET, completeBatches, CONNECTION_PER_FLOWFILE, HOSTNAME, IDLE_EXPIRATION, MAX_SOCKET_SEND_BUFFER_SIZE, MESSAGE_DELIMITER, OUTGOING_MESSAGE_DELIMITER, PORT, PROTOCOL, REL_FAILURE, REL_SUCCESS, senderPool, SSL_CONTEXT_SERVICE, TCP_VALUE, TIMEOUT, transitUri, UDP_VALUE

Constructor Summary

Constructors

Constructor and Description
PutTCP()

Method Summary

Modifier and Type	Method and Description
protected ChannelSender	createSender(ProcessContext context) Creates a concrete instance of a ChannelSender object to use for sending messages over a TCP stream.
protected java.lang.String	createTransitUri(ProcessContext context) Creates a Universal Resource Identifier (URI) for this processor.
protected java.util.List<PropertyDescriptor>	getAdditionalProperties() Get the additional properties that are used by this processor.
protected boolean	isConnectionPerFlowFile(ProcessContext context) Gets the current value of the "Connection Per FlowFile" property.
protected void	onFailure(ProcessContext context, ProcessSession session, FlowFile flowFile) Event handler method to perform the required actions when a failure has occurred.
void	onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory) event handler method to handle the FlowFile being forwarded to the Processor by the framework.

Methods inherited from class org.apache.nifi.processor.util.put.AbstractPutEventProcessor

acquireSender, closeSenders, createSender, getAdditionalRelationships, getOutgoingMessageDelimiter, getRelationships, getSupportedPropertyDescriptors, init, onScheduled, pruneIdleSenders, relinquishSender

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.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Constructor Detail

PutTCP

public PutTCP()

Method Detail

createSender

protected ChannelSender createSender(ProcessContext context)
                              throws java.io.IOException

Creates a concrete instance of a ChannelSender object to use for sending messages over a TCP stream.

Specified by:

createSender in class AbstractPutEventProcessor

Parameters:

context - - the current process context.

Returns:

ChannelSender object.

Throws:

java.io.IOException - if an error occurs creating the ChannelSender

createTransitUri

protected java.lang.String createTransitUri(ProcessContext context)

Creates a Universal Resource Identifier (URI) for this processor. Constructs a URI of the form TCP://< host >:< port > where the host and port values are taken from the configured property values.

Specified by:

createTransitUri in class AbstractPutEventProcessor

Parameters:

context - - the current process context.

Returns:

The URI value as a String.

getAdditionalProperties

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

Get the additional properties that are used by this processor.

Overrides:

getAdditionalProperties in class AbstractPutEventProcessor

Returns:

List of PropertyDescriptors describing the additional properties.

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSessionFactory sessionFactory)
               throws ProcessException

event handler method to handle the FlowFile being forwarded to the Processor by the framework. The FlowFile contents is sent out over a TCP connection using an acquired ChannelSender object. If the FlowFile contents was sent out successfully then the FlowFile is forwarded to the success relationship. If an error occurred then the FlowFile is forwarded to the failure relationship.

Parameters:

context - - the current process context.

sessionFactory - - a factory object to obtain a process session.

Throws:

ProcessException - if processing did not complete normally though indicates the problem is an understood potential outcome of processing. The controller/caller will handle these exceptions gracefully such as logging, etc.. If another type of exception is allowed to propagate the controller may no longer trigger this processor to operate, as this would indicate a probable coding defect.

onFailure

protected void onFailure(ProcessContext context,
                         ProcessSession session,
                         FlowFile flowFile)

Event handler method to perform the required actions when a failure has occurred. The FlowFile is penalized, forwarded to the failure relationship and the context is yielded.

Parameters:

context - - the current process context.

session - - the current process session.

flowFile - - the FlowFile that has failed to have been processed.

isConnectionPerFlowFile

protected boolean isConnectionPerFlowFile(ProcessContext context)

Gets the current value of the "Connection Per FlowFile" property.

Parameters:

context - - the current process context.

Returns:

boolean value - true if a connection per FlowFile is specified.