org.apache.nifi.websocket.jetty

Class JettyWebSocketServer

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.websocket.AbstractWebSocketService

org.apache.nifi.websocket.jetty.AbstractJettyWebSocketService

org.apache.nifi.websocket.jetty.JettyWebSocketServer

All Implemented Interfaces:

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

@Tags(value={"WebSocket","Jetty","server"})
 @CapabilityDescription(value="Implementation of WebSocketServerService. This service uses Jetty WebSocket server module to provide WebSocket session management throughout the application.")
public class JettyWebSocketServer
extends AbstractJettyWebSocketService
implements WebSocketServerService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JettyWebSocketServer.JettyWebSocketServlet

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.nifi.components.PropertyDescriptor	AUTH_PATH_SPEC
static org.apache.nifi.components.PropertyDescriptor	AUTH_ROLES
static org.apache.nifi.components.PropertyDescriptor	BASIC_AUTH
static org.apache.nifi.components.PropertyDescriptor	CLIENT_AUTH
static org.apache.nifi.components.AllowableValue	CLIENT_NEED
static org.apache.nifi.components.AllowableValue	CLIENT_NONE
static org.apache.nifi.components.AllowableValue	CLIENT_WANT
private org.eclipse.jetty.websocket.api.WebSocketPolicy	configuredPolicy
static org.apache.nifi.components.PropertyDescriptor	LISTEN_PORT
private Integer	listenPort
static org.apache.nifi.components.PropertyDescriptor	LOGIN_SERVICE
static org.apache.nifi.components.AllowableValue	LOGIN_SERVICE_HASH
private static Map<Integer,JettyWebSocketServer>	portToControllerService A global map to refer a controller service instance by requested port number.
private static List<org.apache.nifi.components.PropertyDescriptor>	properties
private org.eclipse.jetty.server.Server	server
private org.eclipse.jetty.servlet.ServletHandler	servletHandler
static org.apache.nifi.components.PropertyDescriptor	USERS_PROPERTIES_FILE

Fields inherited from class org.apache.nifi.websocket.jetty.AbstractJettyWebSocketService

INPUT_BUFFER_SIZE, MAX_BINARY_MESSAGE_SIZE, MAX_TEXT_MESSAGE_SIZE

Fields inherited from class org.apache.nifi.websocket.AbstractWebSocketService

routers

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

SSL_CONTEXT

Constructor Summary

Constructors

Constructor and Description
JettyWebSocketServer()

Method Summary

Modifier and Type	Method and Description
private org.eclipse.jetty.server.ServerConnector	createConnector(org.eclipse.jetty.util.ssl.SslContextFactory sslContextFactory, Integer listenPort)
private org.eclipse.jetty.util.ssl.SslContextFactory	createSslFactory(org.apache.nifi.controller.ConfigurationContext context)
protected Collection<org.apache.nifi.components.ValidationResult>	customValidate(org.apache.nifi.components.ValidationContext validationContext)
protected List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()
void	startServer(org.apache.nifi.controller.ConfigurationContext context)
void	stopServer()

Methods inherited from class org.apache.nifi.websocket.jetty.AbstractJettyWebSocketService

configurePolicy, createSslFactory, getAbstractPropertyDescriptors

Methods inherited from class org.apache.nifi.websocket.AbstractWebSocketService

deregisterProcessor, isProcessorRegistered, registerProcessor, sendMessage

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

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

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

deregisterProcessor, isProcessorRegistered, registerProcessor, sendMessage

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

initialize, isStateful

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

portToControllerService

private static final Map<Integer,JettyWebSocketServer> portToControllerService

A global map to refer a controller service instance by requested port number.

CLIENT_NONE

public static final org.apache.nifi.components.AllowableValue CLIENT_NONE

CLIENT_WANT

public static final org.apache.nifi.components.AllowableValue CLIENT_WANT

CLIENT_NEED

public static final org.apache.nifi.components.AllowableValue CLIENT_NEED

LOGIN_SERVICE_HASH

public static final org.apache.nifi.components.AllowableValue LOGIN_SERVICE_HASH

CLIENT_AUTH

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

LISTEN_PORT

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

BASIC_AUTH

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

AUTH_PATH_SPEC

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

AUTH_ROLES

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

LOGIN_SERVICE

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

USERS_PROPERTIES_FILE

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

properties

private static final List<org.apache.nifi.components.PropertyDescriptor> properties

configuredPolicy

private org.eclipse.jetty.websocket.api.WebSocketPolicy configuredPolicy

server

private org.eclipse.jetty.server.Server server

listenPort

private Integer listenPort

servletHandler

private org.eclipse.jetty.servlet.ServletHandler servletHandler

Constructor Detail

JettyWebSocketServer

public JettyWebSocketServer()

Method Detail

getSupportedPropertyDescriptors

protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

customValidate

protected Collection<org.apache.nifi.components.ValidationResult> customValidate(org.apache.nifi.components.ValidationContext validationContext)

Overrides:

customValidate in class org.apache.nifi.components.AbstractConfigurableComponent

startServer

@OnEnabled
public void startServer(org.apache.nifi.controller.ConfigurationContext context)
                            throws Exception

Specified by:

startServer in interface WebSocketServerService

Throws:

Exception

createConnector

private org.eclipse.jetty.server.ServerConnector createConnector(org.eclipse.jetty.util.ssl.SslContextFactory sslContextFactory,
                                                                 Integer listenPort)

createSslFactory

private org.eclipse.jetty.util.ssl.SslContextFactory createSslFactory(org.apache.nifi.controller.ConfigurationContext context)

stopServer

@OnDisabled
 @OnShutdown
public void stopServer()
                                         throws Exception

Specified by:

stopServer in interface WebSocketServerService

Throws:

Exception