org.dcache.xrootd.core

Class XrootdRequestHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.dcache.xrootd.core.XrootdRequestHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

XrootdAuthorizationHandler

public class XrootdRequestHandler
extends io.netty.channel.ChannelInboundHandlerAdapter

A ChannelInboundHandler to dispatch xrootd events to handler methods. Default response to all request messages from a client is kXR_Unsupported. Sub-classes may override handler methods to implement request handling. Releases the reference to XrootdRequest if the handler method throws an exception or returns a response. If the handler returns null the subclass assumes responsibility to release the request, typically by passing it on the next ChannelHandler in the pipeline.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
XrootdRequestHandler()

Method Summary

Modifier and Type	Method and Description
void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)
protected Object	doOnAuthentication(io.netty.channel.ChannelHandlerContext ctx, AuthenticationRequest msg)
protected Object	doOnClose(io.netty.channel.ChannelHandlerContext ctx, CloseRequest msg)
protected Object	doOnDirList(io.netty.channel.ChannelHandlerContext ctx, DirListRequest msg)
protected Object	doOnEndSession(io.netty.channel.ChannelHandlerContext ctx, EndSessionRequest request)
protected Object	doOnLocate(io.netty.channel.ChannelHandlerContext ctx, LocateRequest msg)
protected Object	doOnLogin(io.netty.channel.ChannelHandlerContext ctx, LoginRequest msg)
protected Object	doOnMkDir(io.netty.channel.ChannelHandlerContext ctx, MkDirRequest msg)
protected Object	doOnMv(io.netty.channel.ChannelHandlerContext ctx, MvRequest msg)
protected Object	doOnOpen(io.netty.channel.ChannelHandlerContext ctx, OpenRequest msg)
protected Object	doOnPrepare(io.netty.channel.ChannelHandlerContext ctx, PrepareRequest msg)
protected Object	doOnProtocolRequest(io.netty.channel.ChannelHandlerContext ctx, ProtocolRequest msg)
protected Object	doOnQuery(io.netty.channel.ChannelHandlerContext ctx, QueryRequest msg)
protected Object	doOnRead(io.netty.channel.ChannelHandlerContext ctx, ReadRequest msg)
protected Object	doOnReadV(io.netty.channel.ChannelHandlerContext ctx, ReadVRequest msg)
protected Object	doOnRm(io.netty.channel.ChannelHandlerContext ctx, RmRequest msg)
protected Object	doOnRmDir(io.netty.channel.ChannelHandlerContext ctx, RmDirRequest msg)
protected Object	doOnSet(io.netty.channel.ChannelHandlerContext ctx, SetRequest request)
protected Object	doOnStat(io.netty.channel.ChannelHandlerContext ctx, StatRequest msg)
protected Object	doOnStatx(io.netty.channel.ChannelHandlerContext ctx, StatxRequest msg)
protected Object	doOnSync(io.netty.channel.ChannelHandlerContext ctx, SyncRequest msg)
protected Object	doOnWrite(io.netty.channel.ChannelHandlerContext ctx, WriteRequest msg)
protected InetSocketAddress	getDestinationAddress() The socket address the client connected to.
protected InetSocketAddress	getSourceAddress() The socket address the client connected from.
protected boolean	isHealthCheck() True if this looks like a health check connection from a proxy server.
protected void	requestReceived(io.netty.channel.ChannelHandlerContext ctx, XrootdRequest req)
protected io.netty.channel.ChannelFuture	respond(io.netty.channel.ChannelHandlerContext ctx, Object response)
protected <T extends XrootdRequest> XrootdResponse<T>	unsupported(io.netty.channel.ChannelHandlerContext ctx, T msg)
protected <T extends XrootdRequest> ErrorResponse<T>	withError(T req, int errorCode, String errMsg)
protected <T extends XrootdRequest> OkResponse<T>	withOk(T req)

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

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

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

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

Constructor Detail

XrootdRequestHandler

public XrootdRequestHandler()

Method Detail

channelActive

public void channelActive(io.netty.channel.ChannelHandlerContext ctx)
                   throws Exception

Specified by:

channelActive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

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

requestReceived

protected void requestReceived(io.netty.channel.ChannelHandlerContext ctx,
                               XrootdRequest req)

withOk

protected <T extends XrootdRequest> OkResponse<T> withOk(T req)

withError

protected <T extends XrootdRequest> ErrorResponse<T> withError(T req,
                                                               int errorCode,
                                                               String errMsg)

respond

protected io.netty.channel.ChannelFuture respond(io.netty.channel.ChannelHandlerContext ctx,
                                                 Object response)

unsupported

