org.apache.sshd.common.scp.helpers

Class DefaultScpFileOpener

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.scp.helpers.DefaultScpFileOpener

All Implemented Interfaces:

ScpFileOpener

public class DefaultScpFileOpener
extends AbstractLoggingBean
implements ScpFileOpener

Field Summary

Fields

Modifier and Type	Field and Description
private static java.nio.file.OpenOption[]	DEFAULT_SYNC_OPTIONS
static DefaultScpFileOpener	INSTANCE

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.scp.ScpFileOpener

DEFAULT_AUTO_SYNC_FILE_ON_WRITE, PROP_AUTO_SYNC_FILE_ON_WRITE

Constructor Summary

Constructors

Constructor and Description
DefaultScpFileOpener()

Method Summary

Modifier and Type	Method and Description
ScpSourceStreamResolver	createScpSourceStreamResolver(Session session, java.nio.file.Path path)
ScpTargetStreamResolver	createScpTargetStreamResolver(Session session, java.nio.file.Path path)
java.io.InputStream	openRead(Session session, java.nio.file.Path file, long size, java.util.Set<java.nio.file.attribute.PosixFilePermission> permissions, java.nio.file.OpenOption... options) Create an input stream to read from a file
java.io.OutputStream	openWrite(Session session, java.nio.file.Path file, long size, java.util.Set<java.nio.file.attribute.PosixFilePermission> permissions, java.nio.file.OpenOption... options) Create an output stream to write to a file
protected java.nio.file.OpenOption[]	resolveOpenOptions(Session session, java.nio.file.Path file, long size, java.util.Set<java.nio.file.attribute.PosixFilePermission> permissions, java.nio.file.OpenOption... options)

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.scp.ScpFileOpener

closeRead, closeWrite, getLocalBasicFileAttributes, getLocalFilePermissions, getLocalFolderChildren, getMatchingFilesToSend, resolveIncomingFilePath, resolveIncomingReceiveLocation, resolveLocalPath, resolveOutgoingFilePath, sendAsDirectory, sendAsRegularFile, updateFileProperties

Field Detail

INSTANCE

public static final DefaultScpFileOpener INSTANCE

DEFAULT_SYNC_OPTIONS

private static final java.nio.file.OpenOption[] DEFAULT_SYNC_OPTIONS

Constructor Detail

DefaultScpFileOpener

public DefaultScpFileOpener()

Method Detail

openRead

public java.io.InputStream openRead(Session session,
                                    java.nio.file.Path file,
                                    long size,
                                    java.util.Set<java.nio.file.attribute.PosixFilePermission> permissions,
                                    java.nio.file.OpenOption... options)
                             throws java.io.IOException

Description copied from interface: ScpFileOpener

Create an input stream to read from a file

Specified by:

openRead in interface ScpFileOpener

Parameters:

session - The Session requesting the access

file - The requested local file Path

size - The expected transfer bytes count

permissions - The requested file permissions

options - The OpenOptions - may be null/empty

Returns:

The open InputStream never null

Throws:

java.io.IOException - If failed to open the file

openWrite

public java.io.OutputStream openWrite(Session session,
                                      java.nio.file.Path file,
                                      long size,
                                      java.util.Set<java.nio.file.attribute.PosixFilePermission> permissions,
                                      java.nio.file.OpenOption... options)
                               throws java.io.IOException

Description copied from interface: ScpFileOpener

Create an output stream to write to a file

Specified by:

openWrite in interface ScpFileOpener

Parameters:

session - The Session requesting the access

file - The requested local file Path

size - The expected transfer byte count

permissions - The requested file permissions

options - The OpenOptions - may be null/empty

Returns:

The open OutputStream never null

Throws:

java.io.IOException - If failed to open the file

resolveOpenOptions

protected java.nio.file.OpenOption[] resolveOpenOptions(Session session,
                                                        java.nio.file.Path file,
                                                        long size,
                                                        java.util.Set<java.nio.file.attribute.PosixFilePermission> permissions,
                                                        java.nio.file.OpenOption... options)
                                                 throws java.io.IOException

Throws:

java.io.IOException

createScpSourceStreamResolver

public ScpSourceStreamResolver createScpSourceStreamResolver(Session session,
                                                             java.nio.file.Path path)
                                                      throws java.io.IOException

Specified by:

createScpSourceStreamResolver in interface ScpFileOpener

Throws:

java.io.IOException

createScpTargetStreamResolver

public ScpTargetStreamResolver createScpTargetStreamResolver(Session session,
                                                             java.nio.file.Path path)
                                                      throws java.io.IOException

Specified by:

createScpTargetStreamResolver in interface ScpFileOpener

Throws:

java.io.IOException