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

Interface CheckFileNameExtension

All Superinterfaces:

NamedResource, OptionalFeature, SftpClientExtension

All Known Implementing Classes:

CheckFileNameExtensionImpl

public interface CheckFileNameExtension
extends SftpClientExtension

Author:

Apache MINA SSHD Project

See Also:

DRAFT 09 - section 9.1.2

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
Map.Entry<String,Collection<byte[]>>	checkFileName(String name, Collection<String> algorithms, long startOffset, long length, int blockSize)

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

Method Detail

checkFileName

Map.Entry<String,Collection<byte[]>> checkFileName(String name,
                                                   Collection<String> algorithms,
                                                   long startOffset,
                                                   long length,
                                                   int blockSize)
                                            throws IOException

Parameters:

name - Remote file name/path

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 key left=hash algorithm name, value=the calculated hashes.

Throws:

IOException - If failed to execute the command