com.sshtools.client.shell

Class ShellController

java.lang.Object

com.sshtools.client.shell.ShellController

All Implemented Interfaces:

ShellReader, ShellWriter

Direct Known Subclasses:

ShellProcessController

public class ShellController
extends java.lang.Object
implements ShellReader, ShellWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.InputStream	in
protected ShellMatcher	matcher
protected int	readlimit
protected ExpectShell	shell

Method Summary

Modifier and Type	Method and Description
void	carriageReturn() Send a carriage return to the remote command.
boolean	expect(java.lang.String pattern) Consume the output of the command until the pattern matches.
boolean	expect(java.lang.String pattern, boolean consumeRemainingLine) Consume the output of the command until the pattern matches.
boolean	expect(java.lang.String pattern, boolean consumeRemainingLine, long timeout) Consume the output of the command until the pattern matches.
boolean	expect(java.lang.String pattern, boolean consumeRemainingLine, long timeout, long maxLines) Consume the output of the command until the pattern matches.
boolean	expect(java.lang.String pattern, long timeout) Consume the output of the command until the pattern matches.
boolean	expectNextLine(java.lang.String pattern) Perform expect on the next line of output only
boolean	expectNextLine(java.lang.String pattern, boolean consumeRemainingLine) Perform expect on the next line of output only
boolean	expectNextLine(java.lang.String pattern, boolean consumeRemainingLine, long timeout) Perform expect on the next line of output only
int	getReadlimit()
void	interrupt() Interrupt the process by sending a Ctrl+C to the process.
boolean	isActive()
java.lang.String	readLine() Read a line of output from the process.
java.lang.String	readLine(long timeout) Read a line of output from the process.
void	setMatcher(ShellMatcher matcher)
void	setReadlimit(int readlimit)
void	type(java.lang.String string) Send data to the remote command just like the user had typed it.
void	typeAndReturn(java.lang.String string) Send data to the remote command and finish with a carriage return.

Methods inherited from class java.lang.Object

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

Field Detail

shell

protected ExpectShell shell

matcher

protected ShellMatcher matcher

readlimit

protected int readlimit

in

protected java.io.InputStream in

Method Detail

setMatcher

public void setMatcher(ShellMatcher matcher)

interrupt

public void interrupt()
               throws java.io.IOException

Description copied from interface: ShellWriter

Interrupt the process by sending a Ctrl+C to the process.

Specified by:

interrupt in interface ShellWriter

Throws:

java.io.IOException

type

public void type(java.lang.String string)
          throws java.io.IOException

Description copied from interface: ShellWriter

Send data to the remote command just like the user had typed it.

Specified by:

type in interface ShellWriter

Parameters:

string - the typed key data

Throws:

java.io.IOException

carriageReturn

public void carriageReturn()
                    throws java.io.IOException

Description copied from interface: ShellWriter

Send a carriage return to the remote command.

Specified by:

carriageReturn in interface ShellWriter

Throws:

java.io.IOException

typeAndReturn

public void typeAndReturn(java.lang.String string)
                   throws java.io.IOException

Description copied from interface: ShellWriter

Send data to the remote command and finish with a carriage return.

Specified by:

typeAndReturn in interface ShellWriter

Parameters:

string - String

Throws:

java.io.IOException

expect

public boolean expect(java.lang.String pattern)
               throws ShellTimeoutException,
                      SshException

Consume the output of the command until the pattern matches. This version of expect will return with the output at the end of the matched pattern.

Parameters:

pattern -

Returns:

Throws:

ShellTimeoutException

SshException

expect

public boolean expect(java.lang.String pattern,
                      boolean consumeRemainingLine)
               throws ShellTimeoutException,
                      SshException

Consume the output of the command until the pattern matches. Use the consumeRemainingLine variable to indicate if output should start at the end of the matched pattern (consumeRemainingLine=false) or at the begninng of the next line (consumeRemainingLine=true)

Parameters:

pattern -

consumeRemainingLine -

Returns:

Throws:

ShellTimeoutException

SshException

expect

public boolean expect(java.lang.String pattern,
                      long timeout)
               throws ShellTimeoutException,
                      SshException

Consume the output of the command until the pattern matches. Use the consumeRemainingLine variable to indicate if output should start at the end of the matched pattern (consumeRemainingLine=false) or at the begninng of the next line (consumeRemainingLine=true)

Parameters:

pattern -

timeout -

Returns:

Throws:

ShellTimeoutException

SshException

expect

public boolean expect(java.lang.String pattern,
                      boolean consumeRemainingLine,
                      long timeout)
               throws ShellTimeoutException,
                      SshException

Consume the output of the command until the pattern matches. This version of expect will not consume the whole line and will return with the output at the end of the matched pattern.

Parameters:

pattern -

consumeRemainingLine -

timeout -

maxLines -

Returns:

Throws:

ShellTimeoutException

SshException

expectNextLine

public boolean expectNextLine(java.lang.String pattern)
                       throws ShellTimeoutException,
                              SshException

Perform expect on the next line of output only

Parameters:

pattern -

Returns:

Throws:

ShellTimeoutException

SshException

expectNextLine

public boolean expectNextLine(java.lang.String pattern,
                              boolean consumeRemainingLine)
                       throws ShellTimeoutException,
                              SshException

Perform expect on the next line of output only

Parameters:

pattern -

consumeRemainingLine -

Returns:

Throws:

ShellTimeoutException

SshException

expectNextLine

public boolean expectNextLine(java.lang.String pattern,
                              boolean consumeRemainingLine,
                              long timeout)
                       throws ShellTimeoutException,
                              SshException

Perform expect on the next line of output only

Parameters:

pattern -

consumeRemainingLine -

timeout -

Returns:

Throws:

ShellTimeoutException

SshException

expect

public boolean expect(java.lang.String pattern,
                      boolean consumeRemainingLine,
                      long timeout,
                      long maxLines)
               throws ShellTimeoutException,
                      SshException

Consume the output of the command until the pattern matches. This version of expect will not consume the whole line and will return with the output at the end of the matched pattern.

Parameters:

pattern -

consumeRemainingLine -

timeout -

maxLines -

Returns:

Throws:

ShellTimeoutException

SshException

isActive

public boolean isActive()

readLine

public java.lang.String readLine()
                          throws SshException,
                                 ShellTimeoutException

Description copied from interface: ShellReader

Read a line of output from the process.

Specified by:

readLine in interface ShellReader

Returns:

Throws:

SshException

ShellTimeoutException

readLine

public java.lang.String readLine(long timeout)
                          throws SshException,
                                 ShellTimeoutException

Description copied from interface: ShellReader

Read a line of output from the process.

Specified by:

readLine in interface ShellReader

Returns:

Throws:

SshException

ShellTimeoutException

getReadlimit

public int getReadlimit()

setReadlimit

public void setReadlimit(int readlimit)