Package org.apache.nifi.processors.websocket

Class AbstractWebSocketGatewayProcessor

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processors.websocket.AbstractWebSocketGatewayProcessor

All Implemented Interfaces:

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

Direct Known Subclasses:

ConnectWebSocket, ListenWebSocket

@TriggerSerially
public abstract class AbstractWebSocketGatewayProcessor
extends org.apache.nifi.processor.AbstractSessionFactoryProcessor
implements ConnectedListener, TextMessageConsumer, BinaryMessageConsumer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractWebSocketGatewayProcessor.WebSocketFunction

Field Summary

Fields

Modifier and Type	Field	Description
protected String	endpointId
protected org.apache.nifi.logging.ComponentLog	logger
protected org.apache.nifi.processor.ProcessSessionFactory	processSessionFactory
static final org.apache.nifi.processor.Relationship	REL_CONNECTED
static final org.apache.nifi.processor.Relationship	REL_DISCONNECTED
static final org.apache.nifi.processor.Relationship	REL_FAILURE
static final org.apache.nifi.processor.Relationship	REL_MESSAGE_BINARY
static final org.apache.nifi.processor.Relationship	REL_MESSAGE_TEXT
static final org.apache.nifi.processor.Relationship	REL_SUCCESS
private static final Set<org.apache.nifi.processor.Relationship>	RELATIONSHIPS
protected WebSocketService	webSocketService

Constructor Summary

Constructors

Constructor	Description
AbstractWebSocketGatewayProcessor()

Method Summary

Modifier and Type	Method	Description
void	connected(WebSocketSessionInfo sessionInfo)
void	consume(WebSocketSessionInfo sessionInfo, byte[] payload, int offset, int length)
void	consume(WebSocketSessionInfo sessionInfo, String messageStr)
private void	deregister()
void	disconnected(WebSocketSessionInfo sessionInfo)
private void	enqueueMessage(WebSocketMessage incomingMessage)
(package private) static Set<org.apache.nifi.processor.Relationship>	getAbstractRelationships()
protected abstract String	getEndpointId(org.apache.nifi.processor.ProcessContext context)
protected abstract String	getTransitUri(WebSocketSessionInfo sessionInfo)
protected abstract WebSocketService	getWebSocketService(org.apache.nifi.processor.ProcessContext context)
protected void	init(org.apache.nifi.processor.ProcessorInitializationContext context)
protected boolean	isProcessorRegisteredToService()
void	onStopped(org.apache.nifi.processor.ProcessContext context)
final void	onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSessionFactory sessionFactory)
void	onWebSocketServiceReady(WebSocketService webSocketService, org.apache.nifi.processor.ProcessContext context)
private void	register(org.apache.nifi.processor.ProcessContext context)
protected void	registerProcessorToService(org.apache.nifi.processor.ProcessContext context, AbstractWebSocketGatewayProcessor.WebSocketFunction afterRegistration)

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

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getRelationships, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, getSupportedPropertyDescriptors, 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

logger

protected volatile org.apache.nifi.logging.ComponentLog logger

processSessionFactory

protected volatile org.apache.nifi.processor.ProcessSessionFactory processSessionFactory

webSocketService

protected WebSocketService webSocketService

endpointId

protected String endpointId

REL_CONNECTED

public static final org.apache.nifi.processor.Relationship REL_CONNECTED

REL_DISCONNECTED

public static final org.apache.nifi.processor.Relationship REL_DISCONNECTED

REL_MESSAGE_TEXT

public static final org.apache.nifi.processor.Relationship REL_MESSAGE_TEXT

REL_MESSAGE_BINARY

public static final org.apache.nifi.processor.Relationship REL_MESSAGE_BINARY

REL_SUCCESS

public static final org.apache.nifi.processor.Relationship REL_SUCCESS

REL_FAILURE

public static final org.apache.nifi.processor.Relationship REL_FAILURE

RELATIONSHIPS

private static final Set<org.apache.nifi.processor.Relationship> RELATIONSHIPS

Constructor Details

AbstractWebSocketGatewayProcessor

public AbstractWebSocketGatewayProcessor()

Method Details

getAbstractRelationships

static Set<org.apache.nifi.processor.Relationship> getAbstractRelationships()

init

protected void init(org.apache.nifi.processor.ProcessorInitializationContext context)

Overrides:

init in class org.apache.nifi.processor.AbstractSessionFactoryProcessor

connected

public void connected(WebSocketSessionInfo sessionInfo)

Specified by:

connected in interface ConnectedListener

disconnected

public void disconnected(WebSocketSessionInfo sessionInfo)

Specified by:

disconnected in interface ConnectedListener

consume

public void consume(WebSocketSessionInfo sessionInfo,
 String messageStr)

Specified by:

consume in interface TextMessageConsumer

consume

public void consume(WebSocketSessionInfo sessionInfo,
 byte[] payload,
 int offset,
 int length)

Specified by:

consume in interface BinaryMessageConsumer

onWebSocketServiceReady

public void onWebSocketServiceReady(WebSocketService webSocketService,
 org.apache.nifi.processor.ProcessContext context)
                             throws IOException

Throws:

IOException

registerProcessorToService

protected void registerProcessorToService(org.apache.nifi.processor.ProcessContext context,
 AbstractWebSocketGatewayProcessor.WebSocketFunction afterRegistration)
                                   throws IOException,
WebSocketConfigurationException

Throws:

IOException

WebSocketConfigurationException

getWebSocketService

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

getEndpointId

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

isProcessorRegisteredToService

protected boolean isProcessorRegisteredToService()

onStopped

@OnStopped
public void onStopped(org.apache.nifi.processor.ProcessContext context)

deregister

private void deregister()

onTrigger

public final void onTrigger(org.apache.nifi.processor.ProcessContext context,
 org.apache.nifi.processor.ProcessSessionFactory sessionFactory)

Specified by:

onTrigger in interface org.apache.nifi.processor.Processor

register

private void register(org.apache.nifi.processor.ProcessContext context)

enqueueMessage

private void enqueueMessage(WebSocketMessage incomingMessage)

getTransitUri

protected abstract String getTransitUri(WebSocketSessionInfo sessionInfo)