com.helger.jsch.command

Class CommandRunner

java.lang.Object

com.helger.jsch.command.CommandRunner

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<CommandRunner>, AutoCloseable

public class CommandRunner
extends Object
implements AutoCloseable, com.helger.commons.lang.ICloneable<CommandRunner>

Provides a convenience wrapper around an exec channel. This implementation offers a simplified interface to executing remote commands and retrieving the results of execution.

See Also:

ChannelExec

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CommandRunner.ChannelExecWrapper Wraps the execution of a command to handle the opening and closing of all the data streams for you.
class	CommandRunner.ExecuteResult A simple container for the results of a command execution.

Field Summary

Fields

Modifier and Type	Field and Description
protected SessionManager	m_aSessionManager

Constructor Summary

Constructors

Constructor and Description
CommandRunner(ISessionFactory sessionFactory) Creates a new CommandRunner that will use a SessionManager that wraps the supplied sessionFactory.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying SessionManager.
CommandRunner.ExecuteResult	execute(String command) Executes command and returns the result.
CommandRunner	getClone() Returns a new CommandRunner with the same SessionFactory, but will create a separate session.
CommandRunner.ChannelExecWrapper	open(String command) Executes command and returns an execution wrapper that provides safe access to and management of the underlying streams of data.

Methods inherited from class java.lang.Object

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

Field Detail

m_aSessionManager

protected final SessionManager m_aSessionManager

Constructor Detail

CommandRunner

public CommandRunner(@Nonnull
                     ISessionFactory sessionFactory)

Creates a new CommandRunner that will use a SessionManager that wraps the supplied sessionFactory.

Parameters:

sessionFactory - The factory used to create a session manager

Method Detail

close

public void close()
           throws IOException

Closes the underlying SessionManager.

Specified by:

close in interface AutoCloseable

Throws:

IOException

See Also:

SessionManager.close()

getClone

@Nonnull
 @ReturnsMutableCopy
public CommandRunner getClone()

Returns a new CommandRunner with the same SessionFactory, but will create a separate session.

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<CommandRunner>

Returns:

A duplicate CommandRunner with a different session.

execute

public CommandRunner.ExecuteResult execute(String command)
                                    throws com.jcraft.jsch.JSchException,
                                           IOException

Executes command and returns the result. Use this method when the command you are executing requires no input, writes only UTF-8 compatible text to STDOUT and/or STDERR, and you are comfortable with buffering up all of that data in memory. Otherwise, use open(String), which allows you to work with the underlying streams.

Parameters:

command - The command to execute

Returns:

The resulting data

Throws:

com.jcraft.jsch.JSchException - If ssh execution fails

IOException - If unable to read the result data

open

@Nonnull
public CommandRunner.ChannelExecWrapper open(String command)
                                                throws com.jcraft.jsch.JSchException,
                                                       IOException

Executes command and returns an execution wrapper that provides safe access to and management of the underlying streams of data.

Parameters:

command - The command to execute

Returns:

An execution wrapper that allows you to process the streams

Throws:

com.jcraft.jsch.JSchException - If ssh execution fails

IOException - If unable to read the result data