Package org.apache.sshd.cli.client

Class SshClientCliSupport

java.lang.Object

org.apache.sshd.cli.CliSupport

org.apache.sshd.cli.client.SshClientCliSupport

Direct Known Subclasses:

ScpCommandMain, SftpCommandMain, SshClientMain

public abstract class SshClientCliSupport
extends CliSupport

TODO Add javadoc

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SSH_CLIENT_PORT_OPTION	Command line option used to indicate non-default target port

Fields inherited from class org.apache.sshd.cli.CliSupport

DEFAULT_IO_SERVICE_FACTORY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SshClientCliSupport()

Method Summary

Modifier and Type	Method	Description
static boolean	isArgumentedOption(String portOption, String argName)
static Map<String,?>	resolveClientEnvironment(Map<String,?> options)
static Map<String,?>	resolveClientEnvironment(PropertyResolver resolver)
static Map<PtyMode,Integer>	resolveClientPtyModes(Map<String,?> options)
static PtyChannelConfiguration	resolveClientPtyOptions(Map<String,?> options)
static PtyChannelConfiguration	resolveClientPtyOptions(PropertyResolver resolver)
static HostConfigEntry	resolveHost(ClientFactoryManager client, String username, String host, int port, String proxyJump)
static Path	resolveIdentityFile(String id)
static OutputStream	resolveLoggingTargetStream(PrintStream stdout, PrintStream stderr, String... args)
static OutputStream	resolveLoggingTargetStream(PrintStream stdout, PrintStream stderr, String[] args, int maxIndex)
static SshClient	setupClient(PropertyResolver resolver, List<NamedFactory<Cipher>> ciphers, List<NamedFactory<Mac>> macs, List<NamedFactory<Compression>> compressions, Collection<? extends Path> identities, BufferedReader stdin, PrintStream stdout, PrintStream stderr, Level level, String[] args)
static ClientSession	setupClientSession(String portOption, BufferedReader stdin, Level level, PrintStream stdout, PrintStream stderr, String... args)
static SshClient	setupDefaultClient(PropertyResolver resolver, Level level, PrintStream stdout, PrintStream stderr, String... args)
static Handler	setupLogging(Level level, PrintStream stdout, PrintStream stderr, OutputStream outputStream)
static ServerKeyVerifier	setupServerKeyVerifier(ClientAuthenticationManager manager, PropertyResolver resolver, BufferedReader stdin, PrintStream stdout, PrintStream stderr)
static void	setupSessionExtensions(KexFactoryManager manager, PropertyResolver resolver, BufferedReader stdin, PrintStream stdout, PrintStream stderr)
static FileKeyPairProvider	setupSessionIdentities(ClientFactoryManager client, Collection<? extends Path> identities, BufferedReader stdin, PrintStream stdout, PrintStream stderr)
static UserInteraction	setupSessionUserInteraction(ClientAuthenticationManager client, BufferedReader stdin, PrintStream stdout, PrintStream stderr)

Methods inherited from class org.apache.sshd.cli.CliSupport

createLoggingIoServiceEventListener, createLoggingSessionListener, printFieldsValues, resolveBuiltinIoServiceFactory, resolveIoServiceFactory, setupCiphers, setupCiphers, setupCompressions, setupCompressions, setupIoServiceFactory, setupMacs, setupMacs, setupUserAuthFactories, splitCommandLineArguments

Methods inherited from class java.lang.Object

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

Field Details

SSH_CLIENT_PORT_OPTION

public static final String SSH_CLIENT_PORT_OPTION

Command line option used to indicate non-default target port

See Also:

• Constant Field Values

Constructor Details

SshClientCliSupport

protected SshClientCliSupport()

Method Details

isArgumentedOption

public static boolean isArgumentedOption(String portOption,
 String argName)

setupClientSession

public static ClientSession setupClientSession(String portOption,
 BufferedReader stdin,
 Level level,
 PrintStream stdout,
 PrintStream stderr,
 String... args)
                                        throws Exception

Throws:

Exception

resolveHost

public static HostConfigEntry resolveHost(ClientFactoryManager client,
 String username,
 String host,
 int port,
 String proxyJump)
                                   throws IOException

Throws:

IOException

resolveIdentityFile

public static Path resolveIdentityFile(String id)
                                throws IOException

Throws:

IOException

resolveClientEnvironment

public static Map<String,?> resolveClientEnvironment(PropertyResolver resolver)

resolveClientEnvironment

public static Map<String,?> resolveClientEnvironment(Map<String,?> options)

resolveClientPtyOptions

public static PtyChannelConfiguration resolveClientPtyOptions(PropertyResolver resolver)
                                                       throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

resolveClientPtyOptions

public static PtyChannelConfiguration resolveClientPtyOptions(Map<String,?> options)
                                                       throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

resolveClientPtyModes

public static Map<PtyMode,Integer> resolveClientPtyModes(Map<String,?> options)
                                                  throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

setupDefaultClient

public static SshClient setupDefaultClient(PropertyResolver resolver,
 Level level,
 PrintStream stdout,
 PrintStream stderr,
 String... args)

setupClient

public static SshClient setupClient(PropertyResolver resolver,
 List<NamedFactory<Cipher>> ciphers,
 List<NamedFactory<Mac>> macs,
 List<NamedFactory<Compression>> compressions,
 Collection<? extends Path> identities,
 BufferedReader stdin,
 PrintStream stdout,
 PrintStream stderr,
 Level level,
 String[] args)
                             throws Exception

Throws:

Exception

setupSessionIdentities

public static FileKeyPairProvider setupSessionIdentities(ClientFactoryManager client,
 Collection<? extends Path> identities,
 BufferedReader stdin,
 PrintStream stdout,
 PrintStream stderr)
                                                  throws Throwable

Throws:

Throwable

setupSessionUserInteraction

public static UserInteraction setupSessionUserInteraction(ClientAuthenticationManager client,
 BufferedReader stdin,
 PrintStream stdout,
 PrintStream stderr)

setupSessionExtensions

public static void setupSessionExtensions(KexFactoryManager manager,
 PropertyResolver resolver,
 BufferedReader stdin,
 PrintStream stdout,
 PrintStream stderr)
                                   throws Exception

Throws:

Exception

setupServerKeyVerifier

public static ServerKeyVerifier setupServerKeyVerifier(ClientAuthenticationManager manager,
 PropertyResolver resolver,
 BufferedReader stdin,
 PrintStream stdout,
 PrintStream stderr)

resolveLoggingTargetStream

public static OutputStream resolveLoggingTargetStream(PrintStream stdout,
 PrintStream stderr,
 String... args)

resolveLoggingTargetStream

public static OutputStream resolveLoggingTargetStream(PrintStream stdout,
 PrintStream stderr,
 String[] args,
 int maxIndex)

setupLogging

public static Handler setupLogging(Level level,
 PrintStream stdout,
 PrintStream stderr,
 OutputStream outputStream)