Package org.apache.nifi.websocket

Interface WebSocketServerService

All Superinterfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.controller.ControllerService, WebSocketService
@CapabilityDescription("Control an embedded WebSocket server instance, so that external system can connect this NiFi via WebSocket protocol.") public interface WebSocketServerService extends WebSocketService
Control an embedded WebSocket server instance.

  • Field Summary

    Fields inherited from interface org.apache.nifi.websocket.WebSocketService

    SSL_CONTEXT

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    startServer(org.apache.nifi.controller.ConfigurationContext context)
     
    void
    stopServer()
     

    Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

    getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

    Methods inherited from interface org.apache.nifi.controller.ControllerService

    initialize, isStateful, migrateProperties

    Methods inherited from interface org.apache.nifi.websocket.WebSocketService

    deregisterProcessor, isProcessorRegistered, registerProcessor, sendMessage

  • Method Details

    • startServer

      @OnEnabled void startServer(org.apache.nifi.controller.ConfigurationContext context) throws Exception
      Throws:
      Exception

    • stopServer

      @OnDisabled @OnShutdown void stopServer() throws Exception
      Throws:
      Exception