FileTransferBase (Airavata GFac BES implementation 0.13 API)

java.lang.Object
- org.apache.airavata.gfac.bes.utils.FileTransferBase

Direct Known Subclasses:

FileDownloader, FileUploader
```
public class FileTransferBase
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.unigrids.services.atomic.types.ProtocolType.Enum`	`chosenProtocol`
`protected Long`	`endByte`
`protected Properties`	`extraParameterSource`
`protected boolean`	`failOnError` whether the job processing should fail if an error occurs
`protected String`	`from`
`protected Mode`	`mode` the creation mode
`protected List<org.unigrids.services.atomic.types.ProtocolType.Enum>`	`preferredProtocols`
`protected boolean`	`recurse`
`protected Long`	`startByte`
`protected boolean`	`timing`
`protected String`	`to`

Constructor Summary

Constructors
Constructor and Description

FileTransferBase()

Constructors
Constructor and Description
`FileTransferBase()`

Method Summary

Methods
Modifier and Type	Method and Description
`org.unigrids.services.atomic.types.ProtocolType.Enum`	`getChosenProtocol()`
`Long`	`getEndByte()`
`String`	`getFrom()`
`Mode`	`getMode()`
`List<org.unigrids.services.atomic.types.ProtocolType.Enum>`	`getPreferredProtocols()`
`protected long`	`getRangeSize()` get the number of bytes in the byte range, or "-1" if the range is open-ended
`Long`	`getStartByte()`
`String`	`getTo()`
`protected boolean`	`hasWildCards(File file)`
`boolean`	`hasWildCards(String name)`
`boolean`	`isFailOnError()`
`protected boolean`	`isRange()` checks if a byte range is defined
`boolean`	`isTiming()`
`protected boolean`	`isValidDirectory(String remotePath, de.fzj.unicore.uas.client.StorageClient sms)` check if the given path denotes a valid remote directory
`protected Map<String,String>`	`makeExtraParameters(org.unigrids.services.atomic.types.ProtocolType.Enum protocol)`
`File[]`	`resolveWildCards(File original)`
`void`	`setEndByte(Long endByte)`
`void`	`setExtraParameterSource(Properties properties)`
`void`	`setFailOnError(boolean failOnError)`
`void`	`setFrom(String from)`
`void`	`setPreferredProtocols(List<org.unigrids.services.atomic.types.ProtocolType.Enum> preferredProtocols)`
`void`	`setRecurse(boolean recurse)`
`void`	`setStartByte(Long startByte)`
`void`	`setTiming(boolean timing)`
`void`	`setTo(String to)`

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

Field Detail

extraParameterSource

protected Properties extraParameterSource

timing
```
protected boolean timing
```

recurse
```
protected boolean recurse
```

from
```
protected String from
```

to
```
protected String to
```

startByte
```
protected Long startByte
```

endByte
```
protected Long endByte
```

mode
```
protected Mode mode
```
the creation mode

failOnError
```
protected boolean failOnError
```
whether the job processing should fail if an error occurs

preferredProtocols

protected List<org.unigrids.services.atomic.types.ProtocolType.Enum> preferredProtocols

chosenProtocol

protected org.unigrids.services.atomic.types.ProtocolType.Enum chosenProtocol

Constructor Detail
- FileTransferBase
```
public FileTransferBase()
```

Method Detail

makeExtraParameters

protected Map<String,String> makeExtraParameters(org.unigrids.services.atomic.types.ProtocolType.Enum protocol)

getTo
```
public String getTo()
```

getFrom
```
public String getFrom()
```

setTo
```
public void setTo(String to)
```

setFrom
```
public void setFrom(String from)
```

getMode
```
public Mode getMode()
```

isFailOnError
```
public boolean isFailOnError()
```

isTiming
```
public boolean isTiming()
```

setTiming

public void setTiming(boolean timing)

setFailOnError

public void setFailOnError(boolean failOnError)

getPreferredProtocols

public List<org.unigrids.services.atomic.types.ProtocolType.Enum> getPreferredProtocols()

setPreferredProtocols

public void setPreferredProtocols(List<org.unigrids.services.atomic.types.ProtocolType.Enum> preferredProtocols)

setExtraParameterSource

public void setExtraParameterSource(Properties properties)

setRecurse

public void setRecurse(boolean recurse)

isValidDirectory
```
protected boolean isValidDirectory(String remotePath,
                       de.fzj.unicore.uas.client.StorageClient sms)
```
check if the given path denotes a valid remote directory

Parameters:
remotePath - - the path
sms - - the storage

Returns:
true if the remote directory exists and is a directory

resolveWildCards

public File[] resolveWildCards(File original)

hasWildCards

protected boolean hasWildCards(File file)

hasWildCards

public boolean hasWildCards(String name)

getChosenProtocol

public org.unigrids.services.atomic.types.ProtocolType.Enum getChosenProtocol()

getStartByte
```
public Long getStartByte()
```

setStartByte

public void setStartByte(Long startByte)

getEndByte
```
public Long getEndByte()
```

setEndByte
```
public void setEndByte(Long endByte)
```

isRange
```
protected boolean isRange()
```
checks if a byte range is defined

Returns:
true iff both startByte and endByte are defined

getRangeSize
```
protected long getRangeSize()
```
get the number of bytes in the byte range, or "-1" if the range is open-ended

Returns:

Class FileTransferBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extraParameterSource

timing

recurse

from

to

startByte

endByte

mode

failOnError

preferredProtocols

chosenProtocol

Constructor Detail

FileTransferBase

Method Detail

makeExtraParameters

getTo

getFrom

setTo

setFrom

getMode

isFailOnError

isTiming

setTiming

setFailOnError

getPreferredProtocols

setPreferredProtocols

setExtraParameterSource

setRecurse

isValidDirectory

resolveWildCards

hasWildCards

hasWildCards

getChosenProtocol

getStartByte

setStartByte

getEndByte

setEndByte

isRange

getRangeSize