org.apache.sshd

Class SshClient

java.lang.Object

org.apache.sshd.common.AbstractFactoryManager

org.apache.sshd.SshClient

All Implemented Interfaces:

ClientFactoryManager, Closeable, FactoryManager

public class SshClient
extends AbstractFactoryManager
implements ClientFactoryManager, Closeable

Entry point for the client side of the SSH protocol. The default configured client can be created using the setUpDefaultClient(). The next step is to start the client using the start() method. Sessions can then be created using on of the connect(String, int) or connect(java.net.SocketAddress) methods. The client can be stopped at anytime using the stop() method. Following is an example of using the SshClient:

    SshClient client = SshClient.setUpDefaultClient();
    client.start();
    try {
        ClientSession session = client.connect(host, port).await().getSession();

        int ret = ClientSession.WAIT_AUTH;
        while ((ret & ClientSession.WAIT_AUTH) != 0) {
            System.out.print("Password:");
            BufferedReader r = new BufferedReader(new InputStreamReader(System.in));
            String password = r.readLine();
            session.authPassword(login, password);
            ret = session.waitFor(ClientSession.WAIT_AUTH | ClientSession.CLOSED | ClientSession.AUTHED, 0);
        }
        if ((ret & ClientSession.CLOSED) != 0) {
            System.err.println("error");
            System.exit(-1);
        }
        ClientChannel channel = session.createChannel("shell");
        channel.setIn(new NoCloseInputStream(System.in));
        channel.setOut(new NoCloseOutputStream(System.out));
        channel.setErr(new NoCloseOutputStream(System.err));
        channel.open();
        channel.waitFor(ClientChannel.CLOSED, 0);
        session.close(false);
    } finally {
        client.stop();
    }
 

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
protected IoConnector	connector
protected Factory<IoConnector>	connectorFactory
protected SessionFactory	sessionFactory
protected java.util.List<NamedFactory<UserAuth>>	userAuthFactories
protected UserInteraction	userInteraction

Fields inherited from class org.apache.sshd.common.AbstractFactoryManager

agentFactory, channelFactories, cipherFactories, compressionFactories, executor, fileSystemFactory, globalRequestHandlers, ioServiceFactory, ioServiceFactoryFactory, keyExchangeFactories, keyPairProvider, log, macFactories, properties, randomFactory, serviceFactories, shutdownExecutor, signatureFactories, tcpipForwarderFactory, tcpipForwardingFilter, version

Fields inherited from interface org.apache.sshd.client.ClientFactoryManager

HEARTBEAT_INTERVAL, HEARTBEAT_REQUEST, PASSWORD_PROMPTS, PREFERRED_AUTHS

Fields inherited from interface org.apache.sshd.common.FactoryManager

DEFAULT_NIO_WORKERS, MAX_PACKET_SIZE, NIO_WORKERS, WINDOW_SIZE

Constructor Summary

Constructors

Constructor and Description
SshClient()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkConfig()
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
ConnectFuture	connect(java.net.SocketAddress address) Deprecated.
ConnectFuture	connect(java.lang.String host, int port) Deprecated.
ConnectFuture	connect(java.lang.String username, java.net.SocketAddress address)
ConnectFuture	connect(java.lang.String username, java.lang.String host, int port)
protected IoConnector	createConnector()
protected SessionFactory	createSessionFactory()
ServerKeyVerifier	getServerKeyVerifier() Retrieve the server key verifier to be used to check the key when connecting to an ssh server.
SessionFactory	getSessionFactory()
java.util.List<NamedFactory<UserAuth>>	getUserAuthFactories() Retrieve a list of UserAuth factories.
UserInteraction	getUserInteraction() Retrieve the UserInteraction object to communicate with the user.
static void	main(java.lang.String[] args)
void	open()
void	setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier)
void	setSessionFactory(SessionFactory sessionFactory)
static SshClient	setUpDefaultClient() Setup a default client.
void	setUserAuthFactories(java.util.List<NamedFactory<UserAuth>> userAuthFactories)
void	setUserInteraction(UserInteraction userInteraction)
void	start()
void	stop()

