Apache Mina SSHD 2.15.0 · org.apache.sshd.client.config.hosts.KnownHostEntry

Modifier and Type	Class and Description
private static class	KnownHostEntry.LazyDefaultConfigFileHolder

Field Summary

Modifier and Type	Field and Description
private KnownHostHashValue	hashedEntry
private AuthorizedKeyEntry	keyEntry
private String	line
private String	marker
public static final char	MARKER_INDICATOR Character that denotes that start of a marker
public static final String	STD_HOSTS_FILENAME Standard OpenSSH config file name

Inherited from 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

Access	Constructor and Description
public	KnownHostEntry()
public	KnownHostEntry(String The original line from which this entry was created line)

Method Summary

Modifier and Type	Method and Description
public String	Returns: The original line from which this entry was created getConfigLine()
public static Path	Returns: The default `Path` location of the OpenSSH known hosts file getDefaultKnownHostsFile()
public KnownHostHashValue	getHashedEntry()
public AuthorizedKeyEntry	getKeyEntry()
public String	getMarker()
public boolean	isHostMatch(String The host name / address - ignored if `null`/empty host, int The connection port port) Overrides org.apache.sshd.client.config.hosts.HostPatternsHolder.isHostMatch. Checks if a given host name / address matches the entry's host pattern(s)
public static KnownHostEntry	parseKnownHostEntry(String line)
public static <E extends KnownHostEntry> E	parseKnownHostEntry(E entry, String data)
public static List<KnownHostEntry>	readKnownHostEntries(Path path, OpenOption... options)
public static List<KnownHostEntry>	readKnownHostEntries(URL url)
public static List<KnownHostEntry>	readKnownHostEntries(InputStream inStream, boolean okToClose)
public static List<KnownHostEntry>	readKnownHostEntries(Reader rdr, boolean okToClose)
public static List<KnownHostEntry>	Returns: The `List` of read `KnownHostEntry`-ies readKnownHostEntries(BufferedReader The `BufferedReader` to use rdr) Reads configuration entries
public void	setConfigLine(String line)
public void	setHashedEntry(KnownHostHashValue hashedEntry)
public void	setKeyEntry(AuthorizedKeyEntry keyEntry)
public void	setMarker(String marker)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.apache.sshd.client.config.hosts.HostPatternsHolder:: getPatterns isHostMatch isHostMatch isPortMatch isSpecificHostPattern isValidPatternChar parsePatterns parsePatterns setPatterns toPattern

Field Detail

hashedEntry	back to summary
private KnownHostHashValue hashedEntry

keyEntry	back to summary
private AuthorizedKeyEntry keyEntry

line	back to summary
private String line

marker	back to summary
private String marker

MARKER_INDICATOR	back to summary
public static final char MARKER_INDICATOR Character that denotes that start of a marker

STD_HOSTS_FILENAME	back to summary
public static final String STD_HOSTS_FILENAME Standard OpenSSH config file name

Constructor Detail

KnownHostEntry	back to summary
public KnownHostEntry()

KnownHostEntry	back to summary
public KnownHostEntry(String line) Parameters line:String The original line from which this entry was created

Method Detail

getConfigLine	back to summary
public String getConfigLine() Returns:String The original line from which this entry was created

getDefaultKnownHostsFile	back to summary
public static Path getDefaultKnownHostsFile() Returns:Path The default `Path` location of the OpenSSH known hosts file Annotations @SuppressWarnings:synthetic-access

getHashedEntry	back to summary
public KnownHostHashValue getHashedEntry()

getKeyEntry	back to summary
public AuthorizedKeyEntry getKeyEntry()

getMarker	back to summary
public String getMarker()

isHostMatch back to summary

isHostMatch	back to summary
public boolean isHostMatch(String host, int port) Overrides org.apache.sshd.client.config.hosts.HostPatternsHolder.isHostMatch. Doc from org.apache.sshd.client.config.hosts.HostPatternsHolder.isHostMatch. Checks if a given host name / address matches the entry's host pattern(s) Parameters host:String The host name / address - ignored if `null`/empty port:int The connection port Returns:boolean `true` if the name / address matches the pattern(s) Annotations @Override

public boolean isHostMatch(String host, int port)

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

Doc from org.apache.sshd.client.config.hosts.HostPatternsHolder.isHostMatch.

Checks if a given host name / address matches the entry's host pattern(s)

Parameters

host:String: The host name / address - ignored if null/empty
port:int: The connection port

Returns:boolean

true if the name / address matches the pattern(s)

Annotations

@Override

parseKnownHostEntry	back to summary
public static KnownHostEntry parseKnownHostEntry(String line)

parseKnownHostEntry	back to summary
public static <E extends KnownHostEntry> E parseKnownHostEntry(E entry, String data)

readKnownHostEntries	back to summary
public static List<KnownHostEntry> readKnownHostEntries(Path path, OpenOption... options) throws IOException

readKnownHostEntries	back to summary
public static List<KnownHostEntry> readKnownHostEntries(URL url) throws IOException

readKnownHostEntries	back to summary
public static List<KnownHostEntry> readKnownHostEntries(InputStream inStream, boolean okToClose) throws IOException

readKnownHostEntries	back to summary
public static List<KnownHostEntry> readKnownHostEntries(Reader rdr, boolean okToClose) throws IOException

readKnownHostEntries back to summary

readKnownHostEntries	back to summary
public static List<KnownHostEntry> readKnownHostEntries(BufferedReader rdr) throws IOException Reads configuration entries Parameters rdr:BufferedReader The `BufferedReader` to use Returns:List<KnownHostEntry> The `List` of read `KnownHostEntry`-ies Exceptions IOException: If failed to parse the read configuration

public static List<KnownHostEntry> readKnownHostEntries(BufferedReader rdr) throws IOException

Reads configuration entries

Parameters

rdr:BufferedReader: The BufferedReader to use

Returns:List<KnownHostEntry>

The List of read KnownHostEntry-ies

Exceptions

IOException:: If failed to parse the read configuration

setConfigLine	back to summary
public void setConfigLine(String line)

setHashedEntry	back to summary
public void setHashedEntry(KnownHostHashValue hashedEntry)

setKeyEntry	back to summary
public void setKeyEntry(AuthorizedKeyEntry keyEntry)

setMarker	back to summary
public void setMarker(String marker)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

Modifier and Type	Field and Description
private static final Path	HOSTS_FILE

Access	Constructor and Description
private	LazyDefaultConfigFileHolder()

Field Detail

HOSTS_FILE	back to summary
private static final Path HOSTS_FILE

Constructor Detail

LazyDefaultConfigFileHolder	back to summary
private LazyDefaultConfigFileHolder()

public Class KnownHostEntry

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class KnownHostEntry.LazyDefaultConfigFileHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail