Top Methods
org.apache.sshd.sftp.client.extensions

public Interface CheckFileHandleExtension

extends SftpClientExtension
Known Direct Implementers
org.apache.sshd.sftp.client.extensions.helpers.CheckFileHandleExtensionImpl
Imports
java.io.IOException, java.util.Collection, .Map, org.apache.sshd.sftp.client.SftpClient.Handle

Author
Apache MINA SSHD Project
See Also
DRAFT 09 - section 9.1.2

Method Summary

Modifier and TypeMethod and Description
public Map.Entry<String, Collection<byte[]>>

Returns:

An immutable java.util.Map.Entry where key=hash algorithm name, value=the calculated hashes.
checkFileHandle
(SftpClient.Handle
Remote file Handle - must be a file and opened for read
handle
,
Collection<String>
Hash algorithms in preferred order
algorithms
,
long
Start offset of the hash
startOffset
,
long
Length of data to hash - if zero then till EOF
length
,
int
Input block size to calculate individual hashes - if zero the one hash of all the data
blockSize
)

Method Detail

checkFileHandleback to summary
public Map.Entry<String, Collection<byte[]>> checkFileHandle(SftpClient.Handle handle, Collection<String> algorithms, long startOffset, long length, int blockSize) throws IOException
Parameters
handle:SftpClient.Handle

Remote file Handle - must be a file and opened for read

algorithms:Collection<String>

Hash algorithms in preferred order

startOffset:long

Start offset of the hash

length:long

Length of data to hash - if zero then till EOF

blockSize:int

Input block size to calculate individual hashes - if zero the one hash of all the data

Returns:Map.Entry<String, Collection<byte[]>>

An immutable java.util.Map.Entry where key=hash algorithm name, value=the calculated hashes.

Exceptions
IOException:
If failed to execute the command