org.apache.sshd.client.subsystem.sftp.extensions

Interface MD5FileExtension

All Superinterfaces:

NamedResource, OptionalFeature, SftpClientExtension

All Known Implementing Classes:

MD5FileExtensionImpl

public interface MD5FileExtension
extends SftpClientExtension

See Also:

DRAFT 09 - section 9.1.1

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
byte[]	getHash(java.lang.String path, long offset, long length, byte[] quickHash)

Methods inherited from interface org.apache.sshd.client.subsystem.sftp.extensions.SftpClientExtension

getClient

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

findByName, getName, getNameList, getNames, ofName, removeByName

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

all, any, isSupported, of

Method Detail

getHash

byte[] getHash(java.lang.String path,
               long offset,
               long length,
               byte[] quickHash)
        throws java.io.IOException

Parameters:

path - The (remote) path

offset - The offset to start calculating the hash

length - The number of data bytes to calculate the hash on - if greater than available, then up to whatever is available

quickHash - A quick-hash of the 1st 2048 bytes - ignored if null/empty

Returns:

The hash value if the quick hash matches (or null/empty), or null/empty if the quick hash is provided and it does not match

Throws:

java.io.IOException - If failed to calculate the hash