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

Class CheckFileNameExtensionImpl

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

All Implemented Interfaces:

NamedResource, OptionalFeature, CheckFileNameExtension, SftpClientExtension, RawSftpClient, SftpClientHolder

public class CheckFileNameExtensionImpl
extends AbstractCheckFileExtension
implements CheckFileNameExtension

Implements "check-file-name" 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
CheckFileNameExtensionImpl(SftpClient client, RawSftpClient raw, Collection<String> extras)

Method Summary

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

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

doGetHash

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

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

Methods inherited from class org.apache.sshd.common.util.logging.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 java.lang.Object

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

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

findByName, findFirstMatchByName, getName, getNameList, getNames, ofName, removeByName, safeCompareByName

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

all, any, isSupported, of

Methods inherited from interface org.apache.sshd.sftp.client.SftpClientHolder

getClient

Constructor Detail

CheckFileNameExtensionImpl

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

Method Detail

checkFileName

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

Specified by:

checkFileName in interface CheckFileNameExtension

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