Package org.dcache.xrootd.core

Class XrootdAuthenticationHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.dcache.xrootd.core.XrootdRequestHandler

org.dcache.xrootd.core.XrootdAuthenticationHandler

All Implemented Interfaces:

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

public class XrootdAuthenticationHandler
extends XrootdRequestHandler

Netty handler implementing Xrootd kXR_auth.

Delegates the authentication steps to an AuthenticationHandler. Rejects all other messages until login has completed.

Note the difference between this class and AuthenticationHandler. The latter is part of a plugin implementing the core authentication logic whereas this class is a Netty handler.

The class may be subclassed to override the authenticated method to add additional operations after authentication.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
XrootdAuthenticationHandler(java.lang.String name, AuthenticationFactory authenticationFactory, ProxyDelegationClient proxyDelegationClient)

Method Summary

Modifier and Type	Method	Description
protected java.lang.Object	doOnAuthentication(io.netty.channel.ChannelHandlerContext context, AuthenticationRequest request)
AuthenticationHandler	getHandler()
java.lang.String	getProtocol()
protected java.lang.Object	getResponse(io.netty.channel.ChannelHandlerContext ctx, XrootdRequest req)
void	handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
protected javax.security.auth.Subject	login(io.netty.channel.ChannelHandlerContext context, javax.security.auth.Subject subject)	Called at the end of successful login/authentication.
void	setSessionHandler(XrootdSessionHandler sessionHandler)

Methods inherited from class org.dcache.xrootd.core.XrootdRequestHandler

channelActive, channelRead, doOnClose, doOnDirList, doOnEndSession, doOnLocate, doOnLogin, doOnMkDir, doOnMv, doOnOpen, doOnPrepare, doOnProtocolRequest, doOnQuery, doOnRead, doOnReadV, doOnRm, doOnRmDir, doOnSet, doOnStat, doOnStatx, doOnSync, doOnWrite, getDestinationAddress, getSourceAddress, isHealthCheck, requestReceived, respond, unsupported, userEventTriggered, withError, withOk

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

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

Constructor Detail

XrootdAuthenticationHandler

public XrootdAuthenticationHandler(java.lang.String name,
                                   AuthenticationFactory authenticationFactory,
                                   ProxyDelegationClient proxyDelegationClient)

Method Detail

getProtocol

public java.lang.String getProtocol()

getHandler

public AuthenticationHandler getHandler()

handlerRemoved

public void handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)

Specified by:

handlerRemoved in interface io.netty.channel.ChannelHandler

Overrides:

handlerRemoved in class io.netty.channel.ChannelHandlerAdapter

setSessionHandler

public void setSessionHandler(XrootdSessionHandler sessionHandler)

doOnAuthentication

protected java.lang.Object doOnAuthentication(io.netty.channel.ChannelHandlerContext context,
                                              AuthenticationRequest request)
                                       throws XrootdException

Overrides:

doOnAuthentication in class XrootdRequestHandler

Throws:

XrootdException

getResponse

protected java.lang.Object getResponse(io.netty.channel.ChannelHandlerContext ctx,
                                       XrootdRequest req)

Overrides:

getResponse in class XrootdRequestHandler

login

protected javax.security.auth.Subject login(io.netty.channel.ChannelHandlerContext context,
                                            javax.security.auth.Subject subject)
                                     throws XrootdException

Called at the end of successful login/authentication.

Subclasses may override this method to add additional processing and internal mapping of the Subject.

If the subclass throws XrootdException then the login is aborted.

Parameters:

context - the Netty context

subject - the subject that logged in

Throws:

XrootdException