com.rultor.shell.ssh

Class SSHChannel

java.lang.Object

com.rultor.shell.ssh.SSHChannel

All Implemented Interfaces:

Shell, Closeable, AutoCloseable

@Loggable(value=1)
public final class SSHChannel
extends Object
implements Shell

Single SSH Channel.

Since:

1.0

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Constructor Summary

Constructors

Constructor and Description
SSHChannel(InetAddress adr, int prt, String user, PrivateKey priv) Constructor.
SSHChannel(InetAddress adr, String user, PrivateKey priv) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
void	badge(String name, String value) Add a new badge.
void	close()
int	exec(String command, InputStream stdin, OutputStream stdout, OutputStream stderr) Exec one command.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHChannel

public SSHChannel(@NotNull(message="IP address can\'t be NULL")
          InetAddress adr,
          int prt,
          @NotNull(message="user name can\'t be NULL")
          String user,
          @NotNull(message="private key can\'t be NULL")
          PrivateKey priv)

Constructor.

Parameters:

adr - IP address

prt - Port of server

user - Login

priv - Private SSH key

Suppressed Checkstyle violations:

ParameterNumberCheck (6 lines)

SSHChannel

public SSHChannel(@NotNull(message="IP address can\'t be NULL")
          InetAddress adr,
          @NotNull(message="user name can\'t be NULL")
          String user,
          @NotNull(message="private key can\'t be NULL")
          PrivateKey priv)

Public ctor.

Parameters:

adr - IP address

user - Login

priv - Private SSH key

Method Detail

exec

@Loggable(value=1,
          limit=1,
          unit=HOURS)
public int exec(@NotNull(message="command can\'t be NULL")
                                   String command,
                                   @NotNull(message="stdin can\'t be NULL")
                                   InputStream stdin,
                                   @NotNull(message="stdout can\'t be NULL")
                                   OutputStream stdout,
                                   @NotNull(message="stderr can\'t be NULL")
                                   OutputStream stderr)
         throws IOException

Exec one command.

Specified by:

exec in interface Shell

Parameters:

command - Command to execute

stdin - Input stream

stdout - Output stream

stderr - Error output stream

Returns:

Exit code

Throws:

IOException - If fails

Suppressed Checkstyle violations:

ParameterNumber (10 lines)

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

badge

public void badge(String name,
         String value)

Description copied from interface: Shell

Add a new badge.

Specified by:

badge in interface Shell

Parameters:

name - Badge name

value - Value of the badge