Package com.sshtools.client.shell

Class ExpectShell

java.lang.Object

com.sshtools.client.shell.ExpectShell

public class ExpectShell
extends Object

Execute commands within a shell, capturing the output of just the command itself.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ExpectShell.ExpectShellBuilder	Builder that creates an ExpectShell.
static enum	ExpectShell.OS	Enumeration of operating systems, that also encapsulates some operating specific information

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EXIT_CODE_PROCESS_ACTIVE
static final int	EXIT_CODE_UNKNOWN
static final int	OS_AIX	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_DARWIN	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_FREEBSD	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_HPUX	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_LINUX	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_NETBSD	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_OPENBSD	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_OPENVMS	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_POWERSHELL	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_SOLARIS	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_UNIX	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_UNKNOWN	Deprecated, for removal: This API element is subject to removal in a future version.
static final int	OS_WINDOWS	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
ExpectShell(SessionChannelNG session, int osType)	Deprecated, for removal: This API element is subject to removal in a future version.
ExpectShell(SessionChannelNG session, ShellStartupTrigger trigger, long startupTimeout, ExpectShell.OS osType)	Deprecated, for removal: This API element is subject to removal in a future version.
ExpectShell(AbstractSessionTask<SessionChannelNG> session)	Deprecated, for removal: This API element is subject to removal in a future version.
ExpectShell(AbstractSessionTask<SessionChannelNG> session, int osType)	Deprecated, for removal: This API element is subject to removal in a future version.
ExpectShell(AbstractSessionTask<SessionChannelNG> session, ShellStartupTrigger trigger)	Deprecated, for removal: This API element is subject to removal in a future version.
ExpectShell(AbstractSessionTask<SessionChannelNG> session, ShellStartupTrigger trigger, long startupTimeout)	Deprecated, for removal: This API element is subject to removal in a future version.
ExpectShell(AbstractSessionTask<SessionChannelNG> session, ShellStartupTrigger trigger, long startupTimeout, int osType)	Deprecated, for removal: This API element is subject to removal in a future version.
ExpectShell(InputStream in, OutputStream out, ExpectShell parentShell)	Deprecated, for removal: This API element is subject to removal in a future version.
ExpectShell(InputStream in, OutputStream out, ExpectShell parentShell, ExpectShell.OS osType)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	close()
void	execute(String cmd)
ShellProcess	executeCommand(String origCmd)
ShellProcess	executeCommand(String origCmd, boolean consume)
ShellProcess	executeCommand(String origCmd, boolean matchPromptMarker, boolean consume)
ShellProcess	executeCommand(String origCmd, boolean matchPromptMarker, boolean consume, String charsetName)
ShellProcess	executeCommand(String origCmd, boolean consume, String charset)
ShellProcess	executeCommand(String origCmd, String charset)
int	executeWithExitCode(String cmd)
String	executeWithOutput(String cmd)
void	exit()
String	getCharacterEncoding()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getNewline()
int	getNumCommandsExecuted()
String	getOsDescription()
int	getOsType()
InputStream	getStartupInputStream()
ShellReader	getStartupReader()
boolean	inStartup()
boolean	isClosed()
void	setCharacterEncoding(String characterEncoding)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setPasswordErrorText(String passwordErrorText)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setPasswordPrompt(String passwordPrompt)	Deprecated, for removal: This API element is subject to removal in a future version.
static void	setShellInitTimeout(int timeout)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setSudoPassword(Optional<String> sudoPassword)
ExpectShell	su(String cmd)
ExpectShell	su(String cmd, String password)
ExpectShell	su(String cmd, String password, String passwordPrompt)
ExpectShell	su(String cmd, String password, String passwordPrompt, ShellMatcher matcher)
ShellProcess	sudo(String cmd)
ShellProcess	sudo(String cmd, String password)
ShellProcess	sudo(String cmd, String password, String promptExpression)
ShellProcess	sudo(String cmd, String password, String promptExpression, ShellMatcher matcher)

Methods inherited from class java.lang.Object

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

Field Details

OS_WINDOWS

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_WINDOWS

Deprecated, for removal: This API element is subject to removal in a future version.

Windows operating system

See Also:

• Constant Field Values

OS_LINUX

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_LINUX

Deprecated, for removal: This API element is subject to removal in a future version.

Linux operating system

See Also:

• Constant Field Values

OS_SOLARIS

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_SOLARIS

Deprecated, for removal: This API element is subject to removal in a future version.

Solaris operating system

See Also:

• Constant Field Values

OS_AIX

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_AIX

