public class SshClient extends AbstractFactoryManager implements ClientFactoryManager
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); 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(); } finally { client.stop(); }
Modifier and Type | Field and Description |
---|---|
protected IoConnector |
connector |
protected Factory<IoConnector> |
connectorFactory |
protected SessionFactory |
sessionFactory |
protected UserInteraction |
userInteraction |
agentFactory, channelFactories, cipherFactories, compressionFactories, executor, fileSystemFactory, ioServiceFactory, keyExchangeFactories, keyPairProvider, macFactories, properties, randomFactory, shutdownExecutor, signatureFactories, tcpipForwarderFactory, tcpipForwardingFilter, version
HEARTBEAT_INTERVAL, HEARTBEAT_REQUEST
DEFAULT_NIO_WORKERS, MAX_PACKET_SIZE, NIO_WORKERS, WINDOW_SIZE
Constructor and Description |
---|
SshClient() |
Modifier and Type | Method and Description |
---|---|
protected void |
checkConfig() |
ConnectFuture |
connect(SocketAddress address) |
ConnectFuture |
connect(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() |
UserInteraction |
getUserInteraction()
Retrieve the UserInteraction object to communicate with the user.
|
static void |
main(String[] args) |
void |
setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier) |
void |
setSessionFactory(SessionFactory sessionFactory) |
static SshClient |
setUpDefaultClient()
Setup a default client.
|
void |
setUserInteraction(UserInteraction userInteraction) |
void |
start() |
void |
stop() |
getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getIoServiceFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getNioWorkers, getProperties, getRandomFactory, getScheduledExecutorService, getSignatureFactories, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion, loadVersion, setAgentFactory, setChannelFactories, setCipherFactories, setCompressionFactories, setFileSystemFactory, setIoServiceFactory, setKeyExchangeFactories, setKeyPairProvider, setMacFactories, setNioWorkers, setProperties, setRandomFactory, setScheduledExecutorService, setScheduledExecutorService, setSignatureFactories, setTcpipForwarderFactory, setTcpipForwardingFilter
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getTcpipForwarderFactory
getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getIoServiceFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getProperties, getRandomFactory, getScheduledExecutorService, getSignatureFactories, getTcpipForwardingFilter, getVersion
protected IoConnector connector
protected SessionFactory sessionFactory
protected UserInteraction userInteraction
protected Factory<IoConnector> connectorFactory
public SessionFactory getSessionFactory()
public void setSessionFactory(SessionFactory sessionFactory)
public ServerKeyVerifier getServerKeyVerifier()
ClientFactoryManager
getServerKeyVerifier
in interface ClientFactoryManager
public void setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier)
public UserInteraction getUserInteraction()
ClientFactoryManager
getUserInteraction
in interface ClientFactoryManager
UserInteraction
or null
public void setUserInteraction(UserInteraction userInteraction)
protected void checkConfig()
public void start()
public void stop()
public ConnectFuture connect(String host, int port) throws IOException
IOException
public ConnectFuture connect(SocketAddress address)
protected IoConnector createConnector()
protected SessionFactory createSessionFactory()
public static SshClient setUpDefaultClient()
Copyright © 2008–2013 The Apache Software Foundation. All rights reserved.