Package org.apache.nifi.processors.websocket

Class ListenWebSocket

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processors.websocket.AbstractWebSocketGatewayProcessor

org.apache.nifi.processors.websocket.ListenWebSocket

All Implemented Interfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor, BinaryMessageConsumer, ConnectedListener, TextMessageConsumer

@Tags({"subscribe","WebSocket","consume","listen"})
@InputRequirement(INPUT_FORBIDDEN)
@TriggerSerially
@CapabilityDescription("Acts as a WebSocket server endpoint to accept client connections. FlowFiles are transferred to downstream relationships according to received message types as the WebSocket server configured with this processor receives client requests")
@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.local.address",description="WebSocket server address.") @WritesAttribute(attribute="websocket.remote.address",description="WebSocket client address.") @WritesAttribute(attribute="websocket.message.type",description="TEXT or BINARY.")
public class ListenWebSocket
extends AbstractWebSocketGatewayProcessor

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.nifi.processors.websocket.AbstractWebSocketGatewayProcessor

AbstractWebSocketGatewayProcessor.WebSocketFunction

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.nifi.components.PropertyDescriptor	PROP_SERVER_URL_PATH
static final org.apache.nifi.components.PropertyDescriptor	PROP_WEBSOCKET_SERVER_SERVICE
private static final List<org.apache.nifi.components.PropertyDescriptor>	PROPERTY_DESCRIPTORS
private static final Set<org.apache.nifi.processor.Relationship>	RELATIONSHIPS

Fields inherited from class org.apache.nifi.processors.websocket.AbstractWebSocketGatewayProcessor

endpointId, logger, processSessionFactory, REL_CONNECTED, REL_DISCONNECTED, REL_FAILURE, REL_MESSAGE_BINARY, REL_MESSAGE_TEXT, REL_SUCCESS, webSocketService

Constructor Summary

Constructors

Constructor	Description
ListenWebSocket()

Method Summary

Modifier and Type	Method	Description
protected String	getEndpointId(org.apache.nifi.processor.ProcessContext context)
Set<org.apache.nifi.processor.Relationship>	getRelationships()
final List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()
protected String	getTransitUri(WebSocketSessionInfo sessionInfo)
protected WebSocketService	getWebSocketService(org.apache.nifi.processor.ProcessContext context)

Methods inherited from class org.apache.nifi.processors.websocket.AbstractWebSocketGatewayProcessor

connected, consume, consume, disconnected, getAbstractRelationships, init, isProcessorRegisteredToService, onStopped, onTrigger, onWebSocketServiceReady, registerProcessorToService

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, 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_WEBSOCKET_SERVER_SERVICE

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

PROP_SERVER_URL_PATH

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

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

ListenWebSocket

public ListenWebSocket()

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

getWebSocketService

protected WebSocketService getWebSocketService(org.apache.nifi.processor.ProcessContext context)

Specified by:

getWebSocketService in class AbstractWebSocketGatewayProcessor

getEndpointId

protected String getEndpointId(org.apache.nifi.processor.ProcessContext context)

Specified by:

getEndpointId in class AbstractWebSocketGatewayProcessor

getTransitUri

protected String getTransitUri(WebSocketSessionInfo sessionInfo)

Specified by:

getTransitUri in class AbstractWebSocketGatewayProcessor