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_PROPSshClientConfigFileReader.CLIENT_LIVECHECK_REPLIES_WAITSshClientConfigFileReader.CLIENT_LIVECHECK_USE_NULLS -
Uses of Property in org.apache.sshd.common
Classes in org.apache.sshd.common that implement PropertyModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classProperty.EnumProperty<T extends Enum<T>>static classstatic classstatic classstatic classstatic classFields in org.apache.sshd.common declared as PropertyModifier and TypeFieldDescriptionCommonModuleProperties.ALLOW_INSECURE_AUTHIf set totruethenUserAuthMethodFactory.isSecureAuthenticationTransport(SessionContext)returnstrueeven if transport is insecure.CommonModuleProperties.ALLOW_NON_INTEGRITY_AUTHIf set totruethenUserAuthMethodFactory.isDataIntegrityAuthenticationTransport(SessionContext)returnstrueeven if transport has no MAC(s) to verify message integrityCommonModuleProperties.CLOSE_WAIT_TIMEOUTTimeout (milliseconds) for waiting on aCloseFutureto successfully complete its action.Property.Validating.delegateCommonModuleProperties.HEXDUMP_CHUNK_SIZECommonModuleProperties.SESSION_HEARTBEAT_INTERVALProperty used to register the interval for the heartbeat - if not set or non-positive then disabledstatic final Property<SessionHeartbeatController.HeartbeatType> CommonModuleProperties.SESSION_HEARTBEAT_TYPEProperty used to register theSessionHeartbeatController.HeartbeatType- if non-existent orNONEthen 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_OPTIONSMethods in org.apache.sshd.common.io.nio2 with parameters of type PropertyModifier and TypeMethodDescriptionprotected <T> booleanNio2Service.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_CERTIFICATEDefines if we should abort in case we encounter an invalid (e.g.CoreModuleProperties.ALLOW_DHG1_KEX_FALLBACKWhether allowed to fall back to DH group with SHA-1 KEX if exhausted all available primes for SHA-256.CoreModuleProperties.AUTH_METHODSThis key is used when configuring multi-step authentications.CoreModuleProperties.AUTH_SOCKET_TIMEOUTProperty that can be set on theSessionin order to control the authentication timeout (millis).CoreModuleProperties.AUTH_TIMEOUTKey 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_SIZEValue used by theInvertedShellWrapperto control copy buffer size.CoreModuleProperties.BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_SIZEKey used when creating aBufferedIoOutputStreamin order to specify max.CoreModuleProperties.BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_WAITKey used when creating aBufferedIoOutputStreamin order to specify max.CoreModuleProperties.CHANNEL_CLOSE_TIMEOUTKey used to configure the timeout used when writing a close request on a channel.CoreModuleProperties.CHANNEL_OPEN_TIMEOUTValue that can be set on theFactoryManageror the session to configure the channel open timeout value (millis).CoreModuleProperties.CLIENT_IDENTIFICATIONKey used to retrieve the value of the client identification string.CoreModuleProperties.COMMAND_EXIT_TIMEOUTKey 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_TIMEOUTKey used to retrieve the value of the disconnect timeout which is used when a disconnection is attempted.CoreModuleProperties.FORWARD_REQUEST_TIMEOUTUsed to configure the timeout (milliseconds) for receiving a response for the forwarding requestCoreModuleProperties.FORWARDER_BUFFER_SIZEProperty that can be set on the factory manager in order to control the buffer size used to forward data from the established channelCoreModuleProperties.HEARTBEAT_INTERVALKey used to set the heartbeat interval in milliseconds (0 to disable = default)CoreModuleProperties.HEARTBEAT_REPLY_WAITKey used to indicate that the heartbeat request is also expecting a reply - time in milliseconds to wait for the reply.CoreModuleProperties.HEARTBEAT_REQUESTKey used to check the heartbeat request that should be sent to the serverCoreModuleProperties.IDLE_TIMEOUTKey used to retrieve the value of idle timeout after which it will close the connection - in milliseconds.CoreModuleProperties.IGNORE_INVALID_IDENTITIESWhether to ignore invalid identities files when pre-initializing the client sessionCoreModuleProperties.IGNORE_MESSAGE_FREQUENCYAverage number of packets to be skipped before anSSH_MSG_IGNOREmessage is inserted in the stream.CoreModuleProperties.IGNORE_MESSAGE_SIZEMinimum size ofSSH_MSG_IGNOREpayload to send if feature enabled.CoreModuleProperties.IGNORE_MESSAGE_VARIANCEThe variance to be used around the configuredCoreModuleProperties.IGNORE_MESSAGE_FREQUENCYvalue in order to avoid insertion at a set frequency.CoreModuleProperties.INPUT_STREAM_PUMP_CHUNK_SIZEOn some platforms, a call to always throws anIOException.CoreModuleProperties.INTERACTIVE_LANGUAGE_TAGAs per RFC-4256: The language tag is deprecated and SHOULD be the empty string.CoreModuleProperties.INTERACTIVE_SUBMETHODSAs per RFC-4256: The submethods field is included so the user can give a hint of which actual methods to use.CoreModuleProperties.IO_CONNECT_TIMEOUTKey used to retrieve the value of the socket connect time-out.CoreModuleProperties.KB_SERVER_INTERACTIVE_ECHO_PROMPTCoreModuleProperties.KB_SERVER_INTERACTIVE_INSTRUCTIONCoreModuleProperties.KB_SERVER_INTERACTIVE_LANGCoreModuleProperties.KB_SERVER_INTERACTIVE_NAMECoreModuleProperties.KB_SERVER_INTERACTIVE_PROMPTCoreModuleProperties.KEX_PROPOSAL_SETUP_TIMEOUTIf the peer initiates a key exchange, we send our own KEX_INIT message with the proposal.CoreModuleProperties.LIMIT_PACKET_SIZEA safety value that is designed to avoid an attack that uses large channel packet sizesCoreModuleProperties.MAX_AUTH_REQUESTSKey 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_CHANNELSProperty that can be used to configure max.CoreModuleProperties.MAX_CONCURRENT_SESSIONSKey used to retrieve the value of the maximum concurrent open session count per username.CoreModuleProperties.MAX_EXTDATA_BUFSIZEMaximum amount of extended (a.k.a.CoreModuleProperties.MAX_IDENTIFICATION_SIZEMaximum allowed size of the initial identification text sent during the handshakeCoreModuleProperties.MAX_PACKET_SIZEKey used to retrieve the value of the maximum packet size in the configuration properties map.CoreModuleProperties.MIN_READ_BUFFER_SIZEMinimum read buffer size in bytes.CoreModuleProperties.MODULI_URLA URL pointing to the moduli file.CoreModuleProperties.NIO_WORKERSNumber of NIO worker threads to use.CoreModuleProperties.NIO2_MIN_WRITE_TIMEOUTMinimum NIO2 write wait timeout for a single outgoing packet - in millisecondsCoreModuleProperties.NIO2_READ_BUFFER_SIZERead buffer size in bytes.CoreModuleProperties.NIO2_READ_TIMEOUTKey used to retrieve the value of the socket read timeout for NIO2 session implementation - in milliseconds.CoreModuleProperties.PASSWORD_PROMPTSSpecifies the number of interactive attempts at password or keyboard-interactive user authentication before giving up.CoreModuleProperties.PREFER_UNIX_AGENTCoreModuleProperties.PREFERRED_AUTHSOrdered comma separated list of authentications methods.CoreModuleProperties.PROP_DHGEX_CLIENT_MAX_KEYCoreModuleProperties.PROP_DHGEX_CLIENT_MIN_KEYCoreModuleProperties.PROP_DHGEX_CLIENT_PRF_KEYCoreModuleProperties.PROP_DHGEX_SERVER_MAX_KEYSeeDHGEXServer.CoreModuleProperties.PROP_DHGEX_SERVER_MIN_KEYSeeDHGEXServer.CoreModuleProperties.PROXY_AUTH_CHANNEL_TYPEValue that can be set in order to control the type of authentication channel being requested when forwarding a PTY session.CoreModuleProperties.PROXY_CHANNEL_TYPEValue used to configure the type of proxy forwarding channel to be used.CoreModuleProperties.PUMP_SLEEP_TIMEValue used by theInvertedShellWrapperto control the "busy-wait" sleep time (millis) on the pumping loop if nothing was pumped - must be positive.CoreModuleProperties.REKEY_BLOCKS_LIMITKey re-exchange will be automatically performed after the specified number of cipher blocks has been processed - positive 64-bit value.CoreModuleProperties.REKEY_BYTES_LIMITKey re-exchange will be automatically performed after the session has sent or received the given amount of bytes.CoreModuleProperties.REKEY_PACKETS_LIMITKey re-exchange will be automatically performed after the specified number of packets has been exchanged - positive 64-bit value.CoreModuleProperties.REKEY_TIME_LIMITKey re-exchange will be automatically performed after the specified amount of time has elapsed since the last key exchange - in milliseconds.CoreModuleProperties.REQUEST_EXEC_REPLYConfigure whether reply for the "exec" request is requiredCoreModuleProperties.REQUEST_SHELL_REPLYConfigure whether reply for the "shell" request is requiredCoreModuleProperties.REQUEST_SUBSYSTEM_REPLYConfigure whether reply for the "subsystem&quoot; request is requiredCoreModuleProperties.SEND_IMMEDIATE_IDENTIFICATIONWhether 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_KEXINITWhether to sendSSH_MSG_KEXINITimmediately after sending the client identification string or wait until the severer's one has been received.CoreModuleProperties.SEND_REPLY_FOR_CHANNEL_DATARFC4254 does not clearly specify how to handleSSH_MSG_CHANNEL_DATAandSSH_MSG_CHANNEL_EXTENDED_DATAreceived through an unknown channel.CoreModuleProperties.SERVER_EXTRA_IDENTIFICATION_LINESKey used to retrieve any extra lines to be sent during initial protocol handshake before the identification.CoreModuleProperties.SERVER_IDENTIFICATIONKey used to retrieve the value of the server identification string.CoreModuleProperties.SOCKET_BACKLOGSocket backlog.CoreModuleProperties.SOCKET_KEEPALIVESocket keep-alive.CoreModuleProperties.SOCKET_LINGERSocket linger.CoreModuleProperties.SOCKET_RCVBUFSocket receive buffer size.CoreModuleProperties.SOCKET_REUSEADDRSocket reuse address.CoreModuleProperties.SOCKET_SNDBUFSocket send buffer size.CoreModuleProperties.STOP_WAIT_TIMETimeout (milliseconds) to wait for client / server stop request if immediate stop requested.CoreModuleProperties.TCP_NODELAYSocket tcp no-delay.CoreModuleProperties.WAIT_FOR_SPACE_TIMEOUTConfigure max.CoreModuleProperties.WELCOME_BANNERKey used to retrieve the value of welcome banner that will be displayed when a user connects to the server.CoreModuleProperties.WELCOME_BANNER_CHARSETThe charset to use if the configured welcome banner points to a file - if not specified (either as a string or aCharsetthen the local default is used.CoreModuleProperties.WELCOME_BANNER_LANGUAGEKey used to denote the language code for the welcome banner (if such a banner is configured).static final Property<WelcomeBannerPhase> CoreModuleProperties.WELCOME_BANNER_PHASETheWelcomeBannerPhasevalue - either as an enum or a stringCoreModuleProperties.WINDOW_SIZEKey used to retrieve the value of the channel window size in the configuration properties map.CoreModuleProperties.WINDOW_TIMEOUTKey used to retrieve timeout (msec.) to wait for data to become available when reading from a channel.CoreModuleProperties.X11_BASE_PORTConfiguration value for theX11ForwardSupportto control the base port number for the X11 display number socket binding.CoreModuleProperties.X11_BIND_HOSTConfiguration value for theX11ForwardSupportto control the host used to bind to for the X11 display when looking for a free port.CoreModuleProperties.X11_DISPLAY_OFFSETConfiguration value for theX11ForwardSupportto control from which X11 display number to start looking for a free value.CoreModuleProperties.X11_MAX_DISPLAYSConfiguration value for theX11ForwardSupportto control up to which (but not including) X11 display number to look or a free value.CoreModuleProperties.X11_OPEN_TIMEOUTConfiguration value for theX11ForwardSupportto 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_SHELLWhether to provide anScpShellinstance if WinSCP client detected or at allScpModuleProperties.PROP_AUTO_SYNC_FILE_ON_WRITEWhether to synchronize written file data with underlying file-systemScpModuleProperties.SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUTConfigurable value for controlling the wait timeout for waiting on a channel exit status' for an SCP command in milliseconds.ScpModuleProperties.SCP_EXEC_CHANNEL_OPEN_TIMEOUTConfigurable value of the for controlling the wait timeout for opening a channel for an SCP command in milliseconds.ScpModuleProperties.SCP_INCOMING_ENCODINGUsed to indicate theCharset(or its name) for decoding incoming commands/responses sent by the peer (either client or server).ScpModuleProperties.SCP_OUTGOING_ENCODINGUsed to indicate theCharset(or its name) for encoding outgoing commands/responses sent to the peer (either client or server).ScpModuleProperties.SHELL_ENVVARS_ENCODING_CHARSETUsed to indicate theCharset(or its name) for handling environment values inScpShell- extracted from the channel session when shell initialized.ScpModuleProperties.SHELL_NAME_DECODING_CHARSETUsed 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_CHARSETUsed 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_PROPSshServerConfigFileReader.ALLOW_TCP_FORWARDING_CONFIG_PROPSshServerConfigFileReader.ALLOW_X11_FORWARDING_CONFIG_PROPSshServerConfigFileReader.BANNER_CONFIG_PROPSshServerConfigFileReader.SERVER_ALIVE_INTERVAL_PROPSshServerConfigFileReader.SFTP_FORCED_VERSION_PROPSshServerConfigFileReader.VISUAL_HOST_KEY -
Uses of Property in org.apache.sshd.sftp
Fields in org.apache.sshd.sftp declared as PropertyModifier and TypeFieldDescriptionSftpModuleProperties.ACL_SUPPORTED_MASKComma separate list ofSSH_ACL_CAP_xxxnames - where name can be without the prefix.SftpModuleProperties.APPEND_END_OF_LIST_INDICATORUsed 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_TIMESftpModuleProperties.AUTO_FOLLOW_LINKSWhether to automatically follow symbolic links when resolving pathsSftpModuleProperties.CLIENT_EXTENSIONSAllows 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_TIMESftpModuleProperties.COPY_BUF_SIZEInternal allocate buffer size when copying data to/from the channelSftpModuleProperties.FILE_HANDLE_SIZESize in bytes of the opaque handle valueSftpModuleProperties.MAX_FILE_HANDLE_RAND_ROUNDSMax.SftpModuleProperties.MAX_OPEN_HANDLES_PER_SESSIONProperties key for the maximum of available open handles per session.SftpModuleProperties.MAX_READDATA_PACKET_LENGTHForce the use of a max.SftpModuleProperties.MAX_READDIR_DATA_SIZEMaximum amount of data allocated for listing the contents of a directory in any single invocation ofSftpSubsystem.doReadDir(Buffer, int)SftpModuleProperties.MAX_WRITEDATA_PACKET_LENGTHForce the use of a max.SftpModuleProperties.NAME_DECODER_CHARSETSftpModuleProperties.NAME_DECODING_CHARSETUsed to indicate theCharset(or its name) for decoding referenced files/folders names - extracted from the client session when 1st initialized.SftpModuleProperties.NEWLINE_VALUEProperty that can be used to set the reported NL value.SftpModuleProperties.OPENSSH_EXTENSIONSComma-separated list of whichOpenSSHextensions are reported and what version is reported for each - format:name=version.SftpModuleProperties.POOL_CORE_SIZEIf >= 0, that many channels may be kept open in the channel pool of anSftpFileSystemeven if they are idle; by default 1.SftpModuleProperties.POOL_LIFE_TIMEA timeout after which idle channels in the pool of anSftpFileSystemare removed from the pool and closed; by default 10 seconds.SftpModuleProperties.POOL_SIZEThe maximum size of the channel pool used by anSftpFileSystem; by default 8.SftpModuleProperties.READ_BUFFER_SIZESftpModuleProperties.SFTP_CHANNEL_OPEN_TIMEOUTProperty that can be used on theFactoryManagerto control the internal timeout used by the client to open a channel.SftpModuleProperties.SFTP_VERSIONForce the use of a given sftp versionSftpModuleProperties.WRITE_BUFFER_SIZESftpModuleProperties.WRITE_CHUNK_SIZEProperty 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_TIMEOUTProperty that can be used on theFactoryManagerto control the internal timeout used by the client to complete the buffer sending inRawSftpClient.send(int, Buffer).