protected <T extends XrootdRequest> XrootdResponse<T> unsupported(io.netty.channel.ChannelHandlerContext ctx,
                                                                  T msg)
                                                           throws XrootdException

Throws:

XrootdException

doOnLogin

protected Object doOnLogin(io.netty.channel.ChannelHandlerContext ctx,
                           LoginRequest msg)
                    throws XrootdException

Throws:

XrootdException

doOnAuthentication

protected Object doOnAuthentication(io.netty.channel.ChannelHandlerContext ctx,
                                    AuthenticationRequest msg)
                             throws XrootdException

Throws:

XrootdException

doOnOpen

protected Object doOnOpen(io.netty.channel.ChannelHandlerContext ctx,
                          OpenRequest msg)
                   throws XrootdException

Throws:

XrootdException

doOnStat

protected Object doOnStat(io.netty.channel.ChannelHandlerContext ctx,
                          StatRequest msg)
                   throws XrootdException

Throws:

XrootdException

doOnStatx

protected Object doOnStatx(io.netty.channel.ChannelHandlerContext ctx,
                           StatxRequest msg)
                    throws XrootdException

Throws:

XrootdException

doOnRead

protected Object doOnRead(io.netty.channel.ChannelHandlerContext ctx,
                          ReadRequest msg)
                   throws XrootdException

Throws:

XrootdException

doOnReadV

protected Object doOnReadV(io.netty.channel.ChannelHandlerContext ctx,
                           ReadVRequest msg)
                    throws XrootdException

Throws:

XrootdException

doOnWrite

protected Object doOnWrite(io.netty.channel.ChannelHandlerContext ctx,
                           WriteRequest msg)
                    throws XrootdException

Throws:

XrootdException

doOnSync

protected Object doOnSync(io.netty.channel.ChannelHandlerContext ctx,
                          SyncRequest msg)
                   throws XrootdException

Throws:

XrootdException

doOnClose

protected Object doOnClose(io.netty.channel.ChannelHandlerContext ctx,
                           CloseRequest msg)
                    throws XrootdException

Throws:

XrootdException

doOnProtocolRequest

protected Object doOnProtocolRequest(io.netty.channel.ChannelHandlerContext ctx,
                                     ProtocolRequest msg)
                              throws XrootdException

Throws:

XrootdException

doOnRm

protected Object doOnRm(io.netty.channel.ChannelHandlerContext ctx,
                        RmRequest msg)
                 throws XrootdException

Throws:

XrootdException

doOnRmDir

protected Object doOnRmDir(io.netty.channel.ChannelHandlerContext ctx,
                           RmDirRequest msg)
                    throws XrootdException

Throws:

XrootdException

doOnMkDir

protected Object doOnMkDir(io.netty.channel.ChannelHandlerContext ctx,
                           MkDirRequest msg)
                    throws XrootdException

Throws:

XrootdException

doOnMv

protected Object doOnMv(io.netty.channel.ChannelHandlerContext ctx,
                        MvRequest msg)
                 throws XrootdException

Throws:

XrootdException

doOnDirList

protected Object doOnDirList(io.netty.channel.ChannelHandlerContext ctx,
                             DirListRequest msg)
                      throws XrootdException

Throws:

XrootdException

doOnPrepare

protected Object doOnPrepare(io.netty.channel.ChannelHandlerContext ctx,
                             PrepareRequest msg)
                      throws XrootdException

Throws:

XrootdException

doOnLocate

protected Object doOnLocate(io.netty.channel.ChannelHandlerContext ctx,
                            LocateRequest msg)
                     throws XrootdException

Throws:

XrootdException

doOnQuery

protected Object doOnQuery(io.netty.channel.ChannelHandlerContext ctx,
                           QueryRequest msg)
                    throws XrootdException

Throws:

XrootdException

doOnSet

protected Object doOnSet(io.netty.channel.ChannelHandlerContext ctx,
                         SetRequest request)
                  throws XrootdException

Throws:

XrootdException

doOnEndSession

protected Object doOnEndSession(io.netty.channel.ChannelHandlerContext ctx,
                                EndSessionRequest request)
                         throws XrootdException

Throws:

XrootdException

getDestinationAddress

protected InetSocketAddress getDestinationAddress()

The socket address the client connected to. May be the local address of the channel, but could also be an address on a proxy server between the client and the server.

getSourceAddress

protected InetSocketAddress getSourceAddress()

The socket address the client connected from. May be the remote address of the channel, but in case a proxy is in between the client and the server, the source address will be a different from the remote address.

isHealthCheck

protected boolean isHealthCheck()

True if this looks like a health check connection from a proxy server.