Package 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:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor
@InputRequirement(INPUT_REQUIRED) @TriggerWhenEmpty @Tags({"syslog","put","udp","tcp","logs"}) @CapabilityDescription("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.S\'Z\'\" 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({ListenSyslog.class,ParseSyslog.class}) public class PutSyslog extends AbstractSyslogProcessor

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.nifi.components.PropertyDescriptor
    BATCH_SIZE
     
    private EventSender<String>
    eventSender
     
    static final org.apache.nifi.components.PropertyDescriptor
    HOSTNAME
     
    static final org.apache.nifi.components.PropertyDescriptor
    IDLE_EXPIRATION
     
    static final org.apache.nifi.components.PropertyDescriptor
    MAX_SOCKET_SEND_BUFFER_SIZE
     
    static final org.apache.nifi.components.PropertyDescriptor
    MSG_BODY
     
    static final org.apache.nifi.components.PropertyDescriptor
    MSG_HOSTNAME
     
    static final org.apache.nifi.components.PropertyDescriptor
    MSG_PRIORITY
     
    static final org.apache.nifi.components.PropertyDescriptor
    MSG_TIMESTAMP
     
    static final org.apache.nifi.components.PropertyDescriptor
    MSG_VERSION
     
    private static final List<org.apache.nifi.components.PropertyDescriptor>
    PROPERTY_DESCRIPTORS
     
    static final org.apache.nifi.processor.Relationship
    REL_FAILURE
     
    static final org.apache.nifi.processor.Relationship
    REL_INVALID
     
    static final org.apache.nifi.processor.Relationship
    REL_SUCCESS
     
    private static final Set<org.apache.nifi.processor.Relationship>
    RELATIONSHIPS
     
    static final org.apache.nifi.components.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
    Description
    PutSyslog()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Collection<org.apache.nifi.components.ValidationResult>
    customValidate(org.apache.nifi.components.ValidationContext context)
     
    protected EventSender<String>
    getEventSender(org.apache.nifi.processor.ProcessContext context)
     
    Set<org.apache.nifi.processor.Relationship>
    getRelationships()
     
    final List<org.apache.nifi.components.PropertyDescriptor>
    getSupportedPropertyDescriptors()
     
    private String
    getSyslogMessage(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.flowfile.FlowFile flowFile)
     
    private boolean
    isValid(String message)
     
    void
    onScheduled(org.apache.nifi.processor.ProcessContext context)
     
    void
    onStopped()
     
    void
    onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.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, init, 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

    Methods inherited from interface org.apache.nifi.processor.Processor

    isStateful, migrateProperties, migrateRelationships

  • Field Details

    • HOSTNAME

      public static final org.apache.nifi.components.PropertyDescriptor HOSTNAME

    • MAX_SOCKET_SEND_BUFFER_SIZE

      public static final org.apache.nifi.components.PropertyDescriptor MAX_SOCKET_SEND_BUFFER_SIZE

    • BATCH_SIZE

      public static final org.apache.nifi.components.PropertyDescriptor BATCH_SIZE

    • IDLE_EXPIRATION

      public static final org.apache.nifi.components.PropertyDescriptor IDLE_EXPIRATION

    • MSG_PRIORITY

      public static final org.apache.nifi.components.PropertyDescriptor MSG_PRIORITY

    • MSG_VERSION

      public static final org.apache.nifi.components.PropertyDescriptor MSG_VERSION

    • MSG_TIMESTAMP

      public static final org.apache.nifi.components.PropertyDescriptor MSG_TIMESTAMP

    • MSG_HOSTNAME

      public static final org.apache.nifi.components.PropertyDescriptor MSG_HOSTNAME

    • MSG_BODY

      public static final org.apache.nifi.components.PropertyDescriptor MSG_BODY

    • SSL_CONTEXT_SERVICE

      public static final org.apache.nifi.components.PropertyDescriptor SSL_CONTEXT_SERVICE

    • PROPERTY_DESCRIPTORS

      private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTY_DESCRIPTORS

    • REL_SUCCESS

      public static final org.apache.nifi.processor.Relationship REL_SUCCESS

    • REL_FAILURE

      public static final org.apache.nifi.processor.Relationship REL_FAILURE

    • REL_INVALID

      public static final org.apache.nifi.processor.Relationship REL_INVALID

    • RELATIONSHIPS

      private static final Set<org.apache.nifi.processor.Relationship> RELATIONSHIPS

    • eventSender

      private EventSender<String> eventSender

    • transitUri

      private String transitUri

  • Constructor Details

    • PutSyslog

      public PutSyslog()

  • Method Details

    • getRelationships

      public Set<org.apache.nifi.processor.Relationship> getRelationships()
      Specified by:
      getRelationships in interface org.apache.nifi.processor.Processor
      Overrides:
      getRelationships in class org.apache.nifi.processor.AbstractSessionFactoryProcessor

    • getSupportedPropertyDescriptors

      public final List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()
      Overrides:
      getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

    • customValidate

      protected Collection<org.apache.nifi.components.ValidationResult> customValidate(org.apache.nifi.components.ValidationContext context)
      Overrides:
      customValidate in class org.apache.nifi.components.AbstractConfigurableComponent

    • onScheduled

      @OnScheduled public void onScheduled(org.apache.nifi.processor.ProcessContext context) throws InterruptedException
      Throws:
      InterruptedException

    • onStopped

      @OnStopped public void onStopped() throws Exception
      Throws:
      Exception

    • onTrigger

      public void onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session) throws org.apache.nifi.processor.exception.ProcessException
      Specified by:
      onTrigger in class org.apache.nifi.processor.AbstractProcessor
      Throws:
      org.apache.nifi.processor.exception.ProcessException

    • getEventSender

      protected EventSender<String> getEventSender(org.apache.nifi.processor.ProcessContext context)

    • getSyslogMessage

      private String getSyslogMessage(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.flowfile.FlowFile flowFile)

    • isValid

      private boolean isValid(String message)