Package org.dcache.xrootd.tpc

Class AbstractClientSourceHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.dcache.xrootd.tpc.AbstractClientRequestHandler

org.dcache.xrootd.tpc.AbstractClientSourceHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

TpcSourceReadHandler

public abstract class AbstractClientSourceHandler
extends AbstractClientRequestHandler

Xrootd Third Party copy requires the destination server to be active, and request a read of the source file from the source server.

This handler implements open and close.

Concrete implementations must handle the actual read and checksum requests and responses.

If the close response is OK, it hands it off to the next handler in the chain.

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.dcache.xrootd.tpc.AbstractClientRequestHandler

client, LOGGER

Constructor Summary

Constructors

Constructor	Description
AbstractClientSourceHandler()

Method Summary

Modifier and Type	Method	Description
protected void	doOnAsynResponse(io.netty.channel.ChannelHandlerContext ctx, InboundAttnResponse response)
protected void	doOnAuthenticationResponse(io.netty.channel.ChannelHandlerContext ctx, InboundAuthenticationResponse response)	If this method is called on this handler with status OK, this means that step has succeeded.
protected abstract void	doOnChecksumResponse(io.netty.channel.ChannelHandlerContext ctx, InboundChecksumResponse response)	Should check the checksum and fail or succeed accordingly.
protected void	doOnCloseResponse(io.netty.channel.ChannelHandlerContext ctx, InboundCloseResponse response)
protected void	doOnLoginResponse(io.netty.channel.ChannelHandlerContext ctx, InboundLoginResponse response)	If the response contains a security context, then it was not handled by an authentication plugin, and the transfer should fail.
protected void	doOnOpenResponse(io.netty.channel.ChannelHandlerContext ctx, InboundOpenReadOnlyResponse response)
protected abstract void	doOnReadResponse(io.netty.channel.ChannelHandlerContext ctx, InboundReadResponse response)	Should implement the proper read logic.
protected void	doOnWaitResponse(io.netty.channel.ChannelHandlerContext ctx, AbstractXrootdInboundResponse response)
protected abstract void	sendChecksumRequest(io.netty.channel.ChannelHandlerContext ctx)	If checksum option is expressed.
protected void	sendOpenRequest(io.netty.channel.ChannelHandlerContext ctx)
protected abstract void	sendReadRequest(io.netty.channel.ChannelHandlerContext ctx)	Should take care of any special handling, such as vectorization.

Methods inherited from class org.dcache.xrootd.tpc.AbstractClientRequestHandler

asynWaitTimeout, channelRead, doOnAttnResponse, doOnErrorResponse, doOnHandshakeResponse, doOnProtocolResponse, doOnRedirectResponse, doOnWaitRespResponse, exceptionCaught, getWaitInSeconds, responseReceived, sendAuthenticationRequest, sendCloseRequest, sendLoginRequest, setClient, unsupported

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, 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

Constructor Detail

AbstractClientSourceHandler

public AbstractClientSourceHandler()

Method Detail

doOnLoginResponse

protected void doOnLoginResponse(io.netty.channel.ChannelHandlerContext ctx,
                                 InboundLoginResponse response)
                          throws XrootdException

If the response contains a security context, then it was not handled by an authentication plugin, and the transfer should fail.

Overrides:

doOnLoginResponse in class AbstractClientRequestHandler

Throws:

XrootdException

doOnAsynResponse

protected void doOnAsynResponse(io.netty.channel.ChannelHandlerContext ctx,
                                InboundAttnResponse response)
                         throws XrootdException

Overrides:

doOnAsynResponse in class AbstractClientRequestHandler

Throws:

XrootdException

doOnAuthenticationResponse

protected void doOnAuthenticationResponse(io.netty.channel.ChannelHandlerContext ctx,
                                          InboundAuthenticationResponse response)
                                   throws XrootdException

If this method is called on this handler with status OK, this means that step has succeeded.

Overrides:

doOnAuthenticationResponse in class AbstractClientRequestHandler

Throws:

XrootdException

doOnCloseResponse

protected void doOnCloseResponse(io.netty.channel.ChannelHandlerContext ctx,
                                 InboundCloseResponse response)
                          throws XrootdException

Overrides:

doOnCloseResponse in class AbstractClientRequestHandler

Throws:

XrootdException

doOnOpenResponse

protected void doOnOpenResponse(io.netty.channel.ChannelHandlerContext ctx,
                                InboundOpenReadOnlyResponse response)
                         throws XrootdException

Overrides:

doOnOpenResponse in class AbstractClientRequestHandler

Throws:

XrootdException

sendOpenRequest

protected void sendOpenRequest(io.netty.channel.ChannelHandlerContext ctx)

Overrides:

sendOpenRequest in class AbstractClientRequestHandler

doOnWaitResponse

protected void doOnWaitResponse(io.netty.channel.ChannelHandlerContext ctx,
                                AbstractXrootdInboundResponse response)
                         throws XrootdException

Overrides:

doOnWaitResponse in class AbstractClientRequestHandler

Throws:

XrootdException

doOnChecksumResponse

protected abstract void doOnChecksumResponse(io.netty.channel.ChannelHandlerContext ctx,
                                             InboundChecksumResponse response)
                                      throws XrootdException

Should check the checksum and fail or succeed accordingly.

Overrides:

doOnChecksumResponse in class AbstractClientRequestHandler

Throws:

XrootdException

doOnReadResponse

protected abstract void doOnReadResponse(io.netty.channel.ChannelHandlerContext ctx,
                                         InboundReadResponse response)
                                  throws XrootdException

Should implement the proper read logic. If vector reads are supported, should direct to special method.

Overrides:

doOnReadResponse in class AbstractClientRequestHandler

Throws:

XrootdException

sendChecksumRequest

protected abstract void sendChecksumRequest(io.netty.channel.ChannelHandlerContext ctx)
                                     throws XrootdException

If checksum option is expressed.

Overrides:

sendChecksumRequest in class AbstractClientRequestHandler

Throws:

XrootdException

sendReadRequest

protected abstract void sendReadRequest(io.netty.channel.ChannelHandlerContext ctx)
                                 throws XrootdException

Should take care of any special handling, such as vectorization.

Overrides:

sendReadRequest in class AbstractClientRequestHandler

Throws:

XrootdException