org.apache.nifi.websocket

Interface WebSocketClientService

All Superinterfaces:

ConfigurableComponent, ControllerService, WebSocketService

All Known Implementing Classes:

JettyWebSocketClient

@CapabilityDescription(value="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 and Description
void	connect(java.lang.String clientId)
java.lang.String	getTargetUri()
void	startClient(ConfigurationContext context)
void	stopClient()

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

deregisterProcessor, isProcessorRegistered, registerProcessor, sendMessage

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

initialize

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Method Detail

startClient

void startClient(ConfigurationContext context)
          throws java.lang.Exception

Throws:

java.lang.Exception

stopClient

void stopClient()
         throws java.lang.Exception

Throws:

java.lang.Exception

connect

void connect(java.lang.String clientId)
      throws java.io.IOException

Throws:

java.io.IOException

getTargetUri

java.lang.String getTargetUri()