Deprecated, for removal: This API element is subject to removal in a future version.

AIX operating system

See Also:

• Constant Field Values

OS_DARWIN

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_DARWIN

Deprecated, for removal: This API element is subject to removal in a future version.

Darwin (MAC) operating system

See Also:

• Constant Field Values

OS_FREEBSD

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_FREEBSD

Deprecated, for removal: This API element is subject to removal in a future version.

FreeBSD operating system

See Also:

• Constant Field Values

OS_OPENBSD

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_OPENBSD

Deprecated, for removal: This API element is subject to removal in a future version.

OpenBSD operating system

See Also:

• Constant Field Values

OS_NETBSD

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_NETBSD

Deprecated, for removal: This API element is subject to removal in a future version.

NetBSD operating system

See Also:

• Constant Field Values

OS_HPUX

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_HPUX

Deprecated, for removal: This API element is subject to removal in a future version.

HP-UX operating system

See Also:

• Constant Field Values

OS_UNIX

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_UNIX

Deprecated, for removal: This API element is subject to removal in a future version.

Unix OS if less than this value.

See Also:

• Constant Field Values

OS_OPENVMS

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_OPENVMS

Deprecated, for removal: This API element is subject to removal in a future version.

OpenVMS operating system

See Also:

• Constant Field Values

OS_POWERSHELL

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_POWERSHELL

Deprecated, for removal: This API element is subject to removal in a future version.

Linux operating system

See Also:

• Constant Field Values

OS_UNKNOWN

@Deprecated(forRemoval=true,
            since="3.1.3")
public static final int OS_UNKNOWN

Deprecated, for removal: This API element is subject to removal in a future version.

The operating system is unknown

See Also:

• Constant Field Values

EXIT_CODE_PROCESS_ACTIVE

public static final int EXIT_CODE_PROCESS_ACTIVE

See Also:

• Constant Field Values

EXIT_CODE_UNKNOWN

public static final int EXIT_CODE_UNKNOWN

See Also:

• Constant Field Values

Constructor Details

ExpectShell

@Deprecated(since="3.2.0",
            forRemoval=true)
public ExpectShell(AbstractSessionTask<SessionChannelNG> session)
            throws SshException,
IOException,
ShellTimeoutException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated(since="3.2.0",
            forRemoval=true)
public ExpectShell(AbstractSessionTask<SessionChannelNG> session,
 int osType)
            throws SshException,
IOException,
ShellTimeoutException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated(since="3.2.0",
            forRemoval=true)
public ExpectShell(AbstractSessionTask<SessionChannelNG> session,
 ShellStartupTrigger trigger)
            throws SshException,
IOException,
ShellTimeoutException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated(since="3.2.0",
            forRemoval=true)
public ExpectShell(AbstractSessionTask<SessionChannelNG> session,
 ShellStartupTrigger trigger,
 long startupTimeout)
            throws SshException,
IOException,
ShellTimeoutException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated(forRemoval=true)
public ExpectShell(AbstractSessionTask<SessionChannelNG> session,
 ShellStartupTrigger trigger,
 long startupTimeout,
 int osType)
            throws SshException,
IOException,
ShellTimeoutException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated(since="3.2.0",
            forRemoval=true)
public ExpectShell(SessionChannelNG session,
 int osType)
            throws SshException,
IOException,
ShellTimeoutException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated(since="3.2.0",
            forRemoval=true)
public ExpectShell(SessionChannelNG session,
 ShellStartupTrigger trigger,
 long startupTimeout,
 ExpectShell.OS osType)
            throws SshException,
IOException,
ShellTimeoutException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated(since="3.2.0",
            forRemoval=true)
public ExpectShell(InputStream in,
 OutputStream out,
 ExpectShell parentShell)
            throws SshIOException,
SshException,
IOException,
ShellTimeoutException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

SshIOException

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated(since="3.2.0")
public ExpectShell(InputStream in,
 OutputStream out,
 ExpectShell parentShell,
 ExpectShell.OS osType)
            throws SshIOException,
SshException,
IOException,
ShellTimeoutException

Deprecated.

Deprecated. Will be made private at 3.3.0.

Parameters:

in - in

out - out

parentShell - parentShell

osType - os type

Throws:

SshIOException - on SSH IO error

SshException - on SSH errror

IOException - on IO error

ShellTimeoutException - on timeout

Method Details

getCharacterEncoding

@Deprecated(since="3.2.0",
            forRemoval=true)
public String getCharacterEncoding()

