org.apache.sshd.client.config.hosts

Class HostConfigEntry

java.lang.Object

org.apache.sshd.client.config.hosts.HostPatternsHolder

org.apache.sshd.client.config.hosts.HostConfigEntry

All Implemented Interfaces:

MutableUserHolder, UsernameHolder

public class HostConfigEntry
extends HostPatternsHolder
implements MutableUserHolder

Represents an entry in the client's configuration file as defined by the ssh_config configuration file format

Author:

Apache MINA SSHD Project

See Also:

OpenSSH Config File Examples

Field Summary

Fields

Modifier and Type	Field and Description
static String	CERTIFICATE_FILE_CONFIG_PROP
static boolean	DEFAULT_EXCLUSIVE_IDENTITIES
static String	EXCLUSIVE_IDENTITIES_CONFIG_PROP Use only the identities specified in the host entry (if any)
protected Boolean	exclusiveIdentites
static NavigableSet<String>	EXPLICIT_PROPERTIES A case insensitive NavigableSet of the properties that receive special handling
protected String	host
static String	HOST_CONFIG_PROP
static String	HOST_NAME_CONFIG_PROP
protected String	hostName
protected Collection<String>	identities
static String	IDENTITY_AGENT The IdentityAgent configuration.
static String	IDENTITY_FILE_CONFIG_PROP
static char	LOCAL_HOME_MACRO
static char	LOCAL_HOST_MACRO
static char	LOCAL_USER_MACRO
static String	MATCH_CONFIG_PROP
static String	MULTI_VALUE_SEPARATORS
static char	PATH_MACRO_CHAR
protected int	port
static String	PORT_CONFIG_PROP
protected Map<String,String>	properties
static String	PROXY_JUMP_CONFIG_PROP
protected String	proxyJump
static char	REMOTE_HOST_MACRO
static char	REMOTE_PORT_MACRO
static char	REMOTE_USER_MACRO
static String	STD_CONFIG_FILENAME Standard OpenSSH config file name
static String	USER_CONFIG_PROP
protected String	username

Fields inherited from class org.apache.sshd.client.config.hosts.HostPatternsHolder

ALL_HOSTS_PATTERN, NEGATION_CHAR_PATTERN, NON_STANDARD_PORT_PATTERN_ENCLOSURE_END_DELIM, NON_STANDARD_PORT_PATTERN_ENCLOSURE_START_DELIM, PATTERN_CHARS, PORT_VALUE_DELIMITER, SINGLE_CHAR_PATTERN, WILDCARD_PATTERN

Constructor Summary

Constructors

Constructor and Description
HostConfigEntry()
HostConfigEntry(String pattern, String host, int port, String username)
HostConfigEntry(String pattern, String host, int port, String username, String proxyJump)

Method Summary

Modifier and Type	Method and Description
void	addIdentity(Path path)
void	addIdentity(String id) Adds a path to an identity file
<A extends Appendable> A	append(A sb)
static <A extends Appendable> A	appendHostConfigEntries(A sb, Collection<? extends HostConfigEntry> entries)
static <A extends Appendable> A	appendNonEmptyPort(A sb, String name, int port)
static <A extends Appendable> A	appendNonEmptyProperties(A sb, Map<String,?> props) Appends the extra properties - while skipping the EXPLICIT_PROPERTIES ones
static <A extends Appendable> A	appendNonEmptyProperty(A sb, String name, Object value)
static <A extends Appendable> A	appendNonEmptyValues(A sb, String name, Collection<?> values)
static <A extends Appendable> A	appendNonEmptyValues(A sb, String name, Object... values)
String	appendPropertyValue(String name, String value) Appends a value using a comma to an existing one.
void	collate(HostConfigEntry that) Merges that into this via underride.
static List<HostConfigEntry>	findMatchingEntries(String host, Collection<? extends HostConfigEntry> entries) Locates all the matching entries for a give host name / address
static List<HostConfigEntry>	findMatchingEntries(String host, HostConfigEntry... entries) Locates all the matching entries for a give host name / address
static Path	getDefaultHostConfigFile()
String	getHost()
String	getHostName()
Collection<String>	getIdentities()
int	getPort()
Map<String,String>	getProperties()
String	getProperty(String name)
String	getProperty(String name, String defaultValue)
String	getProxyJump()
String	getUsername()
boolean	isIdentitiesOnly()
static List<String>	parseConfigValue(String value) Checks if this is a multi-value - allow space and comma
void	processProperty(String name, Collection<String> valsList)
static List<HostConfigEntry>	readHostConfigEntries(BufferedReader rdr) Reads configuration entries
static List<HostConfigEntry>	readHostConfigEntries(InputStream inStream, boolean okToClose)
static List<HostConfigEntry>	readHostConfigEntries(Path path, OpenOption... options)
static List<HostConfigEntry>	readHostConfigEntries(Reader rdr, boolean okToClose)
static List<HostConfigEntry>	readHostConfigEntries(URL url)
String	removeProperty(String name)
static String	resolveIdentityFilePath(String id, String host, int port, String username)
void	setHost(Collection<String> patterns)
void	setHost(String host)
void	setHostName(String hostName)
void	setIdentities(Collection<String> identities)
void	setIdentitiesOnly(boolean identitiesOnly)
void	setPort(int port)
void	setProperties(Map<String,String> properties)
String	setProperty(String name, String value) Sets / Replaces the property value
void	setProxyJump(String proxyJump)
void	setUsername(String username)
static HostConfigEntryResolver	toHostConfigEntryResolver(Collection<? extends HostConfigEntry> entries)
String	toString()
static void	writeHostConfigEntries(OutputStream outputStream, boolean okToClose, Collection<? extends HostConfigEntry> entries)
static void	writeHostConfigEntries(Path path, Collection<? extends HostConfigEntry> entries, OpenOption... options)

