XrootdTpcClient (xrootd4j core protocol 3.3.2 API)

java.lang.Object
- org.dcache.xrootd.tpc.XrootdTpcClient

```
public class XrootdTpcClient
extends Object
```
Internal third-party copy client responsible for reading the source file and writing it to the local server.

A TpcClient is responsible for a single file transfer. It has its own channel/pipeline, and its lifecycle ends with the completion of the transfer, whereupon it is disconnected.

A client is bound to its channel handlers through injection.

Constructor Summary

Constructors
Constructor and Description
`XrootdTpcClient(String userUrn, XrootdTpcInfo info, TpcDelayedSyncWriteHandler writeHandler, ScheduledExecutorService executorService)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canRedirect()`
`void`	`configureRedirects(XrootdTpcClient preceding)`
`void`	`connect(io.netty.channel.nio.NioEventLoopGroup group, List<ChannelHandlerFactory> plugins, TpcSourceReadHandler readHandler)`
`void`	`disconnect()` Blocking call, returns when client is no longer running.
`void`	`doClose(io.netty.channel.ChannelHandlerContext ctx)`
`void`	`doEndsession(io.netty.channel.ChannelHandlerContext ctx)`
`Map<String,Object>`	`getAuthnContext()`
`InboundAuthenticationResponse`	`getAuthResponse()`
`io.netty.channel.ChannelFuture`	`getChannelFuture()`
`int`	`getCpsize()`
`int`	`getCptype()`
`int`	`getErrno()`
`String`	`getError()`
`ScheduledExecutorService`	`getExecutor()`
`int`	`getExpectedResponse()`
`int`	`getFhandle()`
`int`	`getFlag()`
`String`	`getFullpath()`
`XrootdTpcInfo`	`getInfo()`
`Map<Integer,Integer>`	`getOverrides()`
`int`	`getPid()`
`int`	`getPval()`
`int`	`getSeclvl()`
`XrootdSessionIdentifier`	`getSessionId()`
`TpcSigverRequestHandler`	`getSigverRequestHandler()`
`int`	`getStreamId()`
`String`	`getUname()`
`String`	`getUserUrn()`
`TpcDelayedSyncWriteHandler`	`getWriteHandler()`
`long`	`getWriteOffset()`
`boolean`	`isOpenFile()`
`void`	`setAuthResponse(InboundAuthenticationResponse authResponse)`
`void`	`setCpsize(int cpsize)`
`void`	`setCptype(int cptype)`
`void`	`setError(Throwable t)`
`void`	`setExpectedResponse(int expectedRequestId)`
`void`	`setFhandle(int fhandle)`
`void`	`setFlag(int flag)`
`void`	`setOpenFile(boolean openFile)`
`void`	`setOverrides(Map<Integer,Integer> overrides)`
`void`	`setPval(int pval)`
`void`	`setSeclvl(int seclvl)`
`void`	`setSessionId(XrootdSessionIdentifier sessionId)`
`void`	`setSigverRequestHandler(TpcSigverRequestHandler sigverRequestHandler)`
`void`	`setWriteOffset(long writeOffset)`
`void`	`shutDown(io.netty.channel.ChannelHandlerContext ctx)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XrootdTpcClient

public XrootdTpcClient(String userUrn,
                       XrootdTpcInfo info,
                       TpcDelayedSyncWriteHandler writeHandler,
                       ScheduledExecutorService executorService)

Method Detail

canRedirect
```
public boolean canRedirect()
```

configureRedirects

public void configureRedirects(XrootdTpcClient preceding)

connect

public void connect(io.netty.channel.nio.NioEventLoopGroup group,
                    List<ChannelHandlerFactory> plugins,
                    TpcSourceReadHandler readHandler)
             throws InterruptedException

Throws:: InterruptedException

disconnect
```
public void disconnect()
```
Blocking call, returns when client is no longer running.

doClose

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

doEndsession

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

getExecutor

public ScheduledExecutorService getExecutor()

shutDown

public void shutDown(io.netty.channel.ChannelHandlerContext ctx)
              throws InterruptedException

Throws:: InterruptedException

getChannelFuture

public io.netty.channel.ChannelFuture getChannelFuture()

getAuthnContext

public Map<String,Object> getAuthnContext()

getAuthResponse

public InboundAuthenticationResponse getAuthResponse()

getCpsize
```
public int getCpsize()
```

getCptype
```
public int getCptype()
```

getErrno
```
public int getErrno()
```

getError
```
public String getError()
```

getExpectedResponse
```
public int getExpectedResponse()
```

getFhandle
```
public int getFhandle()
```

getFlag
```
public int getFlag()
```

getFullpath
```
public String getFullpath()
```

getInfo
```
public XrootdTpcInfo getInfo()
```

getOverrides

public Map<Integer,Integer> getOverrides()

getPid
```
public int getPid()
```

getPval
```
public int getPval()
```

getSeclvl
```
public int getSeclvl()
```

getSessionId

public XrootdSessionIdentifier getSessionId()

getSigverRequestHandler

public TpcSigverRequestHandler getSigverRequestHandler()

getStreamId
```
public int getStreamId()
```

getUname
```
public String getUname()
```

getUserUrn
```
public String getUserUrn()
```

getWriteHandler

public TpcDelayedSyncWriteHandler getWriteHandler()

getWriteOffset
```
public long getWriteOffset()
```

isOpenFile
```
public boolean isOpenFile()
```

setAuthResponse

public void setAuthResponse(InboundAuthenticationResponse authResponse)

setCpsize
```
public void setCpsize(int cpsize)
```

setCptype
```
public void setCptype(int cptype)
```

setError
```
public void setError(Throwable t)
```

setExpectedResponse

public void setExpectedResponse(int expectedRequestId)

setFhandle
```
public void setFhandle(int fhandle)
```

setFlag
```
public void setFlag(int flag)
```

setOpenFile

public void setOpenFile(boolean openFile)

setOverrides

public void setOverrides(Map<Integer,Integer> overrides)

setPval
```
public void setPval(int pval)
```

setSeclvl
```
public void setSeclvl(int seclvl)
```

setSessionId

public void setSessionId(XrootdSessionIdentifier sessionId)

setSigverRequestHandler

public void setSigverRequestHandler(TpcSigverRequestHandler sigverRequestHandler)

setWriteOffset

public void setWriteOffset(long writeOffset)

toString
```
public String toString()
```
Overrides:

toString in class Object

Class XrootdTpcClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XrootdTpcClient

Method Detail

canRedirect

configureRedirects

connect

disconnect

doClose

doEndsession

getExecutor

shutDown

getChannelFuture

getAuthnContext

getAuthResponse

getCpsize

getCptype

getErrno

getError

getExpectedResponse

getFhandle

getFlag

getFullpath

getInfo

getOverrides

getPid

getPval

getSeclvl

getSessionId

getSigverRequestHandler

getStreamId

getUname

getUserUrn

getWriteHandler

getWriteOffset

isOpenFile

setAuthResponse

setCpsize

setCptype

setError

setExpectedResponse

setFhandle

setFlag

setOpenFile

setOverrides

setPval

setSeclvl

setSessionId

setSigverRequestHandler

setWriteOffset

toString