Package com.sshtools.client.shell

Class ExpectShell

java.lang.Object

com.sshtools.client.shell.ExpectShell

public class ExpectShell
extends Object

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	AIX operating system
static final int	OS_DARWIN	Darwin (MAC) operating system
static final int	OS_FREEBSD	FreeBSD operating system
static final int	OS_HPUX	HP-UX operating system
static final int	OS_LINUX	Linux operating system
static final int	OS_NETBSD	NetBSD operating system
static final int	OS_OPENBSD	OpenBSD operating system
static final int	OS_OPENVMS	OpenVMS operating system
static final int	OS_POWERSHELL	Linux operating system
static final int	OS_SOLARIS	Solaris operating system
static final int	OS_UNIX	Unix OS if less than this value.
static final int	OS_UNKNOWN	The operating system is unknown
static final int	OS_WINDOWS	Windows operating system

Constructor Summary

Constructors

Constructor	Description
ExpectShell(SessionChannelNG session, int osType)
ExpectShell(SessionChannelNG session, ShellStartupTrigger trigger, long startupTimeout, String termtype, int cols, int rows, int osType)
ExpectShell(AbstractSessionTask<SessionChannelNG> session)
ExpectShell(AbstractSessionTask<SessionChannelNG> session, int osType)
ExpectShell(AbstractSessionTask<SessionChannelNG> session, ShellStartupTrigger trigger)
ExpectShell(AbstractSessionTask<SessionChannelNG> session, ShellStartupTrigger trigger, long startupTimeout)
ExpectShell(AbstractSessionTask<SessionChannelNG> session, ShellStartupTrigger trigger, long startupTimeout, String termtype)	Deprecated.
ExpectShell(AbstractSessionTask<SessionChannelNG> session, ShellStartupTrigger trigger, long startupTimeout, String termtype, int cols, int rows)	Deprecated.
ExpectShell(AbstractSessionTask<SessionChannelNG> session, ShellStartupTrigger trigger, long startupTimeout, String termtype, int cols, int rows, int osType)	Deprecated.
ExpectShell(InputStream in, OutputStream out, ExpectShell parentShell)
ExpectShell(InputStream in, OutputStream out, ExpectShell parentShell, int osType)

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 charset)
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()
String	getNewline()
int	getNumCommandsExecuted()
String	getOsDescription()
int	getOsType()
InputStream	getStartupInputStream()
ShellReader	getStartupReader()
boolean	inStartup()
boolean	isClosed()
void	setCharacterEncoding(String characterEncoding)
void	setPasswordErrorText(String passwordErrorText)
void	setPasswordPrompt(String passwordPrompt)
static void	setShellInitTimeout(int timeout)
ExpectShell	su(String cmd)
ExpectShell	su(String cmd, String password)
ExpectShell	su(String cmd, String password, String promptExpression)
ExpectShell	su(String cmd, String password, String promptExpression, ShellMatcher matcher)
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

public static final int OS_WINDOWS

Windows operating system

See Also:

• Constant Field Values

OS_LINUX

public static final int OS_LINUX

Linux operating system

See Also:

• Constant Field Values

OS_SOLARIS

public static final int OS_SOLARIS

Solaris operating system

See Also:

• Constant Field Values

OS_AIX

public static final int OS_AIX

AIX operating system

See Also:

• Constant Field Values

OS_DARWIN

public static final int OS_DARWIN

Darwin (MAC) operating system

See Also:

• Constant Field Values

OS_FREEBSD

public static final int OS_FREEBSD

FreeBSD operating system

See Also:

• Constant Field Values

OS_OPENBSD

public static final int OS_OPENBSD

OpenBSD operating system

See Also:

• Constant Field Values

OS_NETBSD

public static final int OS_NETBSD

NetBSD operating system

See Also:

• Constant Field Values

OS_HPUX

public static final int OS_HPUX

HP-UX operating system

See Also:

• Constant Field Values

OS_UNIX

public static final int OS_UNIX

Unix OS if less than this value.

See Also:

• Constant Field Values

OS_OPENVMS

public static final int OS_OPENVMS

OpenVMS operating system

See Also:

• Constant Field Values

OS_POWERSHELL

public static final int OS_POWERSHELL

Linux operating system

See Also:

• Constant Field Values

OS_UNKNOWN

public static final int OS_UNKNOWN

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

public ExpectShell(AbstractSessionTask<SessionChannelNG> session)
            throws SshException,
IOException,
ShellTimeoutException

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

public ExpectShell(AbstractSessionTask<SessionChannelNG> session,
 int osType)
            throws SshException,
IOException,
ShellTimeoutException

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

public ExpectShell(AbstractSessionTask<SessionChannelNG> session,
 ShellStartupTrigger trigger)
            throws SshException,
IOException,
ShellTimeoutException

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

public ExpectShell(AbstractSessionTask<SessionChannelNG> session,
 ShellStartupTrigger trigger,
 long startupTimeout)
            throws SshException,
IOException,
ShellTimeoutException

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated
public ExpectShell(AbstractSessionTask<SessionChannelNG> session,
 ShellStartupTrigger trigger,
 long startupTimeout,
 String termtype)
            throws SshException,
IOException,
ShellTimeoutException

Deprecated.

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated
public ExpectShell(AbstractSessionTask<SessionChannelNG> session,
 ShellStartupTrigger trigger,
 long startupTimeout,
 String termtype,
 int cols,
 int rows)
            throws SshException,
IOException,
ShellTimeoutException

Deprecated.

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

@Deprecated
public ExpectShell(AbstractSessionTask<SessionChannelNG> session,
 ShellStartupTrigger trigger,
 long startupTimeout,
 String termtype,
 int cols,
 int rows,
 int osType)
            throws SshException,
IOException,
ShellTimeoutException

Deprecated.

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

public ExpectShell(SessionChannelNG session,
 int osType)
            throws SshException,
IOException,
ShellTimeoutException

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

public ExpectShell(SessionChannelNG session,
 ShellStartupTrigger trigger,
 long startupTimeout,
 String termtype,
 int cols,
 int rows,
 int osType)
            throws SshException,
IOException,
ShellTimeoutException

Throws:

SshException

IOException

ShellTimeoutException

ExpectShell

public ExpectShell(InputStream in,
 OutputStream out,
 ExpectShell parentShell)
            throws SshIOException,
SshException,
IOException,
ShellTimeoutException

Throws:

SshIOException

SshException

IOException

ShellTimeoutException

ExpectShell

public ExpectShell(InputStream in,
 OutputStream out,
 ExpectShell parentShell,
 int osType)
            throws SshIOException,
SshException,
IOException,
ShellTimeoutException

Throws:

SshIOException

SshException

IOException

ShellTimeoutException

Method Details

getCharacterEncoding

public String getCharacterEncoding()

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)

setShellInitTimeout

public static void setShellInitTimeout(int timeout)

getStartupInputStream

public InputStream getStartupInputStream()

inStartup

public boolean inStartup()

setPasswordErrorText

public void setPasswordErrorText(String passwordErrorText)

setPasswordPrompt

public void setPasswordPrompt(String passwordPrompt)

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 promptExpression)
               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 promptExpression,
 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,
 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 charset)
                            throws SshException

Throws:

SshException

getNumCommandsExecuted

public int getNumCommandsExecuted()

getOsType

public int getOsType()

getOsDescription

public String getOsDescription()