Package org.apache.nifi.processors.websocket

Class PutWebSocket

java.lang.Object
org.apache.nifi.components.AbstractConfigurableComponent
org.apache.nifi.processor.AbstractSessionFactoryProcessor
org.apache.nifi.processor.AbstractProcessor
org.apache.nifi.processors.websocket.PutWebSocket
All Implemented Interfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor
@Tags({"WebSocket","publish","send"}) @InputRequirement(INPUT_REQUIRED) @TriggerSerially @CapabilityDescription("Sends messages to a WebSocket remote endpoint using a WebSocket session that is established by either ListenWebSocket or ConnectWebSocket.") @WritesAttribute(attribute="websocket.controller.service.id",description="WebSocket Controller Service id.") @WritesAttribute(attribute="websocket.session.id",description="Established WebSocket session id.") @WritesAttribute(attribute="websocket.endpoint.id",description="WebSocket endpoint id.") @WritesAttribute(attribute="websocket.message.type",description="TEXT or BINARY.") @WritesAttribute(attribute="websocket.local.address",description="WebSocket server address.") @WritesAttribute(attribute="websocket.remote.address",description="WebSocket client address.") @WritesAttribute(attribute="websocket.failure.detail",description="Detail of the failure.") @SystemResourceConsideration(resource=MEMORY) public class PutWebSocket extends org.apache.nifi.processor.AbstractProcessor

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.nifi.components.PropertyDescriptor
    PROP_WS_CONTROLLER_SERVICE_ENDPOINT
     
    static final org.apache.nifi.components.PropertyDescriptor
    PROP_WS_CONTROLLER_SERVICE_ID
     
    static final org.apache.nifi.components.PropertyDescriptor
    PROP_WS_MESSAGE_TYPE
     
    static final org.apache.nifi.components.PropertyDescriptor
    PROP_WS_SESSION_ID
     
    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_SUCCESS
     
    private static final Set<org.apache.nifi.processor.Relationship>
    RELATIONSHIPS
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    PutWebSocket()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<org.apache.nifi.processor.Relationship>
    getRelationships()
     
    final List<org.apache.nifi.components.PropertyDescriptor>
    getSupportedPropertyDescriptors()
     
    void
    onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession processSession)
     
    private void
    transferToFailure(org.apache.nifi.processor.ProcessSession processSession, org.apache.nifi.flowfile.FlowFile flowfile, String value)
     

    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

    customValidate, 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

    • PROP_WS_SESSION_ID

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

    • PROP_WS_CONTROLLER_SERVICE_ID

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

    • PROP_WS_CONTROLLER_SERVICE_ENDPOINT

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

    • PROP_WS_MESSAGE_TYPE

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

    • REL_SUCCESS

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

    • REL_FAILURE

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

    • PROPERTY_DESCRIPTORS

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

    • RELATIONSHIPS

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

  • Constructor Details

    • PutWebSocket

      public PutWebSocket()

  • 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

    • onTrigger

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

    • transferToFailure

      private void transferToFailure(org.apache.nifi.processor.ProcessSession processSession, org.apache.nifi.flowfile.FlowFile flowfile, String value)