public class SshClient extends AbstractFactoryManager implements ClientFactoryManager, Closeable
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(); }
Modifier and Type | Field and Description |
---|---|
protected IoConnector |
connector |
protected Factory<IoConnector> |
connectorFactory |
protected SessionFactory |
sessionFactory |
protected List<NamedFactory<UserAuth>> |
userAuthFactories |
protected UserInteraction |
userInteraction |
agentFactory, channelFactories, cipherFactories, compressionFactories, executor, fileSystemFactory, globalRequestHandlers, ioServiceFactory, ioServiceFactoryFactory, keyExchangeFactories, keyPairProvider, log, macFactories, properties, randomFactory, serviceFactories, shutdownExecutor, signatureFactories, tcpipForwarderFactory, tcpipForwardingFilter, version
HEARTBEAT_INTERVAL, HEARTBEAT_REQUEST, PASSWORD_PROMPTS, PREFERRED_AUTHS
DEFAULT_NIO_WORKERS, MAX_PACKET_SIZE, NIO_WORKERS, WINDOW_SIZE
Constructor and Description |
---|
SshClient() |
Modifier and Type | Method and Description |
---|---|
protected void |
checkConfig() |
CloseFuture |
close(boolean immediately)
Close this resource asynchronously and return a future.
|
ConnectFuture |
connect(SocketAddress address)
Deprecated.
|
ConnectFuture |
connect(String host,
int port)
Deprecated.
|
ConnectFuture |
connect(String username,
SocketAddress address) |
ConnectFuture |
connect(String username,
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() |
List<NamedFactory<UserAuth>> |
getUserAuthFactories()
Retrieve a list of UserAuth factories.
|
UserInteraction |
getUserInteraction()
Retrieve the UserInteraction object to communicate with the user.
|
static void |
main(String[] args) |
void |
open() |
void |
setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier) |
void |
setSessionFactory(SessionFactory sessionFactory) |
static SshClient |
setUpDefaultClient()
Setup a default client.
|
void |
setUserAuthFactories(List<NamedFactory<UserAuth>> userAuthFactories) |
void |
setUserInteraction(UserInteraction userInteraction) |
void |
start() |
void |
stop() |
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getTcpipForwarderFactory
getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getProperties, getRandomFactory, getScheduledExecutorService, getServiceFactories, getSignatureFactories, getTcpipForwardingFilter, getVersion
protected IoConnector connector
protected SessionFactory sessionFactory
protected UserInteraction userInteraction
protected Factory<IoConnector> connectorFactory
protected List<NamedFactory<UserAuth>> userAuthFactories
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)
public List<NamedFactory<UserAuth>> getUserAuthFactories()
ClientFactoryManager
getUserAuthFactories
in interface ClientFactoryManager
UserAuth
factories, never null
public void setUserAuthFactories(List<NamedFactory<UserAuth>> userAuthFactories)
protected void checkConfig()
public void start()
public void stop()
public void open() throws IOException
IOException
public CloseFuture close(boolean immediately)
Closeable
@Deprecated public ConnectFuture connect(String host, int port) throws IOException
IOException
public ConnectFuture connect(String username, String host, int port) throws IOException
IOException
@Deprecated public ConnectFuture connect(SocketAddress address)
public ConnectFuture connect(String username, SocketAddress address)
protected IoConnector createConnector()
protected SessionFactory createSessionFactory()
public static SshClient setUpDefaultClient()
Copyright © 2008–2014 The Apache Software Foundation. All rights reserved.