XrootdTpcInfo (xrootd4j core protocol 3.3.2 API)

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

```
public class XrootdTpcInfo
extends Object
```
Metadata established via interaction between user client, source and destination in a third-party copy, occurring prior to the launching of an internal third-party copy operation.

Used to verify and coordinate the open and close requests.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class XrootdTpcInfo.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`XrootdTpcInfo.Status`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADLER32`
`static String`	`CHECKSUM`
`static String`	`CLIENT`
`static String`	`COPY`
`static String`	`CRC32`
`static String`	`DST`
`static String`	`LOGICAL_NAME`
`static String`	`MD5`
`static String`	`PLACEMENT` Opaque string name-value constant values.
`static String`	`RENDEZVOUS_KEY`
`static String`	`SIZE_IN_BYTES`
`static String`	`SRC`
`static String`	`STAGE` Opaque string name-value keys.
`static String`	`TIME_TO_LIVE`

Constructor Summary

Constructors
Constructor and Description

XrootdTpcInfo(Map<String,String> opaque)
Initializes everything from the map instance.

XrootdTpcInfo(String key)

Constructors
Constructor and Description
`XrootdTpcInfo(Map<String,String> opaque)` Initializes everything from the map instance.
`XrootdTpcInfo(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XrootdTpcInfo`	`addInfoFromOpaque(String slfn, Map<String,String> opaque)` Used in a two-phase sequence (client, server), to add information incrementally.
`XrootdTpcInfo`	`copyForRedirect(InboundRedirectResponse response)` Saves relevant fields which should remain the same, and constructs new source endpoint info.
`long`	`getAsize()`
`String`	`getCks()`
`long`	`getCreatedTime()`
`String`	`getDst()`
`String`	`getExternal()`
`int`	`getFd()`
`String`	`getKey()`
`String`	`getLfn()`
`String`	`getLoginToken()`
`String`	`getOrg()`
`String`	`getSrc()`
`String`	`getSrcHost()`
`Integer`	`getSrcPort()`
`XrootdTpcInfo.Status`	`getStatus()`
`Long`	`getTtl()`
`boolean`	`isExpired()`
`void`	`setAsize(long asize)`
`void`	`setCks(String cks)`
`void`	`setDst(String dst)`
`void`	`setFd(int fd)`
`void`	`setLfn(String lfn)`
`void`	`setLoginToken(String loginToken)`
`void`	`setOrg(String org)`
`void`	`setSrc(String src)`
`void`	`setSrcHost(String srcHost)`
`void`	`setSrcPort(Integer srcPort)`
`void`	`setStatus(XrootdTpcInfo.Status status)`
`void`	`setTtl(Long ttl)`
`String`	`toString()`
`XrootdTpcInfo.Status`	`verify(String dst, String slfn, String org)`

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

Field Detail
- STAGE
```
public static final String STAGE
```
  Opaque string name-value keys.
  
  See Also:
  
  Constant Field Values
- RENDEZVOUS_KEY
```
public static final String RENDEZVOUS_KEY
```
  See Also:
  
  Constant Field Values
- SRC
```
public static final String SRC
```
  See Also:
  
  Constant Field Values
- DST
```
public static final String DST
```
  See Also:
  
  Constant Field Values
- LOGICAL_NAME
```
public static final String LOGICAL_NAME
```
  See Also:
  
  Constant Field Values
- CLIENT
```
public static final String CLIENT
```
  See Also:
  
  Constant Field Values
- CHECKSUM
```
public static final String CHECKSUM
```
  See Also:
  
  Constant Field Values
- TIME_TO_LIVE
```
public static final String TIME_TO_LIVE
```
  See Also:
  
  Constant Field Values
- SIZE_IN_BYTES
```
public static final String SIZE_IN_BYTES
```
  See Also:
  
  Constant Field Values
- PLACEMENT
```
public static final String PLACEMENT
```
  Opaque string name-value constant values.
  
  See Also:
  
  Constant Field Values
- COPY
```
public static final String COPY
```
  See Also:
  
  Constant Field Values
- ADLER32
```
public static final String ADLER32
```
  See Also:
  
  Constant Field Values
- CRC32
```
public static final String CRC32
```
  See Also:
  
  Constant Field Values
- MD5
```
public static final String MD5
```
  See Also:
  
  Constant Field Values

Constructor Detail
- XrootdTpcInfo
```
public XrootdTpcInfo(String key)
```
- XrootdTpcInfo
```
public XrootdTpcInfo(Map<String,String> opaque)
```
  Initializes everything from the map instance. Calling this constructor implies a READY status.
  Ttl is not relevant.

Method Detail

addInfoFromOpaque

public XrootdTpcInfo addInfoFromOpaque(String slfn,
                                       Map<String,String> opaque)

Used in a two-phase sequence (client, server), to add information incrementally.

Will not overwrite existing non-null values.

copyForRedirect
```
public XrootdTpcInfo copyForRedirect(InboundRedirectResponse response)
                              throws ParseException
```
Saves relevant fields which should remain the same, and constructs new source endpoint info.

Parameters:

response - received from source.

Returns:

new info object which can be used to instantiate new client.

Throws:

ParseException

verify

public XrootdTpcInfo.Status verify(String dst,
                                   String slfn,
                                   String org)

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

toString in class Object

isExpired
```
public boolean isExpired()
```

getAsize
```
public long getAsize()
```

getCks
```
public String getCks()
```

getCreatedTime
```
public long getCreatedTime()
```

getExternal
```
public String getExternal()
```

getDst
```
public String getDst()
```

getFd
```
public int getFd()
```

getKey
```
public String getKey()
```

getLfn
```
public String getLfn()
```

getLoginToken
```
public String getLoginToken()
```

getOrg
```
public String getOrg()
```

getSrc
```
public String getSrc()
```

getSrcHost
```
public String getSrcHost()
```

getSrcPort
```
public Integer getSrcPort()
```

getStatus

public XrootdTpcInfo.Status getStatus()

getTtl
```
public Long getTtl()
```

setAsize
```
public void setAsize(long asize)
```

setCks
```
public void setCks(String cks)
```

setDst
```
public void setDst(String dst)
```

setFd
```
public void setFd(int fd)
```

setLfn
```
public void setLfn(String lfn)
```

setLoginToken

public void setLoginToken(String loginToken)

setOrg
```
public void setOrg(String org)
```

setSrc
```
public void setSrc(String src)
```

setSrcHost

public void setSrcHost(String srcHost)

setSrcPort

public void setSrcPort(Integer srcPort)

setStatus

public void setStatus(XrootdTpcInfo.Status status)

setTtl
```
public void setTtl(Long ttl)
```

Class XrootdTpcInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STAGE

RENDEZVOUS_KEY

SRC

DST

LOGICAL_NAME

CLIENT

CHECKSUM

TIME_TO_LIVE

SIZE_IN_BYTES

PLACEMENT

COPY

ADLER32

CRC32

MD5

Constructor Detail

XrootdTpcInfo

XrootdTpcInfo

Method Detail

addInfoFromOpaque

copyForRedirect

verify

toString

isExpired

getAsize

getCks

getCreatedTime

getExternal

getDst

getFd

getKey

getLfn

getLoginToken

getOrg

getSrc

getSrcHost

getSrcPort

getStatus

getTtl

setAsize

setCks

setDst

setFd

setLfn

setLoginToken

setOrg

setSrc

setSrcHost

setSrcPort

setStatus

setTtl