org.apache.nifi.processors.standard

Class ListenUDP

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.ListenUDP

All Implemented Interfaces:

ConfigurableComponent, Processor

@SupportsBatching
 @Tags(value={"ingest","udp","listen","source"})
 @InputRequirement(value=INPUT_FORBIDDEN)
 @CapabilityDescription(value="Listens for Datagram Packets on a given port. The default behavior produces a FlowFile per datagram, however for higher throughput the Max Batch Size property may be increased to specify the number of datagrams to batch together in a single FlowFile. This processor can be restricted to listening for datagrams from  a specific remote host and port by specifying the Sending Host and Sending Host Port properties, otherwise it will listen for datagrams from all hosts and ports.")
 @WritesAttribute(attribute="udp.sender",description="The sending host of the messages.") @WritesAttribute(attribute="udp.port",description="The sending port the messages were received.")
public class ListenUDP
extends AbstractListenEventBatchingProcessor<StandardEvent>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListenUDP.HostValidator

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	SENDING_HOST
static PropertyDescriptor	SENDING_HOST_PORT
static String	UDP_PORT_ATTR
static String	UDP_SENDER_ATTR

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

messageDemarcatorBytes

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

charset, CHARSET, descriptors, dispatcher, errorEvents, events, 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
ListenUDP()

Method Summary

Modifier and Type	Method and Description
protected ChannelDispatcher	createDispatcher(ProcessContext context, BlockingQueue<StandardEvent> events)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
protected List<PropertyDescriptor>	getAdditionalProperties()
protected Map<String,String>	getAttributes(AbstractListenEventBatchingProcessor.FlowFileEventBatch batch)
protected String	getTransitUri(AbstractListenEventBatchingProcessor.FlowFileEventBatch 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

closeDispatcher, getAdditionalRelationships, getDispatcherPort, getErrorQueueSize, getListeningPort, getLongPollTimeout, getMessage, getQueueSize, getRelationships, getSupportedPropertyDescriptors

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

SENDING_HOST

public static final PropertyDescriptor SENDING_HOST

SENDING_HOST_PORT

public static final PropertyDescriptor SENDING_HOST_PORT

UDP_PORT_ATTR

public static final String UDP_PORT_ATTR

See Also:

Constant Field Values

UDP_SENDER_ATTR

public static final String UDP_SENDER_ATTR

See Also:

Constant Field Values

Constructor Detail

ListenUDP

public ListenUDP()

Method Detail

getAdditionalProperties

protected List<PropertyDescriptor> getAdditionalProperties()

Overrides:

getAdditionalProperties in class AbstractListenEventProcessor<StandardEvent>

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

createDispatcher

protected ChannelDispatcher createDispatcher(ProcessContext context,
                                             BlockingQueue<StandardEvent> events)
                                      throws IOException

Specified by:

createDispatcher in class AbstractListenEventProcessor<StandardEvent>

Throws:

IOException

getAttributes

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

Specified by:

getAttributes in class AbstractListenEventBatchingProcessor<StandardEvent>

getTransitUri

protected String getTransitUri(AbstractListenEventBatchingProcessor.FlowFileEventBatch batch)

Specified by:

getTransitUri in class AbstractListenEventBatchingProcessor<StandardEvent>