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 AbstractLoggingBean
implements ScpTargetStreamResolver
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Path
protected final ScpFileOpener
protected final Path
protected final Boolean
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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 datatoString()
protected void
updateFileProperties
(String name, Path path, Set<PosixFilePermission> perms, ScpTimestampCommandDetails time)
-
Field Details
-
path
-
opener
-
status
-
file
-
-
Constructor Details
-
LocalFileScpTargetStreamResolver
- Throws:
IOException
-
-
Method Details
-
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 interfaceScpTargetStreamResolver
- 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
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 fromresolveTargetStream
call is no longer needed since copy is successfully completed.- Specified by:
closeTargetStream
in interfaceScpTargetStreamResolver
- 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
- Specified by:
getEventListenerFilePath
in interfaceScpTargetStreamResolver
- Returns:
- The
Path
to use when invoking theScpTransferEventListener
-
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 interfaceScpTargetStreamResolver
- 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
-
updateFileProperties
protected void updateFileProperties(String name, Path path, Set<PosixFilePermission> perms, ScpTimestampCommandDetails time) throws IOException - Throws:
IOException
-
toString
-