Class CheckFileHandleExtensionImpl

java.lang.Object

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

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

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

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

All Implemented Interfaces:

NamedResource, OptionalFeature, CheckFileHandleExtension, SftpClientExtension, RawSftpClient, SftpClientHolder

public class CheckFileHandleExtensionImpl
extends AbstractCheckFileExtension
implements CheckFileHandleExtension

Implements "check-file-handle" extension

See Also:

• DRAFT 09 - section 9.1.2

Field Summary

Fields inherited from class AbstractLoggingBean

log

Fields inherited from interface NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Fields inherited from interface OptionalFeature

FALSE, TRUE

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class AbstractCheckFileExtension

doGetHash

Methods inherited from class AbstractSftpClientExtension

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

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

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

Methods inherited from interface NamedResource

getName

Methods inherited from interface OptionalFeature

isSupported

Methods inherited from interface SftpClientHolder

getClient

Constructor Details

CheckFileHandleExtensionImpl

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

Method Details

checkFileHandle

public AbstractMap.SimpleImmutableEntry<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:

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

Throws:

IOException - If failed to execute the command