Deprecated, for removal: This API element is subject to removal in a future version.

setCharacterEncoding

@Deprecated(since="3.2.0",
            forRemoval=true)
public void setCharacterEncoding(String characterEncoding)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the default character encoding.

Deprecated for removal. Character encoding will become final, use the builder option instead.

Parameters:

characterEncoding - character encoding.

setShellInitTimeout

@Deprecated(forRemoval=true,
            since="3.1.3")
public static void setShellInitTimeout(int timeout)

Deprecated, for removal: This API element is subject to removal in a future version.

getStartupInputStream

public InputStream getStartupInputStream()

inStartup

public boolean inStartup()

setPasswordErrorText

@Deprecated(since="3.2.0",
            forRemoval=true)
public void setPasswordErrorText(String passwordErrorText)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the password error text string.

Deprecated for removal. Password error text will become final, use the builder option instead.

Parameters:

passwordErrorText - password error text

setPasswordPrompt

@Deprecated(since="3.2.0",
            forRemoval=true)
public void setPasswordPrompt(String passwordPrompt)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the password prompt string.

Deprecated for removal. Password prompt will become final, use the builder option instead.

Parameters:

passwordPrompt - password prompt

getStartupReader

public ShellReader getStartupReader()

su

public ExpectShell su(String cmd,
 String password)
               throws SshIOException,
SshException,
IOException,
ShellTimeoutException

Throws:

SshIOException

SshException

IOException

ShellTimeoutException

su

public ExpectShell su(String cmd,
 String password,
 String passwordPrompt)
               throws SshException,
SshIOException,
IOException,
ShellTimeoutException

Throws:

SshException

SshIOException

IOException

ShellTimeoutException

su

public ExpectShell su(String cmd)
               throws SshException,
SshIOException,
IOException,
ShellTimeoutException

Throws:

SshException

SshIOException

IOException

ShellTimeoutException

su

public ExpectShell su(String cmd,
 String password,
 String passwordPrompt,
 ShellMatcher matcher)
               throws SshException,
SshIOException,
IOException,
ShellTimeoutException

Throws:

SshException

SshIOException

IOException

ShellTimeoutException

sudo

public ShellProcess sudo(String cmd,
 String password)
                  throws SshException,
ShellTimeoutException,
IOException

Throws:

SshException

ShellTimeoutException

IOException

sudo

public ShellProcess sudo(String cmd)
                  throws SshException,
ShellTimeoutException,
IOException

Throws:

SshException

ShellTimeoutException

IOException

sudo

public ShellProcess sudo(String cmd,
 String password,
 String promptExpression)
                  throws SshException,
ShellTimeoutException,
IOException

Throws:

SshException

ShellTimeoutException

IOException

sudo

public ShellProcess sudo(String cmd,
 String password,
 String promptExpression,
 ShellMatcher matcher)
                  throws SshException,
ShellTimeoutException,
IOException

Throws:

SshException

ShellTimeoutException

IOException

isClosed

public boolean isClosed()

exit

public void exit()
          throws IOException,
SshException

Throws:

IOException

SshException

close

public void close()
           throws IOException,
SshException

Throws:

IOException

SshException

getNewline

public String getNewline()

executeWithOutput

public String executeWithOutput(String cmd)
                         throws SshException

Throws:

SshException

executeWithExitCode

public int executeWithExitCode(String cmd)
                        throws SshException

Throws:

SshException

execute

public void execute(String cmd)
             throws SshException

Throws:

SshException

executeCommand

public ShellProcess executeCommand(String origCmd)
                            throws SshException

Throws:

SshException

executeCommand

public ShellProcess executeCommand(String origCmd,
 boolean consume)
                            throws SshException

Throws:

SshException

executeCommand

public ShellProcess executeCommand(String origCmd,
 String charset)
                            throws SshException

Throws:

SshException

executeCommand

public ShellProcess executeCommand(String origCmd,
 boolean consume,
 String charset)
                            throws SshException

Throws:

SshException

executeCommand

public ShellProcess executeCommand(String origCmd,
 boolean matchPromptMarker,
 boolean consume)
                            throws SshException

Throws:

SshException

executeCommand

public ShellProcess executeCommand(String origCmd,
 boolean matchPromptMarker,
 boolean consume,
 String charsetName)
                            throws SshException

Throws:

SshException

getNumCommandsExecuted

public int getNumCommandsExecuted()

getOsType

public int getOsType()

getOsDescription

public String getOsDescription()

setSudoPassword

public void setSudoPassword(Optional<String> sudoPassword)