org.apache.nifi.processors.standard

Class PutSyslog

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.AbstractSyslogProcessor

org.apache.nifi.processors.standard.PutSyslog

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_REQUIRED)
 @TriggerWhenEmpty
 @Tags(value={"syslog","put","udp","tcp","logs"})
 @CapabilityDescription(value="Sends Syslog messages to a given host and port over TCP or UDP. Messages are constructed from the \"Message ___\" properties of the processor which can use expression language to generate messages from incoming FlowFiles. The properties are used to construct messages of the form: (<PRIORITY>)(VERSION )(TIMESTAMP) (HOSTNAME) (BODY) where version is optional.  The constructed messages are checked against regular expressions for RFC5424 and RFC3164 formatted messages. The timestamp can be an RFC5424 timestamp with a format of \"yyyy-MM-dd\'T\'HH:mm:ss.SZ\" or \"yyyy-MM-dd\'T\'HH:mm:ss.S+hh:mm\", or it can be an RFC3164 timestamp with a format of \"MMM d HH:mm:ss\". If a message is constructed that does not form a valid Syslog message according to the above description, then it is routed to the invalid relationship. Valid messages are sent to the Syslog server and successes are routed to the success relationship, failures routed to the failure relationship.")
 @SeeAlso(value={ListenSyslog.class,ParseSyslog.class})
public class PutSyslog
extends AbstractSyslogProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	BATCH_SIZE
private List<PropertyDescriptor>	descriptors
private EventSender<String>	eventSender
static PropertyDescriptor	HOSTNAME
static PropertyDescriptor	IDLE_EXPIRATION
static PropertyDescriptor	MAX_SOCKET_SEND_BUFFER_SIZE
static PropertyDescriptor	MSG_BODY
static PropertyDescriptor	MSG_HOSTNAME
static PropertyDescriptor	MSG_PRIORITY
static PropertyDescriptor	MSG_TIMESTAMP
static PropertyDescriptor	MSG_VERSION
static Relationship	REL_FAILURE
static Relationship	REL_INVALID
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static PropertyDescriptor	SSL_CONTEXT_SERVICE
private String	transitUri

Fields inherited from class org.apache.nifi.processors.standard.AbstractSyslogProcessor

CHARSET, PORT, PROTOCOL, TCP_VALUE, TIMEOUT, UDP_VALUE

Constructor Summary

Constructors

Constructor and Description
PutSyslog()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext context)
protected EventSender<String>	getEventSender(ProcessContext context)
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private String	getSyslogMessage(ProcessContext context, FlowFile flowFile)
protected void	init(ProcessorInitializationContext context)
private boolean	isValid(String message)
void	onScheduled(ProcessContext context)
void	onStopped()
void	onTrigger(ProcessContext context, ProcessSession session)

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

HOSTNAME

public static final PropertyDescriptor HOSTNAME

MAX_SOCKET_SEND_BUFFER_SIZE

public static final PropertyDescriptor MAX_SOCKET_SEND_BUFFER_SIZE

BATCH_SIZE

public static final PropertyDescriptor BATCH_SIZE

IDLE_EXPIRATION

public static final PropertyDescriptor IDLE_EXPIRATION

MSG_PRIORITY

public static final PropertyDescriptor MSG_PRIORITY

MSG_VERSION

public static final PropertyDescriptor MSG_VERSION

MSG_TIMESTAMP

public static final PropertyDescriptor MSG_TIMESTAMP

MSG_HOSTNAME

public static final PropertyDescriptor MSG_HOSTNAME

MSG_BODY

public static final PropertyDescriptor MSG_BODY

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

REL_INVALID

public static final Relationship REL_INVALID

relationships

private Set<Relationship> relationships

descriptors

private List<PropertyDescriptor> descriptors

eventSender

private EventSender<String> eventSender

transitUri

private String transitUri

Constructor Detail

PutSyslog

public PutSyslog()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Overrides:

customValidate in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws InterruptedException

Throws:

InterruptedException

onStopped

@OnStopped
public void onStopped()
                          throws Exception

Throws:

Exception

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

getEventSender

protected EventSender<String> getEventSender(ProcessContext context)

getSyslogMessage

private String getSyslogMessage(ProcessContext context,
                                FlowFile flowFile)

isValid

private boolean isValid(String message)