Apache Mina SSHD 2.15.0 · org.apache.sshd.scp.common.ScpTargetStreamResolver

Method Summary

Modifier and Type	Method and Description
public default void	closeTargetStream(Session The associated `Session` session, String File name as received from remote site name, long Number of bytes expected to receive length, Set<PosixFilePermission> The `Set` of `PosixFilePermission` expected perms, OutputStream The `OutputStream` to close stream) Called when target stream received from `resolveTargetStream` call is no longer needed since copy is successfully completed.
public Path	Returns: The `Path` to use when invoking the `ScpTransferEventListener` getEventListenerFilePath()
public void	postProcessReceivedData(String File name as received from remote site name, boolean If `true` then the resolver should attempt to preserve the specified permissions and timestamp preserve, Set<PosixFilePermission> The `Set` of `PosixFilePermission` expected perms, ScpTimestampCommandDetails If not `null` then the required timestamp(s) on the incoming data time) Called after successful reception of the data (and after closing the stream)
public OutputStream	Returns: The `OutputStream` to write the incoming data resolveTargetStream(Session The associated `Session` session, String File name as received from remote site name, long Number of bytes expected to receive length, Set<PosixFilePermission> The `Set` of `PosixFilePermission` expected perms, OpenOption... The `OpenOption`s to use - may be `null`/empty options) Called when receiving a file in order to obtain an output stream for the incoming data

closeTargetStream back to summary

closeTargetStream	back to summary
public default void closeTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OutputStream stream) throws IOException Called when target stream received from `resolveTargetStream` call is no longer needed since copy is successfully completed. Parameters session:Session The associated `Session` name:String File name as received from remote site length:long Number of bytes expected to receive perms:Set<PosixFilePermission> The `Set` of `PosixFilePermission` expected stream:OutputStream The `OutputStream` to close Exceptions IOException: If failed to close the stream - Note: stream will be closed regardless of whether this method throws an exception or not.

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

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

Parameters

Exceptions

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

getEventListenerFilePath	back to summary
public Path getEventListenerFilePath() Returns:Path The `Path` to use when invoking the `ScpTransferEventListener`

postProcessReceivedData back to summary

postProcessReceivedData	back to summary
public void postProcessReceivedData(String name, boolean preserve, Set<PosixFilePermission> perms, ScpTimestampCommandDetails time) throws IOException Called after successful reception of the data (and after closing the stream) Parameters name:String File name as received from remote site preserve:boolean If `true` then the resolver should attempt to preserve the specified permissions and timestamp perms:Set<PosixFilePermission> The `Set` of `PosixFilePermission` expected time:ScpTimestampCommandDetails If not `null` then the required timestamp(s) on the incoming data Exceptions IOException: If failed to post-process the incoming data

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

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

Parameters

name:String: File name as received from remote site
preserve:boolean: If true then the resolver should attempt to preserve the specified permissions and timestamp
perms:Set<PosixFilePermission>: The Set of PosixFilePermission expected
time:ScpTimestampCommandDetails: If not null then the required timestamp(s) on the incoming data

Exceptions

resolveTargetStream back to summary

resolveTargetStream	back to summary
public OutputStream resolveTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OpenOption... options) throws IOException Called when receiving a file in order to obtain an output stream for the incoming data Parameters session:Session The associated `Session` name:String File name as received from remote site length:long Number of bytes expected to receive perms:Set<PosixFilePermission> The `Set` of `PosixFilePermission` expected options:OpenOption[] The `OpenOption`s to use - may be `null`/empty Returns:OutputStream The `OutputStream` to write the incoming data Exceptions IOException: If failed to create the stream

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

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

Parameters

The OutputStream to write the incoming data

Exceptions