Methods inherited from class org.apache.sshd.client.config.hosts.HostPatternsHolder

getPatterns, isHostMatch, isHostMatch, isHostMatch, isPortMatch, isSpecificHostPattern, isValidPatternChar, parsePatterns, parsePatterns, setPatterns, toPattern

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STD_CONFIG_FILENAME

public static final String STD_CONFIG_FILENAME

Standard OpenSSH config file name

See Also:

Constant Field Values

HOST_CONFIG_PROP

public static final String HOST_CONFIG_PROP

See Also:

Constant Field Values

MATCH_CONFIG_PROP

public static final String MATCH_CONFIG_PROP

See Also:

Constant Field Values

HOST_NAME_CONFIG_PROP

public static final String HOST_NAME_CONFIG_PROP

See Also:

Constant Field Values

PORT_CONFIG_PROP

public static final String PORT_CONFIG_PROP

See Also:

Constant Field Values

USER_CONFIG_PROP

public static final String USER_CONFIG_PROP

See Also:

Constant Field Values

PROXY_JUMP_CONFIG_PROP

public static final String PROXY_JUMP_CONFIG_PROP

See Also:

Constant Field Values

IDENTITY_FILE_CONFIG_PROP

public static final String IDENTITY_FILE_CONFIG_PROP

See Also:

Constant Field Values

CERTIFICATE_FILE_CONFIG_PROP

public static final String CERTIFICATE_FILE_CONFIG_PROP

See Also:

Constant Field Values

EXCLUSIVE_IDENTITIES_CONFIG_PROP

public static final String EXCLUSIVE_IDENTITIES_CONFIG_PROP

Use only the identities specified in the host entry (if any)

See Also:

Constant Field Values

DEFAULT_EXCLUSIVE_IDENTITIES

public static final boolean DEFAULT_EXCLUSIVE_IDENTITIES

See Also:

Constant Field Values

IDENTITY_AGENT

public static final String IDENTITY_AGENT

The IdentityAgent configuration. If not set in the HostConfigEntry, the value of this property is null, which means that a default SSH agent is to be used, if it is running. Other values defined by OpenSSH are:

none

No SHH agent is to be used at all, even if one is running.

SSH_AUTH_SOCK

The SSH agent listening on the Unix domain socket given by the environment variable SSH_AUTH_SOCK shall be used. If the environment variable is not set, no SSH agent is used.

other

For OpenSSH, the value shall resolve to the file name of a Unix domain socket to use to connect to an SSH agent.

See Also:

Constant Field Values

EXPLICIT_PROPERTIES

public static final NavigableSet<String> EXPLICIT_PROPERTIES

A case insensitive NavigableSet of the properties that receive special handling

MULTI_VALUE_SEPARATORS

public static final String MULTI_VALUE_SEPARATORS

See Also:

Constant Field Values

PATH_MACRO_CHAR

public static final char PATH_MACRO_CHAR

See Also:

Constant Field Values

LOCAL_HOME_MACRO

public static final char LOCAL_HOME_MACRO

See Also:

Constant Field Values

LOCAL_USER_MACRO

public static final char LOCAL_USER_MACRO

See Also:

Constant Field Values

LOCAL_HOST_MACRO

public static final char LOCAL_HOST_MACRO

See Also:

Constant Field Values

REMOTE_HOST_MACRO

public static final char REMOTE_HOST_MACRO

See Also:

Constant Field Values

REMOTE_USER_MACRO

public static final char REMOTE_USER_MACRO

See Also:

Constant Field Values

REMOTE_PORT_MACRO

public static final char REMOTE_PORT_MACRO

See Also:

Constant Field Values

host

protected String host

hostName

protected String hostName

port

protected int port

username

protected String username

proxyJump

protected String proxyJump

exclusiveIdentites

