org.apache.nifi.processors.standard

Class ListenUDPRecord

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<StandardEvent>

org.apache.nifi.processors.standard.ListenUDPRecord

All Implemented Interfaces:

ConfigurableComponent, Processor

@SupportsBatching
 @Tags(value={"ingest","udp","listen","source","record"})
 @InputRequirement(value=INPUT_FORBIDDEN)
 @CapabilityDescription(value="Listens for Datagram Packets on a given port and reads the content of each datagram using the configured Record Reader. Each record will then be written to a flow file using the configured Record Writer. 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.") @WritesAttribute(attribute="record.count",description="The number of records written to the flow file.") @WritesAttribute(attribute="mime.type",description="The mime-type of the writer used to write the records to the flow file.")
public class ListenUDPRecord
extends AbstractListenEventProcessor<StandardEvent>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ListenUDPRecord.FlowFileRecordWriter Holder class to pass around a flow file and the writer that is writing records to it.
private static class	ListenUDPRecord.HostValidator

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	BATCH_SIZE
static PropertyDescriptor	POLL_TIMEOUT
private long	pollTimeout
static String	RECORD_COUNT_ATTR
static PropertyDescriptor	RECORD_READER
static PropertyDescriptor	RECORD_WRITER
static Relationship	REL_PARSE_FAILURE
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.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
ListenUDPRecord()

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 List<Relationship>	getAdditionalRelationships()
private Map<String,String>	getAttributes(String sender)
protected long	getLongPollTimeout()
private String	getTransitUri(String sender)
private void	handleParseFailure(StandardEvent event, ProcessSession session, Exception cause)
private void	handleParseFailure(StandardEvent event, ProcessSession session, Exception cause, String message)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)

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

closeDispatcher, getDispatcherPort, getErrorQueueSize, getListeningPort, getMessage, getQueueSize, getRelationships, getSupportedPropertyDescriptors, init

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

RECORD_READER

public static final PropertyDescriptor RECORD_READER

RECORD_WRITER

public static final PropertyDescriptor RECORD_WRITER

POLL_TIMEOUT

public static final PropertyDescriptor POLL_TIMEOUT

BATCH_SIZE

public static final PropertyDescriptor BATCH_SIZE

REL_PARSE_FAILURE

public static final Relationship REL_PARSE_FAILURE

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

RECORD_COUNT_ATTR

public static final String RECORD_COUNT_ATTR

See Also:

Constant Field Values

pollTimeout

private volatile long pollTimeout

Constructor Detail

ListenUDPRecord

public ListenUDPRecord()

Method Detail

getAdditionalProperties

protected List<PropertyDescriptor> getAdditionalProperties()

Overrides:

getAdditionalProperties in class AbstractListenEventProcessor<StandardEvent>

getAdditionalRelationships

protected List<Relationship> getAdditionalRelationships()

Overrides:

getAdditionalRelationships in class AbstractListenEventProcessor<StandardEvent>

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws IOException

Overrides:

onScheduled in class AbstractListenEventProcessor<StandardEvent>

Throws:

IOException

getLongPollTimeout

protected long getLongPollTimeout()

Overrides:

getLongPollTimeout 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

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

handleParseFailure

private void handleParseFailure(StandardEvent event,
                                ProcessSession session,
                                Exception cause)

handleParseFailure

private void handleParseFailure(StandardEvent event,
                                ProcessSession session,
                                Exception cause,
                                String message)

getAttributes

private Map<String,String> getAttributes(String sender)

getTransitUri

private String getTransitUri(String sender)