Package org.apache.tinkerpop.gremlin.driver

Class SigV4WebSocketChannelizer

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer

org.apache.tinkerpop.gremlin.driver.SigV4WebSocketChannelizer

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, org.apache.tinkerpop.gremlin.driver.Channelizer

public class SigV4WebSocketChannelizer
extends org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer

An Channelizer.AbstractChannelizer, with most of the code from Channelizer.WebSocketChannelizer. Except it uses a different WebSocketClientHandshaker which uses SIGV4 auth. This class should be used as a Channelizer when SIGV4 auth is enabled.

See Also:

https://github.com/apache/tinkerpop/blob/master/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.driver.Channelizer

org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer, org.apache.tinkerpop.gremlin.driver.Channelizer.NioChannelizer, org.apache.tinkerpop.gremlin.driver.Channelizer.WebSocketChannelizer

Field Summary

Fields

Modifier and Type	Field	Description
static String	WEBSOCKET_COMPRESSION_HANDLER	Name of the WebSocket compression handler.

Fields inherited from class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer

cluster, connection, PIPELINE_GREMLIN_HANDLER, PIPELINE_GREMLIN_SASL_HANDLER

Constructor Summary

Constructors

Constructor	Description
SigV4WebSocketChannelizer()

Method Summary

Modifier and Type	Method	Description
void	close(io.netty.channel.Channel channel)	Sends a CloseWebSocketFrame to the server for the specified channel.
void	configure(io.netty.channel.ChannelPipeline pipeline)
void	connected()
Object	createKeepAliveMessage()
protected com.amazonaws.auth.AWSCredentialsProvider	getCredentialsProvider()	This protected method provides a way for customizing the channelize through inheritance to override credentials used to establish sign requests
void	init(org.apache.tinkerpop.gremlin.driver.Connection connection)	Initializes the channelizer.
boolean	supportsKeepAlive()	Keep-alive is supported through the ping/pong websocket protocol.
boolean	supportsSsl()

Methods inherited from class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer

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

Field Detail

WEBSOCKET_COMPRESSION_HANDLER

public static final String WEBSOCKET_COMPRESSION_HANDLER

Name of the WebSocket compression handler.

See Also:

Constant Field Values

Constructor Detail

SigV4WebSocketChannelizer

public SigV4WebSocketChannelizer()

Method Detail

init

public void init(org.apache.tinkerpop.gremlin.driver.Connection connection)

Initializes the channelizer.

Specified by:

init in interface org.apache.tinkerpop.gremlin.driver.Channelizer

Overrides:

init in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer

Parameters:

connection - the Connection object.

supportsKeepAlive

public boolean supportsKeepAlive()

Keep-alive is supported through the ping/pong websocket protocol.

See Also:

IETF RFC 6455

createKeepAliveMessage

public Object createKeepAliveMessage()

close

public void close(io.netty.channel.Channel channel)

Sends a CloseWebSocketFrame to the server for the specified channel.

Specified by:

close in interface org.apache.tinkerpop.gremlin.driver.Channelizer

Overrides:

close in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer

supportsSsl

public boolean supportsSsl()

Overrides:

supportsSsl in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer

configure

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

Specified by:

configure in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer

connected

public void connected()

getCredentialsProvider

protected com.amazonaws.auth.AWSCredentialsProvider getCredentialsProvider()

This protected method provides a way for customizing the channelize through inheritance to override credentials used to establish sign requests

Returns:

credentials provider that will be used to generate SigV4 signatures