MD5FileExtension (Apache Mina SSHD :: SFTP 2.11.0 API)

All Superinterfaces:

NamedResource, OptionalFeature, SftpClientExtension, SftpClientHolder

All Known Implementing Classes:

MD5FileExtensionImpl
```
public interface MD5FileExtension
extends SftpClientExtension
```
Author:

Apache MINA SSHD Project

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
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  byte[] getHash(String path, long offset, long length, byte[] quickHash)
  - Methods inherited from interface org.apache.sshd.common.NamedResource
    getName
  - Methods inherited from interface org.apache.sshd.common.OptionalFeature
    isSupported
  - Methods inherited from interface org.apache.sshd.sftp.client.SftpClientHolder
    getClient

- Method Detail
  - getHash
```
byte[] getHash(String path,
               long offset,
               long length,
               byte[] quickHash)
        throws 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:
    
    IOException - If failed to calculate the hash