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 Description static boolean
DEFAULT_EXCLUSIVE_IDENTITIES
static String
EXCLUSIVE_IDENTITIES_CONFIG_PROP
Use only the identities specified in the host entry (if any)static NavigableSet<String>
EXPLICIT_PROPERTIES
A case insensitiveNavigableSet
of the properties that receive special handlingstatic char
HOME_TILDE_CHAR
static String
HOST_CONFIG_PROP
static String
HOST_NAME_CONFIG_PROP
static String
IDENTITY_FILE_CONFIG_PROP
static char
LOCAL_HOME_MACRO
static char
LOCAL_HOST_MACRO
static char
LOCAL_USER_MACRO
static String
MULTI_VALUE_SEPARATORS
static char
PATH_MACRO_CHAR
static String
PORT_CONFIG_PROP
static String
PROXY_JUMP_CONFIG_PROP
static char
REMOTE_HOST_MACRO
static char
REMOTE_PORT_MACRO
static char
REMOTE_USER_MACRO
static String
STD_CONFIG_FILENAME
Standard OpenSSH config file namestatic String
USER_CONFIG_PROP
-
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 Description HostConfigEntry()
HostConfigEntry(String pattern, String host, int port, String username)
HostConfigEntry(String pattern, String host, int port, String username, String proxyJump)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addIdentity(String id)
Adds a path to an identity filevoid
addIdentity(Path path)
<A extends Appendable>
Aappend(A sb)
static <A extends Appendable>
AappendHostConfigEntries(A sb, Collection<? extends HostConfigEntry> entries)
static <A extends Appendable>
AappendNonEmptyPort(A sb, String name, int port)
static <A extends Appendable>
AappendNonEmptyProperties(A sb, Map<String,?> props)
Appends the extra properties - while skipping theEXPLICIT_PROPERTIES
onesstatic <A extends Appendable>
AappendNonEmptyProperty(A sb, String name, Object value)
static <A extends Appendable>
AappendNonEmptyValues(A sb, String name, Object... values)
static <A extends Appendable>
AappendNonEmptyValues(A sb, String name, Collection<?> values)
String
appendPropertyValue(String name, String value)
Appends a value using a comma to an existing one.static StringBuilder
appendUserHome(StringBuilder sb)
static StringBuilder
appendUserHome(StringBuilder sb, String userHome)
static StringBuilder
appendUserHome(StringBuilder sb, Path userHome)
static HostConfigEntry
findBestMatch(Iterable<? extends HostConfigEntry> matches)
Finds the best match out of the given ones.static HostConfigEntry
findBestMatch(Collection<? extends HostConfigEntry> matches)
Finds the best match out of the given ones.static HostConfigEntry
findBestMatch(Iterator<? extends HostConfigEntry> matches)
Finds the best match out of the given ones.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 HostConfigEntry
normalizeEntry(HostConfigEntry entry, String host, int port, String username, String proxyJump)
static List<String>
parseConfigValue(String value)
Checks if this is a multi-value - allow space and commaboolean
processGlobalValues(HostConfigEntry globalEntry)
Updates the values that are not already configured with those from the global entryvoid
processProperty(String name, Collection<String> valsList, boolean ignoreAlreadyInitialized)
static List<HostConfigEntry>
readHostConfigEntries(BufferedReader rdr)
Reads configuration entriesstatic List<HostConfigEntry>
readHostConfigEntries(InputStream inStream, boolean okToClose)
static List<HostConfigEntry>
readHostConfigEntries(Reader rdr, boolean okToClose)
static List<HostConfigEntry>
readHostConfigEntries(URL url)
static List<HostConfigEntry>
readHostConfigEntries(Path path, OpenOption... options)
String
removeProperty(String name)
String
resolveHostName(String originalHost)
static String
resolveHostName(String originalName, String entryName)
Resolves the effective target hoststatic String
resolveIdentityFilePath(String id, String host, int port, String username)
int
resolvePort(int originalPort)
Resolves the effective port to usestatic int
resolvePort(int originalPort, int entryPort)
Resolves the effective port to useString
resolveProxyJump(String originalProxyJump)
Resolves the effective proxyJumpstatic String
resolveProxyJump(String originalProxyJump, String entryProxyJump)
Resolves the effective proxyJumpString
resolveUsername(String originalUser)
Resolves the effective usernamestatic String
resolveUsername(String originalUser, String entryUser)
Resolves the effective usernamevoid
setHost(String host)
void
setHost(Collection<String> patterns)
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 valuevoid
setProxyJump(String proxyJump)
void
setUsername(String username)
static HostConfigEntryResolver
toHostConfigEntryResolver(Collection<? extends HostConfigEntry> entries)
String
toString()
static List<HostConfigEntry>
updateEntriesList(List<HostConfigEntry> entries, HostConfigEntry curEntry)
boolean
updateGlobalHostName(String name)
boolean
updateGlobalIdentities(Collection<String> ids)
boolean
updateGlobalIdentityOnly(boolean identitiesOnly)
boolean
updateGlobalPort(int portValue)
Map<String,String>
updateGlobalProperties(Map<String,String> props)
Sets all the properties for which no current value exists in the entryboolean
updateGlobalUserName(String user)
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
findMatchingEntries, findMatchingEntries, getPatterns, isHostMatch, isHostMatch, isHostMatch, isPortMatch, isSpecificHostPattern, isValidPatternChar, parsePatterns, parsePatterns, setPatterns, toPattern
-
-
-
-
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
-
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
-
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
-
EXPLICIT_PROPERTIES
public static final NavigableSet<String> EXPLICIT_PROPERTIES
A case insensitiveNavigableSet
of the properties that receive special handling
-
MULTI_VALUE_SEPARATORS
public static final String MULTI_VALUE_SEPARATORS
- See Also:
- Constant Field Values
-
HOME_TILDE_CHAR
public static final char HOME_TILDE_CHAR
- 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
-
-
Method Detail
-
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)
-
resolvePort
public int resolvePort(int originalPort)
Resolves the effective port to use- Parameters:
originalPort
- The original requested port- Returns:
- If the host entry port is positive, then it is used, otherwise the original requested port
- See Also:
resolvePort(int, int)
-
getUsername
public String getUsername()
- Specified by:
getUsername
in interfaceUsernameHolder
- Returns:
- A username override - if not
null
/empty
-
setUsername
public void setUsername(String username)
- Specified by:
setUsername
in interfaceMutableUserHolder
-
resolveUsername
public String resolveUsername(String originalUser)
Resolves the effective username- Parameters:
originalUser
- The original requested username- Returns:
- If the configured host entry username is not
null
/empty then it is used, otherwise the original one. - See Also:
resolveUsername(String)
-
getProxyJump
public String getProxyJump()
- Returns:
- the host to use as a proxy
-
setProxyJump
public void setProxyJump(String proxyJump)
-
resolveProxyJump
public String resolveProxyJump(String originalProxyJump)
Resolves the effective proxyJump- Parameters:
originalProxyJump
- The original requested proxyJump- Returns:
- If the configured host entry proxyJump is not
null
/empty then it is used, otherwise the original one. - See Also:
resolveUsername(String)
-
getIdentities
public Collection<String> getIdentities()
- Returns:
- The current identities file paths - may be
null
/empty
-
addIdentity
public void addIdentity(Path path)
- Parameters:
path
- APath
to a file that contains an identity key - nevernull
-
addIdentity
public void addIdentity(String id)
Adds a path to an identity file- Parameters:
id
- The identity path to add - nevernull
-
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 benull
/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 - nevernull
/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 - nevernull
/emptydefaultValue
- Default value to return if no such property- Returns:
- The property value or the default one if no such property
-
processGlobalValues
public boolean processGlobalValues(HostConfigEntry globalEntry)
Updates the values that are not already configured with those from the global entry- Parameters:
globalEntry
- The global entry - ignored ifnull
or same reference as this entry- Returns:
true
if anything updated
-
updateGlobalProperties
public Map<String,String> updateGlobalProperties(Map<String,String> props)
Sets all the properties for which no current value exists in the entry- Parameters:
props
- The global properties - ignored ifnull
/empty- Returns:
- A
Map
of the updated properties
-
updateGlobalIdentities
public boolean updateGlobalIdentities(Collection<String> ids)
- Parameters:
ids
- Global identities - ignored ifnull
/empty or already have configured identities- Returns:
true
if updated identities
-
updateGlobalUserName
public boolean updateGlobalUserName(String user)
- Parameters:
user
- The global user name - ignored ifnull
/empty or already have a configured user- Returns:
true
if updated the username
-
updateGlobalHostName
public boolean updateGlobalHostName(String name)
- Parameters:
name
- The global host name - ignored ifnull
/empty or already have a configured target host- Returns:
true
if updated the target host
-
updateGlobalPort
public boolean updateGlobalPort(int portValue)
- Parameters:
portValue
- The global port value - ignored if not positive or already have a configured port- Returns:
true
if updated the port value
-
updateGlobalIdentityOnly
public boolean updateGlobalIdentityOnly(boolean identitiesOnly)
- Parameters:
identitiesOnly
- Whether to use only the identities in this entry. Ignored if already set- Returns:
true
if updated the option value
-
processProperty
public void processProperty(String name, Collection<String> valsList, boolean ignoreAlreadyInitialized)
- Parameters:
name
- Property name - nevernull
/emptyvalsList
- The available values for the propertyignoreAlreadyInitialized
- Iffalse
and one of the "known" properties is encountered then throws an exception- Throws:
IllegalArgumentException
- If an existing value is overwritten and ignoreAlreadyInitialized isfalse
(except forIDENTITY_FILE_CONFIG_PROP
which is cumulative- 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 callingsetProperty(String, String)
.- Parameters:
name
- Property name - nevernull
/emptyvalue
- The value to be appended - ignored ifnull
/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 - nevernull
/emptyvalue
- Property value - ifnull
/empty thenremoveProperty(String)
is called- Returns:
- The previous property value -
null
if no such name
-
removeProperty
public String removeProperty(String name)
- Parameters:
name
- Property name - nevernull
/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 - ifnull
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
-
appendNonEmptyPort
public static <A extends Appendable> A appendNonEmptyPort(A sb, String name, int port) throws IOException
- Type Parameters:
A
- TheAppendable
type- Parameters:
sb
- The target appendername
- The property name - nevernull
/emptyport
- 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 theEXPLICIT_PROPERTIES
ones- Type Parameters:
A
- TheAppendable
type- Parameters:
sb
- The target appenderprops
- TheMap
of properties - ignored ifnull
/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
- TheAppendable
type- Parameters:
sb
- The target appendername
- The property name - nevernull
/emptyvalue
- The property value - ignored ifnull
. 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
- TheAppendable
type- Parameters:
sb
- The target appendername
- The property name - nevernull
/emptyvalues
- The values to be added - one per line - ignored ifnull
/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
- TheAppendable
type- Parameters:
sb
- The target appendername
- The property name - nevernull
/emptyvalues
- The values to be added - one per line - ignored ifnull
/empty- Returns:
- The target appender after having appended (or not) the value
- Throws:
IOException
- If failed to append the requested data
-
toHostConfigEntryResolver
public static HostConfigEntryResolver toHostConfigEntryResolver(Collection<? extends HostConfigEntry> entries)
- Parameters:
entries
- The entries - ignored ifnull
/empty- Returns:
- A
HostConfigEntryResolver
wrapper using the entries
-
normalizeEntry
public static HostConfigEntry normalizeEntry(HostConfigEntry entry, String host, int port, String username, String proxyJump) throws IOException
- Parameters:
entry
- The original entry - ignored ifnull
host
- The original host name / addressport
- The original portusername
- The original user nameproxyJump
- And optional proxy jump setting- Returns:
- A cloned entry whose values are resolved - including expanding macros in the identities files
- Throws:
IOException
- If failed to normalize the entry- See Also:
resolveHostName(String)
,resolvePort(int)
,resolveUsername(String)
,resolveIdentityFilePath(String, String, int, String)
-
resolveHostName
public static String resolveHostName(String originalName, String entryName)
Resolves the effective target host- Parameters:
originalName
- The original requested hostentryName
- The configured host- Returns:
- If the configured host entry is not
null
/empty then it is used, otherwise the original one.
-
resolveUsername
public static String resolveUsername(String originalUser, String entryUser)
Resolves the effective username- Parameters:
originalUser
- The original requested usernameentryUser
- The configured host entry username- Returns:
- If the configured host entry username is not
null
/empty then it is used, otherwise the original one.
-
resolvePort
public static int resolvePort(int originalPort, int entryPort)
Resolves the effective port to use- Parameters:
originalPort
- The original requested portentryPort
- The configured host entry port- Returns:
- If the host entry port is positive, then it is used, otherwise the original requested port
-
resolveProxyJump
public static String resolveProxyJump(String originalProxyJump, String entryProxyJump)
Resolves the effective proxyJump- Parameters:
originalProxyJump
- The original requested proxyJumpentryProxyJump
- The configured host entry proxyJump- Returns:
- If the configured host entry proxyJump is not
null
/empty then it is used, otherwise the original one.
-
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
- TheBufferedReader
to use- Returns:
- The
List
of readHostConfigEntry
-ies - Throws:
IOException
- If failed to parse the read configuration
-
findBestMatch
public static HostConfigEntry findBestMatch(Collection<? extends HostConfigEntry> matches)
Finds the best match out of the given ones.- Parameters:
matches
- The available matches - ignored ifnull
/empty- Returns:
- The best match or
null
if no matches or no best match found - See Also:
findBestMatch(Iterator)
-
findBestMatch
public static HostConfigEntry findBestMatch(Iterable<? extends HostConfigEntry> matches)
Finds the best match out of the given ones.- Parameters:
matches
- The available matches - ignored ifnull
/empty- Returns:
- The best match or
null
if no matches or no best match found - See Also:
findBestMatch(Iterator)
-
findBestMatch
public static HostConfigEntry findBestMatch(Iterator<? extends HostConfigEntry> matches)
Finds the best match out of the given ones. The best match is defined as one whose pattern is as specific as possible (if more than one match is available). I.e., a non-global match is preferred over global one, and a match with no wildcards is preferred over one with such a pattern.- Parameters:
matches
- The available matches - ignored ifnull
/empty- Returns:
- The best match or
null
if no matches or no best match found - See Also:
HostPatternsHolder.isSpecificHostPattern(String)
-
updateEntriesList
public static List<HostConfigEntry> updateEntriesList(List<HostConfigEntry> entries, HostConfigEntry curEntry)
-
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 ifnull
/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
-
appendUserHome
public static StringBuilder appendUserHome(StringBuilder sb)
-
appendUserHome
public static StringBuilder appendUserHome(StringBuilder sb, Path userHome)
-
appendUserHome
public static StringBuilder appendUserHome(StringBuilder sb, String userHome)
-
-