Apache Mina SSHD 2.15.0 · org.apache.sshd.common.PropertyResolver

Indicates an entity that can be configured using properties. The properties are simple name-value pairs where the actual value type depends on the property. Some automatic conversions may be available - e.g., from a string to a numeric or boolean value, or from int to long, etc.

Note

implementations may decide to use case insensitive property names, therefore it is highly discouraged to use names that differ from each other only in case sensitivity. Also, implementations may choose to trim whitespaces, thus such are also highly discouraged.

Field Summary

Modifier and Type	Field and Description
public static final PropertyResolver	EMPTY An "empty" resolver with no properties and no parent

Method Summary

Modifier and Type	Method and Description
public default Boolean	getBoolean(String name)
public default boolean	getBooleanProperty(String name, boolean def)
public default Charset	getCharset(String name, Charset defaultValue)
public default Integer	getInteger(String name)
public default int	getIntProperty(String name, int def)
public default Long	getLong(String name)
public default long	getLongProperty(String name, long def)
public default Object	getObject(String name)
public PropertyResolver	Returns: The parent resolver that can be used to query for missing properties - `null` if no parent getParentPropertyResolver()
public Map<String, Object>	Returns: a valid `Map` containing configuration values, never `null` Note may be immutable. getProperties() A map of properties that can be used to configure the SSH server or client.
public default String	getString(String name)
public default String	getStringProperty(String name, String def)
public default boolean	isEmpty()
public static boolean	isEmpty(PropertyResolver resolver)

Field Detail

EMPTY	back to summary
public static final PropertyResolver EMPTY An "empty" resolver with no properties and no parent

Method Detail

getBoolean	back to summary
public default Boolean getBoolean(String name)

getBooleanProperty	back to summary
public default boolean getBooleanProperty(String name, boolean def)

getCharset	back to summary
public default Charset getCharset(String name, Charset defaultValue)

getInteger	back to summary
public default Integer getInteger(String name)

getIntProperty	back to summary
public default int getIntProperty(String name, int def)

getLong	back to summary
public default Long getLong(String name)

getLongProperty	back to summary
public default long getLongProperty(String name, long def)

getObject	back to summary
public default Object getObject(String name)

getParentPropertyResolver	back to summary
public PropertyResolver getParentPropertyResolver() Returns:PropertyResolver The parent resolver that can be used to query for missing properties - `null` if no parent

getProperties back to summary

getProperties	back to summary
public Map<String, Object> getProperties() A map of properties that can be used to configure the SSH server or client. This map will never be changed by either the server or client and is not supposed to be changed at runtime (changes are not bound to have any effect on a running client or server), though it may affect the creation of sessions later as these values are usually not cached Note the type of the mapped property should match the expected configuration value type - `Long, Integer, Boolean, String`, etc.... If it doesn't, the `toString()` result of the mapped value is used to convert it to the required type. E.g., if the mapped value is the string "1234" and the expected value is a `long` then it will be parsed into one. Also, if the mapped value is an `Integer` but a `long` is expected, then it will be converted into one. Returns:Map<String, Object> a valid `Map` containing configuration values, never `null` Note may be immutable.

public Map<String, Object> getProperties()

A map of properties that can be used to configure the SSH server or client. This map will never be changed by either the server or client and is not supposed to be changed at runtime (changes are not bound to have any effect on a running client or server), though it may affect the creation of sessions later as these values are usually not cached