Package org.apache.sshd.scp.common.helpers

Class LocalFileScpSourceStreamResolver

java.lang.Object

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

org.apache.sshd.scp.common.helpers.LocalFileScpSourceStreamResolver

All Implemented Interfaces:

ScpSourceStreamResolver

public class LocalFileScpSourceStreamResolver
extends org.apache.sshd.common.util.logging.AbstractLoggingBean
implements ScpSourceStreamResolver

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
protected Path	name
protected ScpFileOpener	opener
protected Path	path
protected Set<PosixFilePermission>	perms
protected long	size
protected ScpTimestampCommandDetails	time

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

log

Constructor Summary

Constructors

Constructor	Description
LocalFileScpSourceStreamResolver(Path path, ScpFileOpener opener)

Method Summary

Modifier and Type	Method	Description
void	closeSourceStream(Session session, long length, Set<PosixFilePermission> permissions, InputStream stream)	Called when the stream obtained from resolveSourceStream is no longer needed since since file copy was completed successfully.
Path	getEventListenerFilePath()
String	getFileName()
Collection<PosixFilePermission>	getPermissions()
long	getSize()
ScpTimestampCommandDetails	getTimestamp()
InputStream	resolveSourceStream(Session session, long length, Set<PosixFilePermission> permissions, OpenOption... options)
String	toString()

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

Field Detail

path

protected final Path path

opener

protected final ScpFileOpener opener

name

protected final Path name

perms

protected final Set<PosixFilePermission> perms

size

protected final long size

time

protected final ScpTimestampCommandDetails time

Constructor Detail

LocalFileScpSourceStreamResolver

public LocalFileScpSourceStreamResolver(Path path,
                                        ScpFileOpener opener)
                                 throws IOException

Throws:

IOException

Method Detail

getFileName

public String getFileName()
                   throws IOException

Specified by:

getFileName in interface ScpSourceStreamResolver

Returns:

The uploaded file name

Throws:

IOException - If failed to resolve the name

getPermissions

public Collection<PosixFilePermission> getPermissions()
                                               throws IOException

Specified by:

getPermissions in interface ScpSourceStreamResolver

Returns:

The permissions to be used for uploading a file

Throws:

IOException - If failed to generate the required permissions

getTimestamp

public ScpTimestampCommandDetails getTimestamp()
                                        throws IOException

Specified by:

getTimestamp in interface ScpSourceStreamResolver

Returns:

The ScpTimestampCommandDetails to use for uploading the file if null then no need to send this information

Throws:

IOException - If failed to generate the required data

getSize

public long getSize()
             throws IOException

Specified by:

getSize in interface ScpSourceStreamResolver

Returns:

An estimated size of the expected number of bytes to be uploaded. If non-positive then assumed to be unknown.

Throws:

IOException - If failed to generate an estimate

getEventListenerFilePath

public Path getEventListenerFilePath()

Specified by:

getEventListenerFilePath in interface ScpSourceStreamResolver

Returns:

The Path to use when invoking the ScpTransferEventListener

resolveSourceStream

public InputStream resolveSourceStream(Session session,
                                       long length,
                                       Set<PosixFilePermission> permissions,
                                       OpenOption... options)
                                throws IOException

Specified by:

resolveSourceStream in interface ScpSourceStreamResolver

Parameters:

session - The Session through which file is transmitted

length - The expected transfer byte count

permissions - The requested file permissions

options - The OpenOptions may be null/empty

Returns:

The InputStream containing the data to be uploaded

Throws:

IOException - If failed to create the stream

closeSourceStream

public void closeSourceStream(Session session,
                              long length,
                              Set<PosixFilePermission> permissions,
                              InputStream stream)
                       throws IOException

Description copied from interface: ScpSourceStreamResolver

Called when the stream obtained from resolveSourceStream is no longer needed since since file copy was completed successfully.

Specified by:

closeSourceStream in interface ScpSourceStreamResolver

Parameters:

session - The Session through which file is transmitted

length - The expected transfer byte count

permissions - The requested file permissions

stream - The InputStream to close

Throws:

IOException - If failed to close the stream - Note: stream will be closed regardless of whether this method throws an exception or not.

toString

public String toString()

Overrides:

toString in class Object