Package org.apache.nifi.websocket

Interface WebSocketService

All Superinterfaces:

ConfigurableComponent, ControllerService

All Known Subinterfaces:

WebSocketClientService, WebSocketServerService

All Known Implementing Classes:

AbstractWebSocketService

public interface WebSocketService
extends ControllerService

Control an embedded WebSocket service instance.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyDescriptor	SSL_CONTEXT

Method Summary

Modifier and Type	Method	Description
void	deregisterProcessor(String endpointId, Processor processor)
boolean	isProcessorRegistered(String endpointId, Processor processor)
void	registerProcessor(String endpointId, Processor processor)
void	sendMessage(String endpointId, String sessionId, SendMessage sendMessage)

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

Field Details

SSL_CONTEXT

static final PropertyDescriptor SSL_CONTEXT

Method Details

registerProcessor

void registerProcessor(String endpointId,
 Processor processor)
                throws WebSocketConfigurationException

Throws:

WebSocketConfigurationException

isProcessorRegistered

boolean isProcessorRegistered(String endpointId,
 Processor processor)

deregisterProcessor

void deregisterProcessor(String endpointId,
 Processor processor)
                  throws WebSocketConfigurationException

Throws:

WebSocketConfigurationException

sendMessage

void sendMessage(String endpointId,
 String sessionId,
 SendMessage sendMessage)
          throws IOException,
WebSocketConfigurationException

Throws:

IOException

WebSocketConfigurationException