Package org.apache.sshd.scp.common
Interface ScpTargetStreamResolver
- All Known Implementing Classes:
LocalFileScpTargetStreamResolver
public interface ScpTargetStreamResolver
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
closeTargetStream
(Session session, String name, long length, Set<PosixFilePermission> perms, OutputStream stream) Called when target stream received fromresolveTargetStream
call is no longer needed since copy is successfully completed.void
postProcessReceivedData
(String name, boolean preserve, Set<PosixFilePermission> perms, ScpTimestampCommandDetails time) Called after successful reception of the data (and after closing the stream)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
-
Method Details
-
resolveTargetStream
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
- The associatedSession
name
- File name as received from remote sitelength
- Number of bytes expected to receiveperms
- TheSet
ofPosixFilePermission
expectedoptions
- TheOpenOption
s to use - may benull
/empty- Returns:
- The
OutputStream
to write the incoming data - Throws:
IOException
- If failed to create the stream
-
closeTargetStream
default void closeTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OutputStream stream) throws IOException Called when target stream received fromresolveTargetStream
call is no longer needed since copy is successfully completed.- Parameters:
session
- The associatedSession
name
- File name as received from remote sitelength
- Number of bytes expected to receiveperms
- TheSet
ofPosixFilePermission
expectedstream
- TheOutputStream
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
Path getEventListenerFilePath()- Returns:
- The
Path
to use when invoking theScpTransferEventListener
-
postProcessReceivedData
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
- File name as received from remote sitepreserve
- Iftrue
then the resolver should attempt to preserve the specified permissions and timestampperms
- TheSet
ofPosixFilePermission
expectedtime
- If notnull
then the required timestamp(s) on the incoming data- Throws:
IOException
- If failed to post-process the incoming data
-