Top Fields Constructors Methods
org.apache.sshd.common.config

public final Class ConfigFileReaderSupport

extends Object
Class Inheritance
Imports
java.io.BufferedReader, .IOException, .InputStream, .InputStreamReader, .Reader, .StreamCorruptedException, java.net.URL, java.nio.charset.StandardCharsets, java.nio.file.Files, .OpenOption, .Path, java.util.Properties, java.util.concurrent.TimeUnit, org.apache.sshd.common.PropertyResolverUtils, org.apache.sshd.common.util.GenericUtils, org.apache.sshd.common.util.io.input.NoCloseInputStream, .NoCloseReader, org.apache.sshd.common.util.net.SshdSocketAddress
Author
Apache MINA SSHD Project
See Also
ssh_config(5)

Field Summary

Modifier and TypeField and Description
public static final String
AUTH_KEYS_FILE_CONFIG_PROP

public static final String
CIPHERS_CONFIG_PROP

public static final char
COMMENT_CHAR

public static final String
COMPRESSION_PROP

public static final String
DEFAULT_BIND_ADDRESS

public static final String
DEFAULT_COMPRESSION

public static final String
DEFAULT_KBD_INTERACTIVE_AUTH

public static final boolean
DEFAULT_KBD_INTERACTIVE_AUTH_VALUE

public static final boolean
DEFAULT_KEEP_ALIVE

public static final LogLevelValue
DEFAULT_LOG_LEVEL

public static final long
DEFAULT_LOGIN_GRACE_TIME

public static final int
DEFAULT_MAX_AUTH_TRIES

public static final int
DEFAULT_MAX_SESSIONS

public static final int
DEFAULT_MAX_STARTUPS

public static final String
DEFAULT_PASSWORD_AUTH

public static final boolean
DEFAULT_PASSWORD_AUTH_VALUE

public static final String
DEFAULT_PUBKEY_AUTH

public static final boolean
DEFAULT_PUBKEY_AUTH_VALUE

public static final long
DEFAULT_REKEY_TIME_LIMIT

public static final SyslogFacilityValue
DEFAULT_SYSLOG_FACILITY

public static final boolean
DEFAULT_USE_DNS

public static final String
HOST_KEY_ALGORITHMS_CONFIG_PROP

public static final String
KBD_INTERACTIVE_CONFIG_PROP

public static final String
KEEP_ALIVE_CONFIG_PROP

public static final String
KEX_ALGORITHMS_CONFIG_PROP

public static final String
KEY_REGENERATE_INTERVAL_CONFIG_PROP

public static final String
LISTEN_ADDRESS_CONFIG_PROP

public static final String
LOG_LEVEL_CONFIG_PROP

public static final String
LOGIN_GRACE_TIME_CONFIG_PROP

public static final String
MACS_CONFIG_PROP

public static final String
MAX_AUTH_TRIES_CONFIG_PROP

public static final String
MAX_SESSIONS_CONFIG_PROP

public static final String
MAX_STARTUPS_CONFIG_PROP

public static final String
PASSWORD_AUTH_CONFIG_PROP

public static final String
PORT_CONFIG_PROP

public static final String
PREFERRED_AUTHS_CONFIG_PROP

public static final String
PUBKEY_AUTH_CONFIG_PROP

public static final String
SUBSYSTEM_CONFIG_PROP

public static final String
SYSLOG_FACILITY_CONFIG_PROP

public static final String
USE_DNS_CONFIG_PROP

Constructor Summary

AccessConstructor and Description
private
ConfigFileReaderSupport()

Method Summary

Modifier and TypeMethod and Description
public static boolean

Returns:

The result - Note: null/empty values are interpreted as false
parseBooleanValue(String
Checks if the value is "yes", "y", "on", "t" or "true".
v)

public static Properties
readConfigFile(Path path, OpenOption... options)

public static Properties
readConfigFile(URL url)

public static Properties
readConfigFile(InputStream input, boolean okToClose)

public static Properties
readConfigFile(Reader reader, boolean okToClose)

public static Properties

Returns:

The read properties
readConfigFile(BufferedReader
The BufferedReader for reading the file
rdr)

Reads the configuration file contents into a Properties instance

Note

multiple keys value are concatenated using a comma - it is up to the caller to know which keys are expected to have multiple values and handle the split accordingly

public static String

Returns:

"yes" if true, "no" otherwise
yesNoValueOf(boolean
The required state
flag)

Returns a "yes" or "no" value based on the input parameter

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

