Uses of Interface
org.apache.sshd.common.Property
Packages that use Property
Package
Description
-
Uses of Property in org.apache.sshd.client.config
Fields in org.apache.sshd.client.config declared as PropertyModifier and TypeFieldDescriptionSshClientConfigFileReader.CLIENT_LIVECHECK_INTERVAL_PROP
SshClientConfigFileReader.CLIENT_LIVECHECK_REPLIES_WAIT
SshClientConfigFileReader.CLIENT_LIVECHECK_USE_NULLS
-
Uses of Property in org.apache.sshd.common
Classes in org.apache.sshd.common that implement PropertyModifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
Property.EnumProperty<T extends Enum<T>>
static class
static class
static class
static class
static class
Fields in org.apache.sshd.common declared as PropertyModifier and TypeFieldDescriptionCommonModuleProperties.ALLOW_INSECURE_AUTH
If set totrue
thenUserAuthMethodFactory.isSecureAuthenticationTransport(SessionContext)
returnstrue
even if transport is insecure.CommonModuleProperties.ALLOW_NON_INTEGRITY_AUTH
If set totrue
thenUserAuthMethodFactory.isDataIntegrityAuthenticationTransport(SessionContext)
returnstrue
even if transport has no MAC(s) to verify message integrityCommonModuleProperties.CLOSE_WAIT_TIMEOUT
Timeout (milliseconds) for waiting on aCloseFuture
to successfully complete its action.Property.Validating.delegate
CommonModuleProperties.HEXDUMP_CHUNK_SIZE
CommonModuleProperties.SESSION_HEARTBEAT_INTERVAL
Property used to register the interval for the heartbeat - if not set or non-positive then disabledstatic final Property
<SessionHeartbeatController.HeartbeatType> CommonModuleProperties.SESSION_HEARTBEAT_TYPE
Property used to register theSessionHeartbeatController.HeartbeatType
- if non-existent orNONE
then disabled.Methods in org.apache.sshd.common that return PropertyModifier and TypeMethodDescriptionProperty.durationSec
(String name) Property.durationSec
(String name, Duration def) Property.durationSec
(String name, Duration def, Duration min) static <T> Property
<T> Property.validating
(Property<T> prop, Consumer<? super T> validator) Methods in org.apache.sshd.common with parameters of type PropertyModifier and TypeMethodDescriptionstatic <T> Property
<T> Property.validating
(Property<T> prop, Consumer<? super T> validator) Constructors in org.apache.sshd.common with parameters of type Property -
Uses of Property in org.apache.sshd.common.io.nio2
Fields in org.apache.sshd.common.io.nio2 with type parameters of type PropertyModifier and TypeFieldDescriptionstatic final Map
<Property<?>, AbstractMap.SimpleImmutableEntry<SocketOption<?>, Object>> Nio2Service.CONFIGURABLE_OPTIONS
Methods in org.apache.sshd.common.io.nio2 with parameters of type PropertyModifier and TypeMethodDescriptionprotected <T> boolean
Nio2Service.setOption
(NetworkChannel socket, Property<?> property, SocketOption<T> option, T defaultValue) -
Uses of Property in org.apache.sshd.core
Fields in org.apache.sshd.core declared as PropertyModifier and TypeFieldDescriptionCoreModuleProperties.ABORT_ON_INVALID_CERTIFICATE
Defines if we should abort in case we encounter an invalid (e.g.CoreModuleProperties.ALLOW_DHG1_KEX_FALLBACK
Whether allowed to fall back to DH group with SHA-1 KEX if exhausted all available primes for SHA-256.CoreModuleProperties.AUTH_METHODS
This key is used when configuring multi-step authentications.CoreModuleProperties.AUTH_SOCKET_TIMEOUT
Property that can be set on theSession
in order to control the authentication timeout (millis).CoreModuleProperties.AUTH_TIMEOUT
Key used to retrieve the value of the timeout after which it will close the connection if the other side has not been authenticated - in milliseconds.CoreModuleProperties.BUFFER_SIZE
Value used by theInvertedShellWrapper
to control copy buffer size.CoreModuleProperties.BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_SIZE
Key used when creating aBufferedIoOutputStream
in order to specify max.CoreModuleProperties.BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_WAIT
Key used when creating aBufferedIoOutputStream
in order to specify max.CoreModuleProperties.CHANNEL_CLOSE_TIMEOUT
Key used to configure the timeout used when writing a close request on a channel.CoreModuleProperties.CHANNEL_OPEN_TIMEOUT
Value that can be set on theFactoryManager
or the session to configure the channel open timeout value (millis).CoreModuleProperties.CLIENT_IDENTIFICATION
Key used to retrieve the value of the client identification string.CoreModuleProperties.COMMAND_EXIT_TIMEOUT
Key used to configure the timeout used when receiving a close request on a channel to wait until the command cleanly exits after setting an EOF on the input stream.CoreModuleProperties.DISCONNECT_TIMEOUT
Key used to retrieve the value of the disconnect timeout which is used when a disconnection is attempted.CoreModuleProperties.FORWARD_REQUEST_TIMEOUT
Used to configure the timeout (milliseconds) for receiving a response for the forwarding requestCoreModuleProperties.FORWARDER_BUFFER_SIZE
Property that can be set on the factory manager in order to control the buffer size used to forward data from the established channelCoreModuleProperties.HEARTBEAT_INTERVAL
Key used to set the heartbeat interval in milliseconds (0 to disable = default)CoreModuleProperties.HEARTBEAT_NO_REPLY_MAX
Key to set the maximum number of heartbeat messages to send without having received a reply.CoreModuleProperties.HEARTBEAT_REPLY_WAIT
Deprecated.CoreModuleProperties.HEARTBEAT_REQUEST
Key used to check the heartbeat request that should be sent to the serverCoreModuleProperties.IDLE_TIMEOUT
Key used to retrieve the value of idle timeout after which it will close the connection - in milliseconds.CoreModuleProperties.IGNORE_INVALID_IDENTITIES
Whether to ignore invalid identities files when pre-initializing the client sessionCoreModuleProperties.IGNORE_MESSAGE_FREQUENCY
Average number of packets to be skipped before anSSH_MSG_IGNORE
message is inserted in the stream.CoreModuleProperties.IGNORE_MESSAGE_SIZE
Minimum size ofSSH_MSG_IGNORE
payload to send if feature enabled.CoreModuleProperties.IGNORE_MESSAGE_VARIANCE
The variance to be used around the configuredCoreModuleProperties.IGNORE_MESSAGE_FREQUENCY
value in order to avoid insertion at a set frequency.CoreModuleProperties.INPUT_STREAM_PUMP_CHUNK_SIZE
On some platforms, a call to always throws anIOException
.CoreModuleProperties.INTERACTIVE_LANGUAGE_TAG
As per RFC-4256: The language tag is deprecated and SHOULD be the empty string.CoreModuleProperties.INTERACTIVE_SUBMETHODS
As per RFC-4256: The submethods field is included so the user can give a hint of which actual methods to use.CoreModuleProperties.IO_CONNECT_TIMEOUT
Key used to retrieve the value of the socket connect time-out.CoreModuleProperties.KB_SERVER_INTERACTIVE_ECHO_PROMPT
CoreModuleProperties.KB_SERVER_INTERACTIVE_INSTRUCTION
CoreModuleProperties.KB_SERVER_INTERACTIVE_LANG
CoreModuleProperties.KB_SERVER_INTERACTIVE_NAME
CoreModuleProperties.KB_SERVER_INTERACTIVE_PROMPT
CoreModuleProperties.KEX_PROPOSAL_SETUP_TIMEOUT
Deprecated.since 2.14.0CoreModuleProperties.LIMIT_PACKET_SIZE
A safety value that is designed to avoid an attack that uses large channel packet sizesCoreModuleProperties.MAX_AUTH_REQUESTS
Key used to retrieve the value in the configuration properties map of the maximum number of failed authentication requests before the server closes the connection.CoreModuleProperties.MAX_CONCURRENT_CHANNELS
Property that can be used to configure max.CoreModuleProperties.MAX_CONCURRENT_SESSIONS
Key used to retrieve the value of the maximum concurrent open session count per username.CoreModuleProperties.MAX_EXTDATA_BUFSIZE
Maximum amount of extended (a.k.a.CoreModuleProperties.MAX_IDENTIFICATION_SIZE
Maximum allowed size of the initial identification text sent during the handshakeCoreModuleProperties.MAX_PACKET_SIZE
Key used to retrieve the value of the maximum packet size in the configuration properties map.CoreModuleProperties.MAX_PROXY_JUMPS
Configuration value for the maximum number of proxy jumps to allow in an SSH connection; by default 10.CoreModuleProperties.MIN_READ_BUFFER_SIZE
Minimum read buffer size in bytes.CoreModuleProperties.MODULI_URL
A URL pointing to the moduli file.CoreModuleProperties.NIO_WORKERS
Number of NIO worker threads to use.CoreModuleProperties.NIO2_MIN_WRITE_TIMEOUT
Minimum NIO2 write wait timeout for a single outgoing packet - in millisecondsCoreModuleProperties.NIO2_READ_BUFFER_SIZE
Read buffer size in bytes.CoreModuleProperties.NIO2_READ_TIMEOUT
Key used to retrieve the value of the socket read timeout for NIO2 session implementation - in milliseconds.CoreModuleProperties.PASSWORD_PROMPTS
Specifies the number of interactive attempts at password or keyboard-interactive user authentication before giving up.CoreModuleProperties.PREFER_UNIX_AGENT
CoreModuleProperties.PREFERRED_AUTHS
Ordered comma separated list of authentications methods.CoreModuleProperties.PROP_DHGEX_CLIENT_MAX_KEY
CoreModuleProperties.PROP_DHGEX_CLIENT_MIN_KEY
CoreModuleProperties.PROP_DHGEX_CLIENT_PRF_KEY
CoreModuleProperties.PROP_DHGEX_SERVER_MAX_KEY
SeeDHGEXServer
.CoreModuleProperties.PROP_DHGEX_SERVER_MIN_KEY
SeeDHGEXServer
.CoreModuleProperties.PROXY_AUTH_CHANNEL_TYPE
Value that can be set in order to control the type of authentication channel being requested when forwarding a PTY session.CoreModuleProperties.PROXY_CHANNEL_TYPE
Value used to configure the type of proxy forwarding channel to be used.CoreModuleProperties.PUMP_SLEEP_TIME
Value used by theInvertedShellWrapper
to control the "busy-wait" sleep time (millis) on the pumping loop if nothing was pumped - must be positive.CoreModuleProperties.REKEY_BLOCKS_LIMIT
Key re-exchange will be automatically performed after the specified number of cipher blocks has been processed - positive 64-bit value.CoreModuleProperties.REKEY_BYTES_LIMIT
Key re-exchange will be automatically performed after the session has sent or received the given amount of bytes.CoreModuleProperties.REKEY_PACKETS_LIMIT
Key re-exchange will be automatically performed after the specified number of packets has been exchanged - positive 64-bit value.CoreModuleProperties.REKEY_TIME_LIMIT
Key re-exchange will be automatically performed after the specified amount of time has elapsed since the last key exchange - in milliseconds.CoreModuleProperties.REQUEST_EXEC_REPLY
Configure whether reply for the "exec" request is requiredCoreModuleProperties.REQUEST_SHELL_REPLY
Configure whether reply for the "shell" request is requiredCoreModuleProperties.REQUEST_SUBSYSTEM_REPLY
Configure whether reply for the "subsystem&quoot; request is requiredCoreModuleProperties.SEND_IMMEDIATE_IDENTIFICATION
Whether to send the identification string immediately upon session connection being established or wait for the server's identification before sending our own.CoreModuleProperties.SEND_IMMEDIATE_KEXINIT
Whether to sendSSH_MSG_KEXINIT
immediately after sending the client identification string or wait until the severer's one has been received.CoreModuleProperties.SEND_REPLY_FOR_CHANNEL_DATA
RFC4254 does not clearly specify how to handleSSH_MSG_CHANNEL_DATA
andSSH_MSG_CHANNEL_EXTENDED_DATA
received through an unknown channel.CoreModuleProperties.SERVER_EXTRA_IDENTIFICATION_LINES
Key used to retrieve any extra lines to be sent during initial protocol handshake before the identification.CoreModuleProperties.SERVER_IDENTIFICATION
Key used to retrieve the value of the server identification string.CoreModuleProperties.SOCKET_BACKLOG
Socket backlog.CoreModuleProperties.SOCKET_KEEPALIVE
Socket keep-alive.CoreModuleProperties.SOCKET_LINGER
Socket linger.CoreModuleProperties.SOCKET_RCVBUF
Socket receive buffer size.CoreModuleProperties.SOCKET_REUSEADDR
Socket reuse address.CoreModuleProperties.SOCKET_SNDBUF
Socket send buffer size.CoreModuleProperties.STOP_WAIT_TIME
Timeout (milliseconds) to wait for client / server stop request if immediate stop requested.CoreModuleProperties.TCP_NODELAY
Socket tcp no-delay.CoreModuleProperties.WAIT_FOR_SPACE_TIMEOUT
Configure max.CoreModuleProperties.WELCOME_BANNER
Key used to retrieve the value of welcome banner that will be displayed when a user connects to the server.CoreModuleProperties.WELCOME_BANNER_CHARSET
The charset to use if the configured welcome banner points to a file - if not specified (either as a string or aCharset
then the local default is used.CoreModuleProperties.WELCOME_BANNER_LANGUAGE
Key used to denote the language code for the welcome banner (if such a banner is configured).static final Property
<WelcomeBannerPhase> CoreModuleProperties.WELCOME_BANNER_PHASE
TheWelcomeBannerPhase
value - either as an enum or a stringCoreModuleProperties.WINDOW_SIZE
Key used to retrieve the value of the channel window size in the configuration properties map.CoreModuleProperties.WINDOW_TIMEOUT
Key used to retrieve timeout (msec.) to wait for data to become available when reading from a channel.CoreModuleProperties.X11_BASE_PORT
Configuration value for theX11ForwardSupport
to control the base port number for the X11 display number socket binding.CoreModuleProperties.X11_BIND_HOST
Configuration value for theX11ForwardSupport
to control the host used to bind to for the X11 display when looking for a free port.CoreModuleProperties.X11_DISPLAY_OFFSET
Configuration value for theX11ForwardSupport
to control from which X11 display number to start looking for a free value.CoreModuleProperties.X11_MAX_DISPLAYS
Configuration value for theX11ForwardSupport
to control up to which (but not including) X11 display number to look or a free value.CoreModuleProperties.X11_OPEN_TIMEOUT
Configuration value for theX11ForwardSupport
to control the channel open timeout. -
Uses of Property in org.apache.sshd.scp
Fields in org.apache.sshd.scp declared as PropertyModifier and TypeFieldDescriptionScpModuleProperties.ENABLE_SCP_SHELL
Whether to provide anScpShell
instance if WinSCP client detected or at allScpModuleProperties.PROP_AUTO_SYNC_FILE_ON_WRITE
Whether to synchronize written file data with underlying file-systemScpModuleProperties.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.ScpModuleProperties.SCP_EXEC_CHANNEL_OPEN_TIMEOUT
Configurable value of the for controlling the wait timeout for opening a channel for an SCP command in milliseconds.ScpModuleProperties.SCP_INCOMING_ENCODING
Used to indicate theCharset
(or its name) for decoding incoming commands/responses sent by the peer (either client or server).ScpModuleProperties.SCP_OUTGOING_ENCODING
Used to indicate theCharset
(or its name) for encoding outgoing commands/responses sent to the peer (either client or server).ScpModuleProperties.SHELL_ENVVARS_ENCODING_CHARSET
Used to indicate theCharset
(or its name) for handling environment values inScpShell
- extracted from the channel session when shell initialized.ScpModuleProperties.SHELL_NAME_DECODING_CHARSET
Used to indicate theCharset
(or its name) for decoding incoming commands to be processed by theScpShell
- extracted from the channel session when shell initialized.ScpModuleProperties.SHELL_NAME_ENCODING_CHARSET
Used to indicate theCharset
(or its name) for encoding returned textual responses from theScpShell
- extracted from the channel session when shell initialized. -
Uses of Property in org.apache.sshd.server.config
Fields in org.apache.sshd.server.config declared as PropertyModifier and TypeFieldDescriptionSshServerConfigFileReader.ALLOW_AGENT_FORWARDING_CONFIG_PROP
SshServerConfigFileReader.ALLOW_TCP_FORWARDING_CONFIG_PROP
SshServerConfigFileReader.ALLOW_X11_FORWARDING_CONFIG_PROP
SshServerConfigFileReader.BANNER_CONFIG_PROP
SshServerConfigFileReader.SERVER_ALIVE_INTERVAL_PROP
SshServerConfigFileReader.SFTP_FORCED_VERSION_PROP
SshServerConfigFileReader.VISUAL_HOST_KEY
-
Uses of Property in org.apache.sshd.sftp
Fields in org.apache.sshd.sftp declared as PropertyModifier and TypeFieldDescriptionSftpModuleProperties.ACL_SUPPORTED_MASK
Comma separate list ofSSH_ACL_CAP_xxx
names - where name can be without the prefix.SftpModuleProperties.APPEND_END_OF_LIST_INDICATOR
Used to control whether to append the end-of-list indicator for SSH_FXP_NAME responses viaSftpHelper.indicateEndOfNamesList(Buffer, int, PropertyResolver, boolean)
call, as indicated by SFTP v6 - section 9.4SftpModuleProperties.AUTH_TIME
SftpModuleProperties.AUTO_FOLLOW_LINKS
Whether to automatically follow symbolic links when resolving pathsSftpModuleProperties.CLIENT_EXTENSIONS
Allows controlling reports of which client extensions are supported (and reported via "support" and "support2" server extensions) as a comma-separate list of names.SftpModuleProperties.CONNECT_TIME
SftpModuleProperties.COPY_BUF_SIZE
Internal allocate buffer size when copying data to/from the channelSftpModuleProperties.FILE_HANDLE_SIZE
Size in bytes of the opaque handle valueSftpModuleProperties.MAX_FILE_HANDLE_RAND_ROUNDS
Max.SftpModuleProperties.MAX_OPEN_HANDLES_PER_SESSION
Properties key for the maximum of available open handles per session.SftpModuleProperties.MAX_READDATA_PACKET_LENGTH
Force the use of a max.SftpModuleProperties.MAX_READDIR_DATA_SIZE
Maximum amount of data allocated for listing the contents of a directory in any single invocation ofSftpSubsystem.doReadDir(Buffer, int)
SftpModuleProperties.MAX_WRITEDATA_PACKET_LENGTH
Force the use of a max.SftpModuleProperties.NAME_DECODER_CHARSET
SftpModuleProperties.NAME_DECODING_CHARSET
Used to indicate theCharset
(or its name) for decoding referenced files/folders names - extracted from the client session when 1st initialized.SftpModuleProperties.NEWLINE_VALUE
Property that can be used to set the reported NL value.SftpModuleProperties.OPENSSH_EXTENSIONS
Comma-separated list of whichOpenSSH
extensions are reported and what version is reported for each - format:name=version
.SftpModuleProperties.POOL_CORE_SIZE
If >= 0, that many channels may be kept open in the channel pool of anSftpFileSystem
even if they are idle; by default 1.SftpModuleProperties.POOL_LIFE_TIME
A timeout after which idle channels in the pool of anSftpFileSystem
are removed from the pool and closed; by default 10 seconds.SftpModuleProperties.POOL_SIZE
The maximum size of the channel pool used by anSftpFileSystem
; by default 8.SftpModuleProperties.READ_BUFFER_SIZE
SftpModuleProperties.SFTP_CHANNEL_OPEN_TIMEOUT
Property that can be used on theFactoryManager
to control the internal timeout used by the client to open a channel.SftpModuleProperties.SFTP_VERSION
Force the use of a given sftp versionSftpModuleProperties.TOLERATE_EXCESS_DATA
Apparently some SFTP servers may return more data than requested in SFTP read requests.SftpModuleProperties.WRITE_BUFFER_SIZE
SftpModuleProperties.WRITE_CHUNK_SIZE
Property used to avoid large buffers whenAbstractSftpClient.write(SftpClient.Handle, long, byte[], int, int)
is invoked with a large buffer size. -
Uses of Property in org.apache.sshd.sftp.client.impl
Fields in org.apache.sshd.sftp.client.impl declared as PropertyModifier and TypeFieldDescriptionAbstractSftpClient.SFTP_CLIENT_CMD_TIMEOUT
Property that can be used on theFactoryManager
to control the internal timeout used by the client to complete the buffer sending inRawSftpClient.send(int, Buffer)
.
CoreModuleProperties.HEARTBEAT_NO_REPLY_MAX
instead