org.apache.sshd.sftp.client.extensions

Interface CheckFileHandleExtension

All Superinterfaces:

NamedResource, OptionalFeature, SftpClientExtension, SftpClientHolder

All Known Implementing Classes:

CheckFileHandleExtensionImpl

public interface CheckFileHandleExtension
extends SftpClientExtension

Author:

Apache MINA SSHD Project

See Also:

DRAFT 09 - section 9.1.2

Field Summary

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Fields inherited from interface org.apache.sshd.common.OptionalFeature

FALSE, TRUE

Method Summary

Modifier and Type	Method and Description
Map.Entry<String,Collection<byte[]>>	checkFileHandle(SftpClient.Handle handle, Collection<String> algorithms, long startOffset, long length, int blockSize)

Methods inherited from interface org.apache.sshd.common.NamedResource

findByName, findFirstMatchByName, getName, getNameList, getNames, ofName, removeByName, safeCompareByName

Methods inherited from interface org.apache.sshd.common.OptionalFeature

all, any, isSupported, of

Methods inherited from interface org.apache.sshd.sftp.client.SftpClientHolder

getClient

Method Detail

checkFileHandle

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

Parameters:

handle - Remote file SftpClient.Handle - must be a file and opened for read

algorithms - Hash algorithms in preferred order

startOffset - Start offset of the hash

length - Length of data to hash - if zero then till EOF

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

Returns:

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

Throws:

IOException - If failed to execute the command