Package org.apache.sshd.scp

Class ScpModuleProperties

java.lang.Object
org.apache.sshd.scp.ScpModuleProperties
public final class ScpModuleProperties extends Object
Configurable properties for sshd-scp.
Author:
Apache MINA SSHD Project

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.sshd.common.Property<Boolean>
    ENABLE_SCP_SHELL
    Whether to provide an ScpShell instance if WinSCP client detected or at all
    static final org.apache.sshd.common.Property<Boolean>
    PROP_AUTO_SYNC_FILE_ON_WRITE
    Whether to synchronize written file data with underlying file-system
    static final org.apache.sshd.common.Property<Duration>
    SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT
    Configurable value for controlling the wait timeout for waiting on a channel exit status' for an SCP command in milliseconds.
    static final org.apache.sshd.common.Property<Duration>
    SCP_EXEC_CHANNEL_OPEN_TIMEOUT
    Configurable value of the for controlling the wait timeout for opening a channel for an SCP command in milliseconds.
    static final org.apache.sshd.common.Property<Charset>
    SCP_INCOMING_ENCODING
    Used to indicate the Charset (or its name) for decoding incoming commands/responses sent by the peer (either client or server).
    static final org.apache.sshd.common.Property<Charset>
    SCP_OUTGOING_ENCODING
    Used to indicate the Charset (or its name) for encoding outgoing commands/responses sent to the peer (either client or server).
    static final org.apache.sshd.common.Property<Charset>
    SHELL_ENVVARS_ENCODING_CHARSET
    Used to indicate the Charset (or its name) for handling environment values in ScpShell - extracted from the channel session when shell initialized.
    static final org.apache.sshd.common.Property<Charset>
    SHELL_NAME_DECODING_CHARSET
    Used to indicate the Charset (or its name) for decoding incoming commands to be processed by the ScpShell - extracted from the channel session when shell initialized.
    static final org.apache.sshd.common.Property<Charset>
    SHELL_NAME_ENCODING_CHARSET
    Used to indicate the Charset (or its name) for encoding returned textual responses from the ScpShell - extracted from the channel session when shell initialized.

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • SCP_EXEC_CHANNEL_OPEN_TIMEOUT

      public static final org.apache.sshd.common.Property<Duration> SCP_EXEC_CHANNEL_OPEN_TIMEOUT
      Configurable value of the for controlling the wait timeout for opening a channel for an SCP command in milliseconds.

    • SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT

      public static final org.apache.sshd.common.Property<Duration> SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT
      Configurable value for controlling the wait timeout for waiting on a channel exit status' for an SCP command in milliseconds. If non-positive, then no wait is performed and the command is assumed to have completed successfully.

    • SCP_INCOMING_ENCODING

      public static final org.apache.sshd.common.Property<Charset> SCP_INCOMING_ENCODING
      Used to indicate the Charset (or its name) for decoding incoming commands/responses sent by the peer (either client or server).

    • SCP_OUTGOING_ENCODING

      public static final org.apache.sshd.common.Property<Charset> SCP_OUTGOING_ENCODING
      Used to indicate the Charset (or its name) for encoding outgoing commands/responses sent to the peer (either client or server).

    • PROP_AUTO_SYNC_FILE_ON_WRITE

      public static final org.apache.sshd.common.Property<Boolean> PROP_AUTO_SYNC_FILE_ON_WRITE
      Whether to synchronize written file data with underlying file-system

    • ENABLE_SCP_SHELL

      public static final org.apache.sshd.common.Property<Boolean> ENABLE_SCP_SHELL
      Whether to provide an ScpShell instance if WinSCP client detected or at all
      See Also:

    • SHELL_NAME_ENCODING_CHARSET

      public static final org.apache.sshd.common.Property<Charset> SHELL_NAME_ENCODING_CHARSET
      Used to indicate the Charset (or its name) for encoding returned textual responses from the ScpShell - extracted from the channel session when shell initialized.

    • SHELL_ENVVARS_ENCODING_CHARSET

      public static final org.apache.sshd.common.Property<Charset> SHELL_ENVVARS_ENCODING_CHARSET
      Used to indicate the Charset (or its name) for handling environment values in ScpShell - extracted from the channel session when shell initialized.

    • SHELL_NAME_DECODING_CHARSET

      public static final org.apache.sshd.common.Property<Charset> SHELL_NAME_DECODING_CHARSET
      Used to indicate the Charset (or its name) for decoding incoming commands to be processed by the ScpShell - extracted from the channel session when shell initialized.