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.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. The processor can be configured to use an SSL Context Service to only allow secure connections. When connected clients present certificates for mutual TLS authentication, the Distinguished Names of the client certificate\'s issuer and subject are added to the outgoing FlowFiles as attributes. The processor does not perform authorization based on Distinguished Name values, but since these values are attached to the outgoing FlowFiles, authorization can be implemented based on these attributes.")
 @WritesAttribute(attribute="tcp.sender",description="The sending host of the messages.") @WritesAttribute(attribute="tcp.port",description="The sending port the messages were received.") @WritesAttribute(attribute="client.certificate.issuer.dn",description="For connections using mutual TLS, the Distinguished Name of the Certificate Authority that issued the client\'s certificate is attached to the FlowFile.") @WritesAttribute(attribute="client.certificate.subject.dn",description="For connections using mutual TLS, the Distinguished Name of the client certificate\'s owner (subject) is attached to the FlowFile.")
public class ListenTCP
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	CLIENT_AUTH
private static String	CLIENT_CERTIFICATE_ISSUER_DN_ATTRIBUTE
private static String	CLIENT_CERTIFICATE_SUBJECT_DN_ATTRIBUTE
protected List<PropertyDescriptor>	descriptors
protected BlockingQueue<ByteArrayMessage>	errorEvents
protected EventBatcher<ByteArrayMessage>	eventBatcher
protected TrackingLinkedBlockingQueue<ByteArrayMessage>	events
private int	eventsCapacity
protected EventServer	eventServer
protected static PropertyDescriptor	IDLE_CONNECTION_TIMEOUT
static PropertyDescriptor	MAX_RECV_THREAD_POOL_SIZE
protected byte[]	messageDemarcatorBytes
private AtomicLong	nextTrackingLog
protected static PropertyDescriptor	POOL_RECV_BUFFERS
protected int	port
static Relationship	REL_SUCCESS
protected Set<Relationship>	relationships
static PropertyDescriptor	SSL_CONTEXT_SERVICE
private static long	TRACKING_LOG_INTERVAL

Constructor Summary

Constructors

Constructor and Description
ListenTCP()

Method Summary

Modifier and Type	Method and Description
private void	addClientCertificateAttributes(Map<String,String> attributes, ByteArrayMessage event)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
protected Map<String,String>	getAttributes(FlowFileEventBatch<ByteArrayMessage> batch)
private EventBatcher<ByteArrayMessage>	getEventBatcher()
int	getListeningPort()
private String	getMessageDemarcator(ProcessContext context)
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected String	getTransitUri(FlowFileEventBatch<ByteArrayMessage> batch)
protected void	init(ProcessorInitializationContext context)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
private void	processEvents(ProcessSession session, Map<String,FlowFileEventBatch<ByteArrayMessage>> batches)
private void	processTrackingLog()
void	stopped()

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

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

CLIENT_CERTIFICATE_SUBJECT_DN_ATTRIBUTE

private static final String CLIENT_CERTIFICATE_SUBJECT_DN_ATTRIBUTE

See Also:

Constant Field Values

CLIENT_CERTIFICATE_ISSUER_DN_ATTRIBUTE

private static final String CLIENT_CERTIFICATE_ISSUER_DN_ATTRIBUTE

See Also:

Constant Field Values

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

CLIENT_AUTH

public static final PropertyDescriptor CLIENT_AUTH

MAX_RECV_THREAD_POOL_SIZE

public static final PropertyDescriptor MAX_RECV_THREAD_POOL_SIZE

POOL_RECV_BUFFERS

protected static final PropertyDescriptor POOL_RECV_BUFFERS

IDLE_CONNECTION_TIMEOUT

protected static final PropertyDescriptor IDLE_CONNECTION_TIMEOUT

REL_SUCCESS

public static final Relationship REL_SUCCESS

TRACKING_LOG_INTERVAL

private static final long TRACKING_LOG_INTERVAL

See Also:

Constant Field Values

nextTrackingLog

private final AtomicLong nextTrackingLog

eventsCapacity

private int eventsCapacity

descriptors

protected List<PropertyDescriptor> descriptors

relationships

protected Set<Relationship> relationships

port

protected volatile int port

events

protected volatile TrackingLinkedBlockingQueue<ByteArrayMessage> events

errorEvents

protected volatile BlockingQueue<ByteArrayMessage> errorEvents

eventServer

protected volatile EventServer eventServer

messageDemarcatorBytes

protected volatile byte[] messageDemarcatorBytes

eventBatcher

protected volatile EventBatcher<ByteArrayMessage> eventBatcher

Constructor Detail

ListenTCP

public ListenTCP()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws IOException

Throws:

IOException

getListeningPort

public int getListeningPort()

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

processEvents

private void processEvents(ProcessSession session,
                           Map<String,FlowFileEventBatch<ByteArrayMessage>> batches)

stopped

@OnStopped
public void stopped()

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

getAttributes

protected Map<String,String> getAttributes(FlowFileEventBatch<ByteArrayMessage> batch)

getTransitUri

protected String getTransitUri(FlowFileEventBatch<ByteArrayMessage> batch)

getRelationships

public final Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

public List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getMessageDemarcator

private String getMessageDemarcator(ProcessContext context)

getEventBatcher

private EventBatcher<ByteArrayMessage> getEventBatcher()

addClientCertificateAttributes

private void addClientCertificateAttributes(Map<String,String> attributes,
                                            ByteArrayMessage event)

processTrackingLog

private void processTrackingLog()