Class ScpModuleProperties


  • public final class ScpModuleProperties
    extends java.lang.Object
    Configurable properties for sshd-scp.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Property<java.lang.Boolean> ENABLE_SCP_SHELL
      Whether to provide an ScpShell instance if WinSCP client detected or at all
      static Property<java.lang.Boolean> PROP_AUTO_SYNC_FILE_ON_WRITE
      Whether to synchronize written file data with underlying file-system
      static Property<java.time.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 Property<java.time.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 Property<java.nio.charset.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 Property<java.nio.charset.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 Property<java.nio.charset.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 Property<java.nio.charset.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 Property<java.nio.charset.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.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private ScpModuleProperties()  
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • SCP_EXEC_CHANNEL_OPEN_TIMEOUT

        public static final Property<java.time.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 Property<java.time.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 Property<java.nio.charset.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 Property<java.nio.charset.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 Property<java.lang.Boolean> PROP_AUTO_SYNC_FILE_ON_WRITE
        Whether to synchronize written file data with underlying file-system
      • ENABLE_SCP_SHELL

        public static final Property<java.lang.Boolean> ENABLE_SCP_SHELL
        Whether to provide an ScpShell instance if WinSCP client detected or at all
        See Also:
        SSHD-1009, SSHD-1283
      • SHELL_NAME_ENCODING_CHARSET

        public static final Property<java.nio.charset.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 Property<java.nio.charset.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 Property<java.nio.charset.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.
    • Constructor Detail

      • ScpModuleProperties

        private ScpModuleProperties()