Apache Mina SSHD 2.15.0 · org.apache.sshd.scp.common.helpers.LocalFileScpTargetStreamResolver

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

Access	Constructor and Description
public	LocalFileScpTargetStreamResolver(Path path, ScpFileOpener opener)

Method Summary

Modifier and Type	Method and Description
public 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) Overrides default org.apache.sshd.scp.common.ScpTargetStreamResolver.closeTargetStream. Called when target stream received from `resolveTargetStream` call is no longer needed since copy is successfully completed.
public Path	getEventListenerFilePath() Implements org.apache.sshd.scp.common.ScpTargetStreamResolver.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) Implements org.apache.sshd.scp.common.ScpTargetStreamResolver.postProcessReceivedData. Called after successful reception of the data (and after closing the stream)
public OutputStream	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) Implements org.apache.sshd.scp.common.ScpTargetStreamResolver.resolveTargetStream. Called when receiving a file in order to obtain an output stream for the incoming data
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected void	updateFileProperties(String name, Path path, Set<PosixFilePermission> perms, ScpTimestampCommandDetails time)

Inherited from 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

file	back to summary
private Path file

opener	back to summary
protected final ScpFileOpener opener

path	back to summary
protected final Path path

status	back to summary
protected final Boolean status

LocalFileScpTargetStreamResolver	back to summary
public LocalFileScpTargetStreamResolver(Path path, ScpFileOpener opener) throws IOException

Method Detail

closeTargetStream back to summary

closeTargetStream	back to summary
public void closeTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OutputStream stream) throws IOException Overrides default org.apache.sshd.scp.common.ScpTargetStreamResolver.closeTargetStream. Doc from org.apache.sshd.scp.common.ScpTargetStreamResolver.closeTargetStream. 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 Annotations @Override Exceptions IOException: If failed to close the stream - Note: stream will be closed regardless of whether this method throws an exception or not.

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

Overrides default org.apache.sshd.scp.common.ScpTargetStreamResolver.closeTargetStream.

Doc from org.apache.sshd.scp.common.ScpTargetStreamResolver.closeTargetStream.

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

Annotations

@Override

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

getEventListenerFilePath	back to summary
public Path getEventListenerFilePath() Implements org.apache.sshd.scp.common.ScpTargetStreamResolver.getEventListenerFilePath. Returns:Path Doc from org.apache.sshd.scp.common.ScpTargetStreamResolver.getEventListenerFilePath. The `Path` to use when invoking the `ScpTransferEventListener` Annotations @Override

public Path getEventListenerFilePath()

Implements org.apache.sshd.scp.common.ScpTargetStreamResolver.getEventListenerFilePath.

Returns:Path

Doc from org.apache.sshd.scp.common.ScpTargetStreamResolver.getEventListenerFilePath.

The Path to use when invoking the ScpTransferEventListener

Annotations

@Override

postProcessReceivedData back to summary

postProcessReceivedData	back to summary
public void postProcessReceivedData(String name, boolean preserve, Set<PosixFilePermission> perms, ScpTimestampCommandDetails time) throws IOException Implements org.apache.sshd.scp.common.ScpTargetStreamResolver.postProcessReceivedData. Doc from org.apache.sshd.scp.common.ScpTargetStreamResolver.postProcessReceivedData. 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 Annotations @Override Exceptions IOException: If failed to post-process the incoming data

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

Implements org.apache.sshd.scp.common.ScpTargetStreamResolver.postProcessReceivedData.

Doc from org.apache.sshd.scp.common.ScpTargetStreamResolver.postProcessReceivedData.

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

Annotations

@Override

Exceptions

IOException:: If failed to post-process the incoming data

resolveTargetStream back to summary

resolveTargetStream	back to summary
public OutputStream resolveTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OpenOption... options) throws IOException Implements org.apache.sshd.scp.common.ScpTargetStreamResolver.resolveTargetStream. Doc from org.apache.sshd.scp.common.ScpTargetStreamResolver.resolveTargetStream. 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 Annotations @Override Exceptions IOException: If failed to create the stream

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

Implements org.apache.sshd.scp.common.ScpTargetStreamResolver.resolveTargetStream.

Doc from org.apache.sshd.scp.common.ScpTargetStreamResolver.resolveTargetStream.

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 OpenOptions to use - may be null/empty

Returns:OutputStream

The OutputStream to write the incoming data

Annotations

@Override

Exceptions

IOException:: If failed to create the stream

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

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

public Class LocalFileScpTargetStreamResolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail