org.apache.sshd.common.scp

Interface ScpFileOpener

All Known Implementing Classes:

DefaultScpFileOpener

public interface ScpFileOpener

Plug-in mechanism for users to intervene in the SCP process - e.g., apply some kind of traffic shaping mechanism, display upload/download progress, etc...

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
InputStream	openRead(Session session, Path file, OpenOption... options) Create an input stream to read from a file
OutputStream	openWrite(Session session, Path file, OpenOption... options) Create an output stream to write to a file

Method Detail

openRead

InputStream openRead(Session session,
                     Path file,
                     OpenOption... options)
              throws IOException

Create an input stream to read from a file

Parameters:

session - The Session requesting the access

file - The requested local file Path

options - The OpenOptions - may be null/empty

Returns:

The open InputStream never null

Throws:

IOException - If failed to open the file

openWrite

OutputStream openWrite(Session session,
                       Path file,
                       OpenOption... options)
                throws IOException

Create an output stream to write to a file

Parameters:

session - The Session requesting the access

file - The requested local file Path

options - The OpenOptions - may be null/empty

Returns:

The open OutputStream never null

Throws:

IOException - If failed to open the file