Package org.apache.tinkerpop.gremlin.server.handler

Class SaslAuthenticationHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.apache.tinkerpop.gremlin.server.handler.AbstractAuthenticationHandler

org.apache.tinkerpop.gremlin.server.handler.SaslAuthenticationHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

SaslAndHttpBasicAuthenticationHandler

@Sharable
public class SaslAuthenticationHandler
extends AbstractAuthenticationHandler

A SASL authentication handler that allows the Authenticator to be plugged into it. This handler is meant to be used with protocols that process a RequestMessage such as the WebSocketChannelizer

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

Modifier and Type	Field	Description
static Duration	MAX_REQUEST_DEFERRABLE_DURATION	Default for settings.authentication.preAuthTimeout, how long a channel may stay unauthenticated, covering the whole handshake, not just the deferral window.
protected Settings	settings

Fields inherited from class org.apache.tinkerpop.gremlin.server.handler.AbstractAuthenticationHandler

authenticator, authorizer

Constructor Summary

Constructors

Constructor	Description
SaslAuthenticationHandler(Authenticator authenticator, Authorizer authorizer, Settings settings)
SaslAuthenticationHandler(Authenticator authenticator, Settings settings)	Deprecated. As of release 3.5.0, replaced by SaslAuthenticationHandler(Authenticator, Authorizer, Settings).

Method Summary

Modifier and Type	Method	Description
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, 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

MAX_REQUEST_DEFERRABLE_DURATION

public static final Duration MAX_REQUEST_DEFERRABLE_DURATION

Default for settings.authentication.preAuthTimeout, how long a channel may stay unauthenticated, covering the whole handshake, not just the deferral window.

settings

protected final Settings settings

Constructor Detail

SaslAuthenticationHandler

@Deprecated
public SaslAuthenticationHandler(Authenticator authenticator,
                                 Settings settings)

Deprecated.

As of release 3.5.0, replaced by SaslAuthenticationHandler(Authenticator, Authorizer, Settings).

SaslAuthenticationHandler

public SaslAuthenticationHandler(Authenticator authenticator,
                                 Authorizer authorizer,
                                 Settings settings)

Method Detail

channelRead

public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception