org.apache.sshd.scp.common.helpers

Class LocalFileScpTargetStreamResolver

java.lang.Object

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

org.apache.sshd.scp.common.helpers.LocalFileScpTargetStreamResolver

All Implemented Interfaces:

ScpTargetStreamResolver

public class LocalFileScpTargetStreamResolver
extends org.apache.sshd.common.util.logging.AbstractLoggingBean
implements ScpTargetStreamResolver

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
protected ScpFileOpener	opener
protected Path	path
protected Boolean	status

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

log

Constructor Summary

Constructors

Constructor and Description
LocalFileScpTargetStreamResolver(Path path, ScpFileOpener opener)

Method Summary

Modifier and Type	Method and Description
void	closeTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OutputStream stream) Called when target stream received from resolveTargetStream call is no longer needed since copy is successfully completed.
Path	getEventListenerFilePath()
void	postProcessReceivedData(String name, boolean preserve, Set<PosixFilePermission> perms, ScpTimestampCommandDetails time) Called after successful reception of the data (and after closing the stream)
OutputStream	resolveTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OpenOption... options) Called when receiving a file in order to obtain an output stream for the incoming data
String	toString()
protected void	updateFileProperties(String name, Path path, Set<PosixFilePermission> perms, ScpTimestampCommandDetails time)

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

status

protected final Boolean status

Constructor Detail

LocalFileScpTargetStreamResolver

public LocalFileScpTargetStreamResolver(Path path,
                                        ScpFileOpener opener)
                                 throws IOException

Throws:

IOException

Method Detail

resolveTargetStream

public OutputStream resolveTargetStream(Session session,
                                        String name,
                                        long length,
                                        Set<PosixFilePermission> perms,
                                        OpenOption... options)
                                 throws IOException

Description copied from interface: ScpTargetStreamResolver

Called when receiving a file in order to obtain an output stream for the incoming data

Specified by:

resolveTargetStream in interface ScpTargetStreamResolver

Parameters:

session - The associated Session

name - File name as received from remote site

length - Number of bytes expected to receive

perms - The Set of PosixFilePermission expected

options - The OpenOptions to use - may be null/empty

Returns:

The OutputStream to write the incoming data

Throws:

IOException - If failed to create the stream

closeTargetStream

public void closeTargetStream(Session session,
                              String name,
                              long length,
                              Set<PosixFilePermission> perms,
                              OutputStream stream)
                       throws IOException

Description copied from interface: ScpTargetStreamResolver

Called when target stream received from resolveTargetStream call is no longer needed since copy is successfully completed.

Specified by:

closeTargetStream in interface ScpTargetStreamResolver

Parameters:

session - The associated Session

name - File name as received from remote site

length - Number of bytes expected to receive

perms - The Set of PosixFilePermission expected

stream - The OutputStream 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.

getEventListenerFilePath

public Path getEventListenerFilePath()

Specified by:

getEventListenerFilePath in interface ScpTargetStreamResolver

Returns:

The Path to use when invoking the ScpTransferEventListener

postProcessReceivedData

public void postProcessReceivedData(String name,
                                    boolean preserve,
                                    Set<PosixFilePermission> perms,
                                    ScpTimestampCommandDetails time)
                             throws IOException

Description copied from interface: ScpTargetStreamResolver

Called after successful reception of the data (and after closing the stream)

Specified by:

postProcessReceivedData in interface ScpTargetStreamResolver

Parameters:

name - File name as received from remote site

preserve - If true then the resolver should attempt to preserve the specified permissions and timestamp

perms - The Set of PosixFilePermission expected

time - If not null then the required timestamp(s) on the incoming data

Throws:

IOException - If failed to post-process the incoming data

updateFileProperties

protected void updateFileProperties(String name,
                                    Path path,
                                    Set<PosixFilePermission> perms,
                                    ScpTimestampCommandDetails time)
                             throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object