Package org.apache.tinkerpop.gremlin.server.channel

Class WebSocketChannelizer

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelInitializer<io.netty.channel.socket.SocketChannel>

org.apache.tinkerpop.gremlin.server.AbstractChannelizer

org.apache.tinkerpop.gremlin.server.channel.WebSocketChannelizer

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, Channelizer

public class WebSocketChannelizer
extends AbstractChannelizer

A Channelizer that exposes a WebSocket-based Gremlin endpoint with a custom sub-protocol.

Author:

Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.server.AbstractChannelizer

authenticator, authorizer, DEFAULT_SERIALIZERS, graphManager, GREMLIN_ENDPOINT, gremlinExecutor, gremlinExecutorService, PIPELINE_AUTHENTICATOR, PIPELINE_AUTHORIZER, PIPELINE_HTTP_AGGREGATOR, PIPELINE_HTTP_REQUEST_DECODER, PIPELINE_HTTP_RESPONSE_ENCODER, PIPELINE_OP_EXECUTOR, PIPELINE_OP_SELECTOR, PIPELINE_REQUEST_HANDLER, PIPELINE_SSL, PIPELINE_WEBSOCKET_SERVER_COMPRESSION, scheduledExecutorService, serializers, settings, sslContext

Constructor Summary

Constructors

Constructor	Description
WebSocketChannelizer()

Method Summary

Modifier and Type	Method	Description
void	configure(io.netty.channel.ChannelPipeline pipeline)	This method is called from within AbstractChannelizer.initChannel(SocketChannel) just after the SSL handler is put in the pipeline.
Object	createIdleDetectionMessage()	Create a message to send to seemingly dead clients to see if they respond back.
void	init(ServerGremlinExecutor serverGremlinExecutor)	This method is called just after the Channelizer is initialized.
boolean	supportsIdleMonitor()	Determines if the channelizer supports a method for keeping the connection alive and auto-closing zombie channels.

Methods inherited from class org.apache.tinkerpop.gremlin.server.AbstractChannelizer

createAuthenticationHandler, finalize, initChannel

Methods inherited from class io.netty.channel.ChannelInitializer

channelRegistered, exceptionCaught, handlerAdded, handlerRemoved

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRead, channelReadComplete, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

WebSocketChannelizer

public WebSocketChannelizer()

Method Detail

init

public void init(ServerGremlinExecutor serverGremlinExecutor)

Description copied from interface: Channelizer

This method is called just after the Channelizer is initialized.

Specified by:

init in interface Channelizer

Overrides:

init in class AbstractChannelizer

configure

public void configure(io.netty.channel.ChannelPipeline pipeline)

Description copied from class: AbstractChannelizer

This method is called from within AbstractChannelizer.initChannel(SocketChannel) just after the SSL handler is put in the pipeline. Modify the pipeline as needed here.

Specified by:

configure in class AbstractChannelizer

supportsIdleMonitor

public boolean supportsIdleMonitor()

Description copied from interface: Channelizer

Determines if the channelizer supports a method for keeping the connection alive and auto-closing zombie channels.

createIdleDetectionMessage

public Object createIdleDetectionMessage()

Description copied from interface: Channelizer

Create a message to send to seemingly dead clients to see if they respond back. The message sent will be dependent on the implementation. For example, a websocket implementation would create a "ping" message. This method will only be used if Channelizer.supportsIdleMonitor() is true.