AUTH_KEYS_FILE_CONFIG_PROPback to summary
public static final String AUTH_KEYS_FILE_CONFIG_PROP
CIPHERS_CONFIG_PROPback to summary
public static final String CIPHERS_CONFIG_PROP
COMMENT_CHARback to summary
public static final char COMMENT_CHAR
COMPRESSION_PROPback to summary
public static final String COMPRESSION_PROP
DEFAULT_BIND_ADDRESSback to summary
public static final String DEFAULT_BIND_ADDRESS
DEFAULT_COMPRESSIONback to summary
public static final String DEFAULT_COMPRESSION
DEFAULT_KBD_INTERACTIVE_AUTHback to summary
public static final String DEFAULT_KBD_INTERACTIVE_AUTH
DEFAULT_KBD_INTERACTIVE_AUTH_VALUEback to summary
public static final boolean DEFAULT_KBD_INTERACTIVE_AUTH_VALUE
DEFAULT_KEEP_ALIVEback to summary
public static final boolean DEFAULT_KEEP_ALIVE
DEFAULT_LOG_LEVELback to summary
public static final LogLevelValue DEFAULT_LOG_LEVEL
DEFAULT_LOGIN_GRACE_TIMEback to summary
public static final long DEFAULT_LOGIN_GRACE_TIME
DEFAULT_MAX_AUTH_TRIESback to summary
public static final int DEFAULT_MAX_AUTH_TRIES
DEFAULT_MAX_SESSIONSback to summary
public static final int DEFAULT_MAX_SESSIONS
DEFAULT_MAX_STARTUPSback to summary
public static final int DEFAULT_MAX_STARTUPS
DEFAULT_PASSWORD_AUTHback to summary
public static final String DEFAULT_PASSWORD_AUTH
DEFAULT_PASSWORD_AUTH_VALUEback to summary
public static final boolean DEFAULT_PASSWORD_AUTH_VALUE
DEFAULT_PUBKEY_AUTHback to summary
public static final String DEFAULT_PUBKEY_AUTH
DEFAULT_PUBKEY_AUTH_VALUEback to summary
public static final boolean DEFAULT_PUBKEY_AUTH_VALUE
DEFAULT_REKEY_TIME_LIMITback to summary
public static final long DEFAULT_REKEY_TIME_LIMIT
DEFAULT_SYSLOG_FACILITYback to summary
public static final SyslogFacilityValue DEFAULT_SYSLOG_FACILITY
DEFAULT_USE_DNSback to summary
public static final boolean DEFAULT_USE_DNS
HOST_KEY_ALGORITHMS_CONFIG_PROPback to summary
public static final String HOST_KEY_ALGORITHMS_CONFIG_PROP
KBD_INTERACTIVE_CONFIG_PROPback to summary
public static final String KBD_INTERACTIVE_CONFIG_PROP
KEEP_ALIVE_CONFIG_PROPback to summary
public static final String KEEP_ALIVE_CONFIG_PROP
KEX_ALGORITHMS_CONFIG_PROPback to summary
public static final String KEX_ALGORITHMS_CONFIG_PROP
KEY_REGENERATE_INTERVAL_CONFIG_PROPback to summary
public static final String KEY_REGENERATE_INTERVAL_CONFIG_PROP
LISTEN_ADDRESS_CONFIG_PROPback to summary
public static final String LISTEN_ADDRESS_CONFIG_PROP
LOG_LEVEL_CONFIG_PROPback to summary
public static final String LOG_LEVEL_CONFIG_PROP
LOGIN_GRACE_TIME_CONFIG_PROPback to summary
public static final String LOGIN_GRACE_TIME_CONFIG_PROP
MACS_CONFIG_PROPback to summary
public static final String MACS_CONFIG_PROP
MAX_AUTH_TRIES_CONFIG_PROPback to summary
public static final String MAX_AUTH_TRIES_CONFIG_PROP
MAX_SESSIONS_CONFIG_PROPback to summary
public static final String MAX_SESSIONS_CONFIG_PROP
MAX_STARTUPS_CONFIG_PROPback to summary
public static final String MAX_STARTUPS_CONFIG_PROP
PASSWORD_AUTH_CONFIG_PROPback to summary
public static final String PASSWORD_AUTH_CONFIG_PROP
PORT_CONFIG_PROPback to summary
public static final String PORT_CONFIG_PROP
PREFERRED_AUTHS_CONFIG_PROPback to summary
public static final String PREFERRED_AUTHS_CONFIG_PROP
PUBKEY_AUTH_CONFIG_PROPback to summary
public static final String PUBKEY_AUTH_CONFIG_PROP
SUBSYSTEM_CONFIG_PROPback to summary
public static final String SUBSYSTEM_CONFIG_PROP
SYSLOG_FACILITY_CONFIG_PROPback to summary
public static final String SYSLOG_FACILITY_CONFIG_PROP
USE_DNS_CONFIG_PROPback to summary
public static final String USE_DNS_CONFIG_PROP

Constructor Detail

ConfigFileReaderSupportback to summary
private ConfigFileReaderSupport()

Method Detail

parseBooleanValueback to summary
public static boolean parseBooleanValue(String v)
Parameters
v:String

Checks if the value is "yes", "y", "on", "t" or "true".

Returns:boolean

The result - Note: null/empty values are interpreted as false

See Also
PropertyResolverUtils#TRUE_VALUES
readConfigFileback to summary
public static Properties readConfigFile(Path path, OpenOption... options) throws IOException
readConfigFileback to summary
public static Properties readConfigFile(URL url) throws IOException
readConfigFileback to summary
public static Properties readConfigFile(InputStream input, boolean okToClose) throws IOException
readConfigFileback to summary
public static Properties readConfigFile(Reader reader, boolean okToClose) throws IOException
readConfigFileback to summary
public static Properties readConfigFile(BufferedReader rdr) throws IOException

Reads the configuration file contents into a Properties instance

Note

multiple keys value are concatenated using a comma - it is up to the caller to know which keys are expected to have multiple values and handle the split accordingly

Parameters
rdr:BufferedReader

The BufferedReader for reading the file

Returns:Properties

The read properties

Exceptions
IOException:
If failed to read or malformed content
yesNoValueOfback to summary
public static String yesNoValueOf(boolean flag)

Returns a "yes" or "no" value based on the input parameter

Parameters
flag:boolean

The required state

Returns:String

"yes" if true, "no" otherwise