org.apache.nifi.websocket.jetty

Class JettyWebSocketClient

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.JettyWebSocketClient

All Implemented Interfaces:

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

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

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,SessionInfo>	activeSessions
static org.apache.nifi.components.PropertyDescriptor	AUTH_CHARSET
protected String	authorizationHeader
private org.eclipse.jetty.websocket.client.WebSocketClient	client
private org.apache.nifi.controller.ConfigurationContext	configurationContext
static org.apache.nifi.components.PropertyDescriptor	CONNECTION_ATTEMPT_COUNT
static org.apache.nifi.components.PropertyDescriptor	CONNECTION_TIMEOUT
private ReentrantLock	connectionLock
private long	connectionTimeoutMillis
static org.apache.nifi.components.PropertyDescriptor	CUSTOM_AUTH
private static List<org.apache.nifi.components.PropertyDescriptor>	properties
static org.apache.nifi.components.PropertyDescriptor	PROXY_HOST
static org.apache.nifi.components.PropertyDescriptor	PROXY_PORT
static org.apache.nifi.components.PropertyDescriptor	SESSION_MAINTENANCE_INTERVAL
private ScheduledExecutorService	sessionMaintenanceScheduler
static org.apache.nifi.components.PropertyDescriptor	USER_NAME
static org.apache.nifi.components.PropertyDescriptor	USER_PASSWORD
private URI	webSocketUri
static org.apache.nifi.components.PropertyDescriptor	WS_URI

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
JettyWebSocketClient()

Method Summary

Modifier and Type	Method and Description
void	connect(String clientId)
void	connect(String clientId, Map<String,String> flowFileAttributes)
private void	connect(String clientId, String sessionId, Map<String,String> flowFileAttributes)
(package private) Future<org.eclipse.jetty.websocket.api.Session>	createWebsocketSession(RoutingWebSocketListener listener, org.eclipse.jetty.websocket.client.ClientUpgradeRequest request)
protected Collection<org.apache.nifi.components.ValidationResult>	customValidate(org.apache.nifi.components.ValidationContext validationContext)
protected List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()
String	getTargetUri()
(package private) void	maintainSessions()
void	startClient(org.apache.nifi.controller.ConfigurationContext context)
void	stopClient()

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

WS_URI

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

CONNECTION_TIMEOUT

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

CONNECTION_ATTEMPT_COUNT

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

SESSION_MAINTENANCE_INTERVAL

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

USER_NAME

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

USER_PASSWORD

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

AUTH_CHARSET

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

CUSTOM_AUTH

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

PROXY_HOST

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

PROXY_PORT

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

properties

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

activeSessions

private final Map<String,SessionInfo> activeSessions

connectionLock

private final ReentrantLock connectionLock

client

private org.eclipse.jetty.websocket.client.WebSocketClient client

webSocketUri

private URI webSocketUri

connectionTimeoutMillis

private long connectionTimeoutMillis

sessionMaintenanceScheduler

private volatile ScheduledExecutorService sessionMaintenanceScheduler

configurationContext

private org.apache.nifi.controller.ConfigurationContext configurationContext

authorizationHeader

protected String authorizationHeader

Constructor Detail

JettyWebSocketClient

public JettyWebSocketClient()

Method Detail

getSupportedPropertyDescriptors

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

Overrides:

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

startClient

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

Specified by:

startClient in interface WebSocketClientService

Throws:

Exception

customValidate

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

Overrides:

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

stopClient

@OnDisabled
 @OnShutdown
public void stopClient()
                                         throws Exception

Specified by:

stopClient in interface WebSocketClientService

Throws:

Exception

connect

public void connect(String clientId)
             throws IOException

Specified by:

connect in interface WebSocketClientService

Throws:

IOException

connect

public void connect(String clientId,
                    Map<String,String> flowFileAttributes)
             throws IOException

Specified by:

connect in interface WebSocketClientService

Throws:

IOException

connect

private void connect(String clientId,
                     String sessionId,
                     Map<String,String> flowFileAttributes)
              throws IOException

Throws:

IOException

createWebsocketSession

Future<org.eclipse.jetty.websocket.api.Session> createWebsocketSession(RoutingWebSocketListener listener,
                                                                       org.eclipse.jetty.websocket.client.ClientUpgradeRequest request)
                                                                throws IOException

Throws:

IOException

maintainSessions

void maintainSessions()
               throws Exception

Throws:

Exception

getTargetUri

public String getTargetUri()

Specified by:

getTargetUri in interface WebSocketClientService