org.apache.nifi.processors.standard

Class ListenRELP

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ListenRELP

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"listen","relp","tcp","logs"})
 @CapabilityDescription(value="Listens for RELP messages being sent to a given port over TCP. Each message will be acknowledged after successfully writing the message to a FlowFile. Each FlowFile will contain data portion of one or more RELP frames. In the case where the RELP frames contain syslog messages, the output of this processor can be sent to a ParseSyslog processor for further processing.")
 @WritesAttribute(attribute="relp.command",description="The command of the RELP frames.") @WritesAttribute(attribute="relp.sender",description="The sending host of the messages.") @WritesAttribute(attribute="relp.port",description="The sending port the messages were received over.") @WritesAttribute(attribute="relp.txnr",description="The transaction number of the message. Only included if <Batch Size> is 1.") @WritesAttribute(attribute="mime.type",description="The mime.type of the content which is text/plain")
 @SeeAlso(value=ParseSyslog.class)
public class ListenRELP
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListenRELP.RELPAttributes

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	CLIENT_AUTH
protected List<PropertyDescriptor>	descriptors
protected BlockingQueue<RELPMessage>	errorEvents
protected EventBatcher	eventBatcher
protected BlockingQueue<RELPMessage>	events
protected EventServer	eventServer
protected byte[]	messageDemarcatorBytes
protected int	port
static Relationship	REL_SUCCESS
protected Set<Relationship>	relationships
static PropertyDescriptor	SSL_CONTEXT_SERVICE

Constructor Summary

Constructors

Constructor and Description
ListenRELP()

Method Summary

Modifier and Type	Method and Description
private void	configureFactoryForSsl(ProcessContext context, NettyEventServerFactory eventFactory)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
protected Map<String,String>	getAttributes(FlowFileEventBatch batch)
private EventBatcher	getEventBatcher()
int	getListeningPort()
private String	getMessageDemarcator(ProcessContext context)
private NettyEventServerFactory	getNettyEventServerFactory(InetAddress hostname, int port, Charset charset, BlockingQueue events)
Set<Relationship>	getRelationships()
private String	getRELPBatchKey(RELPMessage event)
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected String	getTransitUri(FlowFileEventBatch batch)
protected void	init(ProcessorInitializationContext context)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
private void	processEvents(ProcessSession session, Map<String,FlowFileEventBatch> batches)
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

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

CLIENT_AUTH

public static final PropertyDescriptor CLIENT_AUTH

REL_SUCCESS

public static final Relationship REL_SUCCESS

descriptors

protected List<PropertyDescriptor> descriptors

relationships

protected Set<Relationship> relationships

port

protected volatile int port

events

protected volatile BlockingQueue<RELPMessage> events

errorEvents

protected volatile BlockingQueue<RELPMessage> errorEvents

eventServer

protected volatile EventServer eventServer

messageDemarcatorBytes

protected volatile byte[] messageDemarcatorBytes

eventBatcher

protected volatile EventBatcher eventBatcher

Constructor Detail

ListenRELP

public ListenRELP()

Method Detail

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws IOException

Throws:

IOException

getListeningPort

public int getListeningPort()

stopped

@OnStopped
public void stopped()

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

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

configureFactoryForSsl

private void configureFactoryForSsl(ProcessContext context,
                                    NettyEventServerFactory eventFactory)

getAttributes

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

getTransitUri

protected String getTransitUri(FlowFileEventBatch batch)

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> batches)

getRELPBatchKey

private String getRELPBatchKey(RELPMessage event)

getEventBatcher

private EventBatcher getEventBatcher()

getNettyEventServerFactory

private NettyEventServerFactory getNettyEventServerFactory(InetAddress hostname,
                                                           int port,
                                                           Charset charset,
                                                           BlockingQueue events)

getMessageDemarcator

private String getMessageDemarcator(ProcessContext context)