protected Boolean exclusiveIdentites

identities

protected final Collection<String> identities

properties

protected final Map<String,String> properties

Constructor Detail

HostConfigEntry

public HostConfigEntry()

HostConfigEntry

public HostConfigEntry(String pattern,
                       String host,
                       int port,
                       String username)

HostConfigEntry

public HostConfigEntry(String pattern,
                       String host,
                       int port,
                       String username,
                       String proxyJump)

Method Detail

collate

public void collate(HostConfigEntry that)

Merges that into this via underride. That is, any value present in this entry takes precedence over the given entry. Only this object is modified. The given entry remains unchanged.

Parameters:

that - The HostConfigEntry to merge.

getHost

public String getHost()

Returns:

The pattern(s) represented by this entry

setHost

public void setHost(String host)

setHost

public void setHost(Collection<String> patterns)

getHostName

public String getHostName()

Returns:

The effective host name to connect to if the pattern matches

setHostName

public void setHostName(String hostName)

getPort

public int getPort()

Returns:

A port override - if positive

setPort

public void setPort(int port)

getUsername

public String getUsername()

Specified by:

getUsername in interface UsernameHolder

Returns:

A username override - if not null/empty

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface MutableUserHolder

getProxyJump

public String getProxyJump()

Returns:

the host to use as a proxy

setProxyJump

public void setProxyJump(String proxyJump)

getIdentities

public Collection<String> getIdentities()

Returns:

The current identities file paths - may be null/empty

addIdentity

public void addIdentity(Path path)

Parameters:

path - A Path to a file that contains an identity key - never null

addIdentity

public void addIdentity(String id)

Adds a path to an identity file

Parameters:

id - The identity path to add - never null

setIdentities

public void setIdentities(Collection<String> identities)

isIdentitiesOnly

public boolean isIdentitiesOnly()

Returns:

true if must use only the identities in this entry

setIdentitiesOnly

public void setIdentitiesOnly(boolean identitiesOnly)

getProperties

public Map<String,String> getProperties()

Returns:

A Map of extra properties that have been read - may be null/empty, or even contain some values that have been parsed and set as members of the entry (e.g., host, port, etc.). Note: multi-valued keys use a comma-separated list of values

getProperty

public String getProperty(String name)

Parameters:

name - Property name - never null/empty

Returns:

Property value or null if no such property

See Also:

getProperty(String, String)

getProperty

public String getProperty(String name,
                          String defaultValue)

Parameters:

name - Property name - never null/empty

defaultValue - Default value to return if no such property

Returns:

The property value or the default one if no such property

processProperty

public void processProperty(String name,
                            Collection<String> valsList)

Parameters:

name - Property name - never null/empty

valsList - The available values for the property

See Also:

HOST_NAME_CONFIG_PROP, PORT_CONFIG_PROP, USER_CONFIG_PROP, IDENTITY_FILE_CONFIG_PROP

appendPropertyValue

public String appendPropertyValue(String name,
                                  String value)

Appends a value using a comma to an existing one. If no previous value then same as calling setProperty(String, String).

Parameters:

name - Property name - never null/empty

value - The value to be appended - ignored if null/empty

Returns:

The value before appending - null if no previous value

setProperty

public String setProperty(String name,
                          String value)

Sets / Replaces the property value

Parameters:

name - Property name - never null/empty

value - Property value - if null/empty then removeProperty(String) is called

Returns:

The previous property value - null if no such name

removeProperty

public String removeProperty(String name)

Parameters:

name - Property name - never null/empty

Returns:

The removed property value - null if no such property name

setProperties

public void setProperties(Map<String,String> properties)

Parameters:

properties - The properties to set - if null then an empty map is effectively set. Note: it is highly recommended to use a case insensitive key mapper.

append

public <A extends Appendable> A append(A sb)
                                throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

appendNonEmptyPort

public static <A extends Appendable> A appendNonEmptyPort(A sb,
                                                          String name,
                                                          int port)
                                                   throws IOException

Type Parameters:

A - The Appendable type

Parameters:

sb - The target appender

name - The property name - never null/empty

port - The port value - ignored if non-positive

Returns:

The target appender after having appended (or not) the value

Throws:

IOException - If failed to append the requested data

See Also:

appendNonEmptyProperty(Appendable, String, Object)

appendNonEmptyProperties

public static <A extends Appendable> A appendNonEmptyProperties(A sb,
                                                                Map<String,?> props)
                                                         throws IOException

Appends the extra properties - while skipping the EXPLICIT_PROPERTIES ones

Type Parameters:

A - The Appendable type

Parameters:

sb - The target appender

props - The Map of properties - ignored if null/empty

Returns:

The target appender after having appended (or not) the value

Throws:

IOException - If failed to append the requested data

See Also:

appendNonEmptyProperty(Appendable, String, Object)

