Package org.apache.nifi.websocket

Interface WebSocketClientService

All Superinterfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.controller.ControllerService, WebSocketService

@CapabilityDescription("Control a WebSocket client instance, so that NiFi can connect with external systems via WebSocket protocol.")
public interface WebSocketClientService
extends WebSocketService

Control a WebSocket client instance.

Field Summary

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

SSL_CONTEXT

Method Summary

Modifier and Type	Method	Description
void	connect(String clientId)
default void	connect(String clientId, Map<String,String> flowFileAttributes)
String	getTargetUri()
void	startClient(org.apache.nifi.controller.ConfigurationContext context)
void	stopClient()

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

startClient

void startClient(org.apache.nifi.controller.ConfigurationContext context)
          throws Exception

Throws:

Exception

stopClient

void stopClient()
         throws Exception

Throws:

Exception

connect

void connect(String clientId)
      throws IOException

Throws:

IOException

connect

default void connect(String clientId,
 Map<String,String> flowFileAttributes)
              throws IOException

Throws:

IOException

getTargetUri

String getTargetUri()