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

Class CheckFileHandleExtensionImpl

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.AbstractCheckFileExtension

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

All Implemented Interfaces:

CheckFileHandleExtension, SftpClientExtension, RawSftpClient, NamedResource, OptionalFeature

public class CheckFileHandleExtensionImpl
extends AbstractCheckFileExtension
implements CheckFileHandleExtension

Implements "check-file-handle" extension

Author:

Apache MINA SSHD Project

See Also:

DRAFT 09 - section 9.1.2

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
CheckFileHandleExtensionImpl(SftpClient client, RawSftpClient raw, Collection<String> extras)

Method Summary

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

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

doGetHash

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

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

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, removeByName

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

all, any, isSupported, of

Constructor Detail

CheckFileHandleExtensionImpl

public CheckFileHandleExtensionImpl(SftpClient client,
                                    RawSftpClient raw,
                                    Collection<String> extras)

Method Detail

checkFileHandle

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

Specified by:

checkFileHandle in interface CheckFileHandleExtension

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:

A Pair where left=hash algorithm name, right=the calculated hashes.

Throws:

IOException - If failed to execute the command