Methods inherited from class org.apache.sshd.common.AbstractFactoryManager

getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getIoServiceFactoryFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getNioWorkers, getProperties, getRandomFactory, getScheduledExecutorService, getServiceFactories, getSignatureFactories, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion, loadVersion, setAgentFactory, setChannelFactories, setCipherFactories, setCompressionFactories, setFileSystemFactory, setGlobalRequestHandlers, setIoServiceFactoryFactory, setKeyExchangeFactories, setKeyPairProvider, setMacFactories, setNioWorkers, setProperties, setRandomFactory, setScheduledExecutorService, setScheduledExecutorService, setServiceFactories, setSignatureFactories, setTcpipForwarderFactory, setTcpipForwardingFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.client.ClientFactoryManager

getTcpipForwarderFactory

Methods inherited from interface org.apache.sshd.common.FactoryManager

getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getProperties, getRandomFactory, getScheduledExecutorService, getServiceFactories, getSignatureFactories, getTcpipForwardingFilter, getVersion

Field Detail

connector

protected IoConnector connector

sessionFactory

protected SessionFactory sessionFactory

userInteraction

protected UserInteraction userInteraction

connectorFactory

protected Factory<IoConnector> connectorFactory

userAuthFactories

protected java.util.List<NamedFactory<UserAuth>> userAuthFactories

Constructor Detail

SshClient

public SshClient()

Method Detail

getSessionFactory

public SessionFactory getSessionFactory()

setSessionFactory

public void setSessionFactory(SessionFactory sessionFactory)

getServerKeyVerifier

public ServerKeyVerifier getServerKeyVerifier()

Description copied from interface: ClientFactoryManager

Retrieve the server key verifier to be used to check the key when connecting to an ssh server.

Specified by:

getServerKeyVerifier in interface ClientFactoryManager

Returns:

the server key verifier to use

setServerKeyVerifier

public void setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier)

getUserInteraction

public UserInteraction getUserInteraction()

Description copied from interface: ClientFactoryManager

Retrieve the UserInteraction object to communicate with the user.

Specified by:

getUserInteraction in interface ClientFactoryManager

Returns:

A UserInteraction or null

setUserInteraction

public void setUserInteraction(UserInteraction userInteraction)

getUserAuthFactories

public java.util.List<NamedFactory<UserAuth>> getUserAuthFactories()

Description copied from interface: ClientFactoryManager

Retrieve a list of UserAuth factories.

Specified by:

getUserAuthFactories in interface ClientFactoryManager

Returns:

a list of named UserAuth factories, never null

setUserAuthFactories

public void setUserAuthFactories(java.util.List<NamedFactory<UserAuth>> userAuthFactories)

checkConfig

protected void checkConfig()

start

public void start()

stop

public void stop()

open

public void open()
          throws java.io.IOException

Throws:

java.io.IOException

close

public CloseFuture close(boolean immediately)

Description copied from interface: Closeable

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Specified by:

close in interface Closeable

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a future

connect

@Deprecated
public ConnectFuture connect(java.lang.String host,
                               int port)
                      throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

connect

public ConnectFuture connect(java.lang.String username,
                    java.lang.String host,
                    int port)
                      throws java.io.IOException

Throws:

java.io.IOException

connect

@Deprecated
public ConnectFuture connect(java.net.SocketAddress address)

Deprecated.

connect

public ConnectFuture connect(java.lang.String username,
                    java.net.SocketAddress address)

createConnector

protected IoConnector createConnector()

createSessionFactory

protected SessionFactory createSessionFactory()

setUpDefaultClient

public static SshClient setUpDefaultClient()

Setup a default client. The client does not require any additional setup.

Returns:

a newly create SSH client

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception