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

Class MD5FileExtensionImpl

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

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

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

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

All Implemented Interfaces:

MD5FileExtension, SftpClientExtension, RawSftpClient, NamedResource, OptionalFeature

public class MD5FileExtensionImpl
extends AbstractMD5HashExtension
implements MD5FileExtension

Implements "md5-hash" extension

See Also:

DRAFT 09 - section 9.1.1

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

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

Constructor Summary

Constructors

Constructor and Description
MD5FileExtensionImpl(SftpClient client, RawSftpClient raw, java.util.Collection<java.lang.String> extra)

Method Summary

Modifier and Type	Method and Description
byte[]	getHash(java.lang.String path, long offset, long length, byte[] quickHash)

Methods inherited from class org.apache.sshd.client.subsystem.sftp.extensions.helpers.AbstractMD5HashExtension

doGetHash

Methods inherited from class org.apache.sshd.client.subsystem.sftp.extensions.helpers.AbstractSftpClientExtension

checkExtendedReplyBuffer, checkStatus, getClient, getCommandBuffer, getCommandBuffer, getCommandBuffer, getName, isSupported, putTarget, receive, receive, send, sendAndCheckExtendedCommandStatus, sendExtendedCommand, throwStatusException, validateIncomingResponse

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

MD5FileExtensionImpl

public MD5FileExtensionImpl(SftpClient client,
                            RawSftpClient raw,
                            java.util.Collection<java.lang.String> extra)

Method Detail

getHash

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

Specified by:

getHash in interface MD5FileExtension

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