com.jcabi.ssh

Class SSHD

java.lang.Object

com.jcabi.ssh.SSHD

All Implemented Interfaces:

Closeable, AutoCloseable

public final class SSHD
extends Object
implements Closeable

Test SSHD daemon (only for Linux).

It is a convenient class for unit testing of your SSH clients:

 try (SSHD sshd = new SSHD()) {
   String uptime = new Shell.Plain(
     SSH(sshd.host(), sshd.login(), sshd.port(), sshd.key())
   ).exec("uptime");
 }

If you forget to call close(), SSH daemon will be up and running until a shutdown of the JVM.

Since:

1.0

Version:

$Id: 8a7f6e6f48d8cfd0672a271fd83f443ec5f6e340 $

Author:

Yegor Bugayenko (yegor@teamed.io)

Suppressed Checkstyle violations:

MultipleStringLiteralsCheck (500 lines), ClassDataAbstractionCouplingCheck (500 lines)

Constructor Summary

Constructors

Constructor and Description
SSHD() Ctor.
SSHD(File path) Ctor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
Shell	connect() Get an instance of Shell.
File	home() Get home dir.
String	host() Get host of SSH.
String	key() Get private SSH key for login.
String	login() Get user name to login.
int	port() Get port.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHD

public SSHD()
     throws IOException

Ctor.

Throws:

IOException - If fails

Since:

1.5

SSHD

public SSHD(File path)
     throws IOException

Ctor.

Parameters:

path - Directory to work in

Throws:

IOException - If fails

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

home

public File home()

Get home dir.

Returns:

Dir

login

public String login()

Get user name to login.

Returns:

User name

host

public String host()

Get host of SSH.

Returns:

Hostname

Since:

1.1

port

public int port()

Get port.

Don't forget to start

Returns:

Port number

Since:

1.1

key

public String key()
           throws IOException

Get private SSH key for login.

Returns:

Key

Throws:

IOException - If fails

connect

public Shell connect()
              throws IOException

Get an instance of Shell.

Returns:

Shell

Throws:

IOException - If fails