Top Description Fields Constructors Methods
org.apache.sshd.scp

public final Class ScpModuleProperties

extends Object
Class Inheritance
Imports
java.nio.charset.Charset, .StandardCharsets, java.time.Duration, org.apache.sshd.common.Property

Configurable properties for sshd-scp.
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
public static final Property<Boolean>
ENABLE_SCP_SHELL

Whether to provide an ScpShell instance if WinSCP client detected or at all

public static final Property<Boolean>
PROP_AUTO_SYNC_FILE_ON_WRITE

Whether to synchronize written file data with underlying file-system

public static final 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.

public static final 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.

public static final 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).

public static final 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).

public static final 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.

public static final 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.

public static final 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.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ENABLE_SCP_SHELLback to summary
public static final Property<Boolean> ENABLE_SCP_SHELL

Whether to provide an ScpShell instance if WinSCP client detected or at all

See Also
SSHD-1009, SSHD-1283
PROP_AUTO_SYNC_FILE_ON_WRITEback to summary
public static final Property<Boolean> PROP_AUTO_SYNC_FILE_ON_WRITE

Whether to synchronize written file data with underlying file-system

SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUTback to summary
public static final 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_EXEC_CHANNEL_OPEN_TIMEOUTback to summary
public static final 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_INCOMING_ENCODINGback to summary
public static final 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_ENCODINGback to summary
public static final 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).

SHELL_ENVVARS_ENCODING_CHARSETback to summary
public static final 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_CHARSETback to summary
public static final 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.

SHELL_NAME_ENCODING_CHARSETback to summary
public static final 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.

Constructor Detail

ScpModulePropertiesback to summary
private ScpModuleProperties()