org.apache.nifi.processors.standard

Class ListenTCP

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processor.util.listen.AbstractListenEventProcessor<E>

org.apache.nifi.processor.util.listen.AbstractListenEventBatchingProcessor<StandardEvent>

org.apache.nifi.processors.standard.ListenTCP

All Implemented Interfaces:

ConfigurableComponent, Processor

@SupportsBatching
 @InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"listen","tcp","tls","ssl"})
 @CapabilityDescription(value="Listens for incoming TCP connections and reads data from each connection using a line separator as the message demarcator. The default behavior is for each message to produce a single FlowFile, however this can be controlled by increasing the Batch Size to a larger value for higher throughput. The Receive Buffer Size must be set as large as the largest messages expected to be received, meaning if every 100kb there is a line separator, then the Receive Buffer Size must be greater than 100kb.")
 @WritesAttribute(attribute="tcp.sender",description="The sending host of the messages.") @WritesAttribute(attribute="tcp.port",description="The sending port the messages were received.")
public class ListenTCP
extends AbstractListenEventBatchingProcessor<StandardEvent>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.nifi.processor.util.listen.AbstractListenEventBatchingProcessor

AbstractListenEventBatchingProcessor.FlowFileEventBatch

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	CLIENT_AUTH
static PropertyDescriptor	SSL_CONTEXT_SERVICE

Fields inherited from class org.apache.nifi.processor.util.listen.AbstractListenEventBatchingProcessor

MAX_BATCH_SIZE, MESSAGE_DELIMITER, messageDemarcatorBytes

Fields inherited from class org.apache.nifi.processor.util.listen.AbstractListenEventProcessor

charset, CHARSET, descriptors, dispatcher, errorEvents, events, MAX_CONNECTIONS, MAX_MESSAGE_QUEUE_SIZE, MAX_SOCKET_BUFFER_SIZE, POLL_TIMEOUT_MS, port, PORT, RECV_BUFFER_SIZE, REL_SUCCESS, relationships

Constructor Summary

Constructors

Constructor and Description
ListenTCP()

Method Summary

Modifier and Type	Method and Description
protected ChannelDispatcher	createDispatcher(ProcessContext context, java.util.concurrent.BlockingQueue<StandardEvent> events)
protected java.util.Collection<ValidationResult>	customValidate(ValidationContext validationContext) Allows subclasses to perform their own validation on the already set properties.
protected java.util.List<PropertyDescriptor>	getAdditionalProperties() Override to provide additional properties for the processor.
protected java.util.Map<java.lang.String,java.lang.String>	getAttributes(AbstractListenEventBatchingProcessor.FlowFileEventBatch batch) Creates the attributes for the FlowFile of the given batch.
protected java.lang.String	getTransitUri(AbstractListenEventBatchingProcessor.FlowFileEventBatch batch) Creates the transit uri to be used when reporting a provenance receive event for the given batch.

Methods inherited from class org.apache.nifi.processor.util.listen.AbstractListenEventBatchingProcessor

getBatches, getBatchKey, init, onScheduled, onTrigger, postProcess

Methods inherited from class org.apache.nifi.processor.util.listen.AbstractListenEventProcessor

createBufferPool, getAdditionalRelationships, getDispatcherPort, getErrorQueueSize, getLongPollTimeout, getMessage, getQueueSize, getRelationships, getSupportedPropertyDescriptors, onUnscheduled

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

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

Field Detail

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

CLIENT_AUTH

public static final PropertyDescriptor CLIENT_AUTH

Constructor Detail

ListenTCP

public ListenTCP()

Method Detail

getAdditionalProperties

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

Description copied from class: AbstractListenEventProcessor

Override to provide additional properties for the processor.

Overrides:

getAdditionalProperties in class AbstractListenEventProcessor<StandardEvent>

Returns:

a list of properties

customValidate

protected java.util.Collection<ValidationResult> customValidate(ValidationContext validationContext)

Description copied from class: AbstractConfigurableComponent

Allows subclasses to perform their own validation on the already set properties. Since each property is validated as it is set this allows validation of groups of properties together. Default return is an empty set. This method will be called only when it has been determined that all property values are valid according to their corresponding PropertyDescriptor's validators.

Overrides:

customValidate in class AbstractConfigurableComponent

Parameters:

validationContext - provides a mechanism for obtaining externally managed values, such as property values and supplies convenience methods for operating on those values

Returns:

Collection of ValidationResult objects that will be added to any other validation findings - may be null

createDispatcher

protected ChannelDispatcher createDispatcher(ProcessContext context,
                                             java.util.concurrent.BlockingQueue<StandardEvent> events)
                                      throws java.io.IOException

Specified by:

createDispatcher in class AbstractListenEventProcessor<StandardEvent>

Parameters:

context - the ProcessContext to retrieve property values from

Returns:

a ChannelDispatcher to handle incoming connections

Throws:

java.io.IOException - if unable to listen on the requested port

getAttributes

protected java.util.Map<java.lang.String,java.lang.String> getAttributes(AbstractListenEventBatchingProcessor.FlowFileEventBatch batch)

Description copied from class: AbstractListenEventBatchingProcessor

Creates the attributes for the FlowFile of the given batch.

Specified by:

getAttributes in class AbstractListenEventBatchingProcessor<StandardEvent>

Parameters:

batch - the current batch

Returns:

the Map of FlowFile attributes

getTransitUri

protected java.lang.String getTransitUri(AbstractListenEventBatchingProcessor.FlowFileEventBatch batch)

Description copied from class: AbstractListenEventBatchingProcessor

Creates the transit uri to be used when reporting a provenance receive event for the given batch.

Specified by:

getTransitUri in class AbstractListenEventBatchingProcessor<StandardEvent>

Parameters:

batch - the current batch

Returns:

the transit uri string