Apache Mina SSHD 2.15.0 · org.apache.sshd.common.config.keys.loader.KeyPairResourceParser

Modifier and Type	Field and Description
public static final KeyPairResourceParser	EMPTY Hides org.apache.sshd.common.config.keys.loader.KeyPairResourceLoader.EMPTY. An empty parser that never fails, but always report that it cannot extract key pairs and returns empty list if asked to load

Method Summary

Modifier and Type	Method and Description
public static KeyPairResourceParser	aggregate(KeyPairResourceParser... parsers)
public static KeyPairResourceParser	aggregate(Collection<? extends KeyPairResourceParser> parsers)
public boolean	Returns: `true` if the parser can extract some key pairs from the lines canExtractKeyPairs(NamedResource A hint as to the origin of the text lines resourceKey, List<String> The resource lines lines)
public static boolean	containsMarkerLine(List<String> lines, String marker)
public static boolean	containsMarkerLine(List<String> lines, List<String> markers)
public static byte[]	Returns: The decoded data bytes extractDataBytes(Collection<String> The data lines - empty lines and spaces are automatically deleted before BASE-64 decoding takes place. lines) Converts the lines assumed to contain BASE-64 encoded data into the actual content bytes.
public static AbstractMap.SimpleImmutableEntry<Integer, Integer>	Returns: A `SimpleImmutableEntry` whose key is the first line index that matched and value the matched marker index - `null` if no match found findMarkerLine(List<String> The list of lines to scan - ignored if `null`/empty lines, List<String> The markers to match - ignored if `null`/empty markers) Attempts to locate a line that contains one of the markers
public static AbstractMap.SimpleImmutableEntry<Integer, Integer>	Returns: A `SimpleImmutableEntry` whose key is the first line index that matched and value the matched marker index - `null` if no match found findMarkerLine(List<String> The list of lines to scan - ignored if `null`/empty lines, int The scan start line index startLine, List<String> The markers to match - ignored if `null`/empty markers) Attempts to locate a line that contains one of the markers
public static String	joinDataLines(Collection<String> lines)

Inherited from org.apache.sshd.common.config.keys.loader.KeyPairResourceLoader:: loadKeyPairs loadKeyPairs loadKeyPairs loadKeyPairs loadKeyPairs loadKeyPairs loadKeyPairs loadKeyPairs loadKeyPairs loadKeyPairs loadKeyPairs loadKeyPairs

EMPTY	back to summary
public static final KeyPairResourceParser EMPTY Hides org.apache.sshd.common.config.keys.loader.KeyPairResourceLoader.EMPTY. An empty parser that never fails, but always report that it cannot extract key pairs and returns empty list if asked to load

Method Detail

aggregate	back to summary
public static KeyPairResourceParser aggregate(KeyPairResourceParser... parsers)

aggregate	back to summary
public static KeyPairResourceParser aggregate(Collection<? extends KeyPairResourceParser> parsers)

canExtractKeyPairs back to summary

canExtractKeyPairs	back to summary
public boolean canExtractKeyPairs(NamedResource resourceKey, List<String> lines) throws IOException, GeneralSecurityException Parameters resourceKey:NamedResource A hint as to the origin of the text lines lines:List<String> The resource lines Returns:boolean `true` if the parser can extract some key pairs from the lines Exceptions IOException: If failed to process the lines GeneralSecurityException: If failed to extract information regarding the possibility to extract the key pairs

public boolean canExtractKeyPairs(NamedResource resourceKey, List<String> lines) throws IOException, GeneralSecurityException

Parameters

resourceKey:NamedResource: A hint as to the origin of the text lines
lines:List<String>: The resource lines

Returns:boolean

true if the parser can extract some key pairs from the lines

Exceptions

IOException:: If failed to process the lines
GeneralSecurityException:: If failed to extract information regarding the possibility to extract the key pairs

containsMarkerLine	back to summary
public static boolean containsMarkerLine(List<String> lines, String marker)

containsMarkerLine	back to summary
public static boolean containsMarkerLine(List<String> lines, List<String> markers)

extractDataBytes back to summary

extractDataBytes	back to summary
public static byte[] extractDataBytes(Collection<String> lines) Converts the lines assumed to contain BASE-64 encoded data into the actual content bytes. Parameters lines:Collection<String> The data lines - empty lines and spaces are automatically deleted before BASE-64 decoding takes place. Returns:byte[] The decoded data bytes See Also `joinDataLines(Collection)`

public static byte[] extractDataBytes(Collection<String> lines)

Converts the lines assumed to contain BASE-64 encoded data into the actual content bytes.

Parameters

lines:Collection<String>: The data lines - empty lines and spaces are automatically deleted before BASE-64 decoding takes place.

Returns:byte[]

The decoded data bytes

See Also

joinDataLines(Collection)

findMarkerLine back to summary

findMarkerLine	back to summary
public static AbstractMap.SimpleImmutableEntry<Integer, Integer> findMarkerLine(List<String> lines, List<String> markers) Attempts to locate a line that contains one of the markers Parameters lines:List<String> The list of lines to scan - ignored if `null`/empty markers:List<String> The markers to match - ignored if `null`/empty Returns:AbstractMap.SimpleImmutableEntry<Integer, Integer> A `SimpleImmutableEntry` whose key is the first line index that matched and value the matched marker index - `null` if no match found See Also `findMarkerLine(List, int, List)`

public static AbstractMap.SimpleImmutableEntry<Integer, Integer> findMarkerLine(List<String> lines, List<String> markers)

Attempts to locate a line that contains one of the markers

Parameters

lines:List<String>: The list of lines to scan - ignored if null/empty
markers:List<String>: The markers to match - ignored if null/empty

Returns:AbstractMap.SimpleImmutableEntry<Integer, Integer>

A SimpleImmutableEntry whose key is the first line index that matched and value the matched marker index - null if no match found

See Also

findMarkerLine(List, int, List)

findMarkerLine back to summary

findMarkerLine	back to summary
public static AbstractMap.SimpleImmutableEntry<Integer, Integer> findMarkerLine(List<String> lines, int startLine, List<String> markers) Attempts to locate a line that contains one of the markers Parameters lines:List<String> The list of lines to scan - ignored if `null`/empty startLine:int The scan start line index markers:List<String> The markers to match - ignored if `null`/empty Returns:AbstractMap.SimpleImmutableEntry<Integer, Integer> A `SimpleImmutableEntry` whose key is the first line index that matched and value the matched marker index - `null` if no match found

public static AbstractMap.SimpleImmutableEntry<Integer, Integer> findMarkerLine(List<String> lines, int startLine, List<String> markers)

Attempts to locate a line that contains one of the markers

Parameters

lines:List<String>: The list of lines to scan - ignored if null/empty
startLine:int: The scan start line index
markers:List<String>: The markers to match - ignored if null/empty

Returns:AbstractMap.SimpleImmutableEntry<Integer, Integer>

A SimpleImmutableEntry whose key is the first line index that matched and value the matched marker index - null if no match found

joinDataLines	back to summary
public static String joinDataLines(Collection<String> lines)

public Interface KeyPairResourceParser

Field Summary

Method Summary

Field Detail

Method Detail