appendNonEmptyProperty

public static <A extends Appendable> A appendNonEmptyProperty(A sb,
                                                              String name,
                                                              Object value)
                                                       throws IOException

Type Parameters:

A - The Appendable type

Parameters:

sb - The target appender

name - The property name - never null/empty

value - The property value - ignored if null. Note: if the string representation of the value contains any commas, they are assumed to indicate a multi-valued property which is broken down to individual lines - one per value.

Returns:

The target appender after having appended (or not) the value

Throws:

IOException - If failed to append the requested data

See Also:

appendNonEmptyValues(Appendable, String, Object...)

appendNonEmptyValues

public static <A extends Appendable> A appendNonEmptyValues(A sb,
                                                            String name,
                                                            Object... values)
                                                     throws IOException

Type Parameters:

A - The Appendable type

Parameters:

sb - The target appender

name - The property name - never null/empty

values - The values to be added - one per line - ignored if null/empty

Returns:

The target appender after having appended (or not) the value

Throws:

IOException - If failed to append the requested data

See Also:

appendNonEmptyValues(Appendable, String, Collection)

appendNonEmptyValues

public static <A extends Appendable> A appendNonEmptyValues(A sb,
                                                            String name,
                                                            Collection<?> values)
                                                     throws IOException

Type Parameters:

A - The Appendable type

Parameters:

sb - The target appender

name - The property name - never null/empty

values - The values to be added - one per line - ignored if null/empty

Returns:

The target appender after having appended (or not) the value

Throws:

IOException - If failed to append the requested data

findMatchingEntries

public static List<HostConfigEntry> findMatchingEntries(String host,
                                                        HostConfigEntry... entries)

Locates all the matching entries for a give host name / address

Parameters:

host - The host name / address - ignored if null/empty

entries - The HostConfigEntry-ies to scan - ignored if null/empty

Returns:

A List of all the matching entries

See Also:

HostPatternsHolder.isHostMatch(String, int)

findMatchingEntries

public static List<HostConfigEntry> findMatchingEntries(String host,
                                                        Collection<? extends HostConfigEntry> entries)

Locates all the matching entries for a give host name / address

Parameters:

host - The host name / address - ignored if null/empty

entries - The HostConfigEntry-ies to scan - ignored if null/empty

Returns:

A List of all the matching entries

See Also:

HostPatternsHolder.isHostMatch(String, int)

toHostConfigEntryResolver

public static HostConfigEntryResolver toHostConfigEntryResolver(Collection<? extends HostConfigEntry> entries)

Parameters:

entries - The entries - ignored if null/empty

Returns:

A HostConfigEntryResolver wrapper using the entries

readHostConfigEntries

public static List<HostConfigEntry> readHostConfigEntries(Path path,
                                                          OpenOption... options)
                                                   throws IOException

Throws:

IOException

readHostConfigEntries

public static List<HostConfigEntry> readHostConfigEntries(URL url)
                                                   throws IOException

Throws:

IOException

readHostConfigEntries

public static List<HostConfigEntry> readHostConfigEntries(InputStream inStream,
                                                          boolean okToClose)
                                                   throws IOException

Throws:

IOException

readHostConfigEntries

public static List<HostConfigEntry> readHostConfigEntries(Reader rdr,
                                                          boolean okToClose)
                                                   throws IOException

Throws:

IOException

readHostConfigEntries

public static List<HostConfigEntry> readHostConfigEntries(BufferedReader rdr)
                                                   throws IOException

Reads configuration entries

Parameters:

rdr - The BufferedReader to use

Returns:

The List of read HostConfigEntry-ies

Throws:

IOException - If failed to parse the read configuration

writeHostConfigEntries

public static void writeHostConfigEntries(Path path,
                                          Collection<? extends HostConfigEntry> entries,
                                          OpenOption... options)
                                   throws IOException

Throws:

IOException

writeHostConfigEntries

public static void writeHostConfigEntries(OutputStream outputStream,
                                          boolean okToClose,
                                          Collection<? extends HostConfigEntry> entries)
                                   throws IOException

Throws:

IOException

appendHostConfigEntries

public static <A extends Appendable> A appendHostConfigEntries(A sb,
                                                               Collection<? extends HostConfigEntry> entries)
                                                        throws IOException

Throws:

IOException

parseConfigValue

public static List<String> parseConfigValue(String value)

Checks if this is a multi-value - allow space and comma

Parameters:

value - The value - ignored if null/empty (after trimming)

Returns:

A List of the encountered values

resolveIdentityFilePath

public static String resolveIdentityFilePath(String id,
                                             String host,
                                             int port,
                                             String username)
                                      throws IOException

Throws:

IOException

getDefaultHostConfigFile

public static Path getDefaultHostConfigFile()

Returns:

The default Path location of the OpenSSH hosts entries configuration file