Package com.identity4j.util.expect

Class Expect

java.lang.Object

com.identity4j.util.expect.Expect

public class Expect
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected BufferedInputStream	in
protected List<ExpectMatcher>	matchers

Constructor Summary

Constructors

Constructor	Description
Expect()
Expect(ExpectMatcher matcher)
Expect(ExpectMatcher matcher, InputStream in, OutputStream out)
Expect(ExpectMatcher matcher, InputStream in, OutputStream out, String eol)
Expect(InputStream in, OutputStream out)

Method Summary

Modifier and Type	Method	Description
void	carriageReturn()	Send a carriage return to the remote shell.
String	chat(String pattern, boolean consumeRemainingLine, long timeout, long maxLines, boolean ignoreEmptyLines)	Consume the output of the command until the pattern matches.
boolean	expect(String pattern)	Consume the output of the command until the pattern matches.
boolean	expect(String pattern, boolean consumeRemainingLine)	Consume the output of the command until the pattern matches.
boolean	expect(String pattern, boolean consumeRemainingLine, long timeout)	Consume the output of the command until the pattern matches.
boolean	expect(String pattern, boolean consumeRemainingLine, long timeout, long maxLines)	Consume the output of the command until the pattern matches.
boolean	expect(String pattern, long timeout)	Consume the output of the command until the pattern matches.
boolean	expectNextLine(String pattern)	Perform expect on the next line of output only
boolean	expectNextLine(String pattern, boolean consumeRemainingLine)	Perform expect on the next line of output only
boolean	expectNextLine(String pattern, boolean consumeRemainingLine, long timeout)	Perform expect on the next line of output only
String	getEol()
InputStream	getIn()
OutputStream	getOut()
void	interrupt()
protected boolean	isOpen()
static void	main(String[] args)
protected boolean	matches(String line, String pattern)
boolean	maybeExpect(String pattern)
boolean	maybeExpect(String pattern, boolean consumeRemainingLine)
boolean	maybeExpect(String pattern, boolean consumeRemainingLine, long timeout)
boolean	maybeExpect(String pattern, boolean consumeRemainingLine, long timeout, long maxLines)
boolean	maybeExpect(String pattern, long timeout)
boolean	maybeExpectNextLine(String pattern)
boolean	maybeExpectNextLine(String pattern, boolean consumeRemainingLine)
boolean	maybeExpectNextLine(String pattern, boolean consumeRemainingLine, long timeout)
protected int	read(long timeout)
String	readLine()
String	readLine(long timeout)
void	setEol(String eol)
void	setIn(InputStream in)
void	setOut(OutputStream out)
void	type(int b)	Write a byte of data as input on the remote shell.
void	type(String string)	Type some characters as input on the remote shell.
void	typeAndReturn(String string)	Type some characters followed by a carriage return on the remote shell.
void	write(byte[] bytes)	Write some data as input on the remote shell.

Methods inherited from class java.lang.Object

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

Field Detail

matchers

protected List<ExpectMatcher> matchers

in

protected BufferedInputStream in

Constructor Detail

Expect

public Expect()

Expect

public Expect(ExpectMatcher matcher)

Expect

public Expect(InputStream in,
              OutputStream out)

Expect

public Expect(ExpectMatcher matcher,
              InputStream in,
              OutputStream out)

Expect

public Expect(ExpectMatcher matcher,
              InputStream in,
              OutputStream out,
              String eol)

Method Detail

isOpen

protected boolean isOpen()

interrupt

public void interrupt()
               throws IOException

Throws:

IOException

type

public void type(String string)
          throws IOException

Type some characters as input on the remote shell.

Parameters:

string - String

Throws:

IOException

expect

public boolean expect(String pattern)
               throws ExpectTimeoutException,
                      IOException

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

ExpectTimeoutException

IOException

expect

public boolean expect(String pattern,
                      boolean consumeRemainingLine)
               throws ExpectTimeoutException,
                      IOException

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

ExpectTimeoutException

IOException

expect

public boolean expect(String pattern,
                      long timeout)
               throws ExpectTimeoutException,
                      IOException

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

ExpectTimeoutException

IOException

expect

public boolean expect(String pattern,
                      boolean consumeRemainingLine,
                      long timeout)
               throws ExpectTimeoutException,
                      IOException

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

ExpectTimeoutException

IOException

expectNextLine

public boolean expectNextLine(String pattern)
                       throws ExpectTimeoutException,
                              IOException

Perform expect on the next line of output only

Parameters:

pattern -

Returns:

Throws:

ShellTimeoutException

SshException

ExpectTimeoutException

IOException

expectNextLine

public boolean expectNextLine(String pattern,
                              boolean consumeRemainingLine)
                       throws ExpectTimeoutException,
                              IOException

Perform expect on the next line of output only

Parameters:

pattern -

consumeRemainingLine -

Returns:

Throws:

ShellTimeoutException

SshException

ExpectTimeoutException

IOException

expectNextLine

public boolean expectNextLine(String pattern,
                              boolean consumeRemainingLine,
                              long timeout)
                       throws ExpectTimeoutException,
                              IOException

Perform expect on the next line of output only

Parameters:

pattern -

consumeRemainingLine -

timeout -

Returns:

Throws:

ExpectTimeoutException

SshException

IOException

expect

public boolean expect(String pattern,
                      boolean consumeRemainingLine,
                      long timeout,
                      long maxLines)
               throws ExpectTimeoutException,
                      IOException

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:

ExpectTimeoutException

IOException

maybeExpectNextLine

public boolean maybeExpectNextLine(String pattern,
                                   boolean consumeRemainingLine,
                                   long timeout)
                            throws ExpectTimeoutException,
                                   IOException

Throws:

ExpectTimeoutException

IOException

maybeExpectNextLine

public boolean maybeExpectNextLine(String pattern,
                                   boolean consumeRemainingLine)
                            throws ExpectTimeoutException,
                                   IOException

Throws:

ExpectTimeoutException

IOException

maybeExpectNextLine

public boolean maybeExpectNextLine(String pattern)
                            throws ExpectTimeoutException,
                                   IOException

Throws:

ExpectTimeoutException

IOException

maybeExpect

public boolean maybeExpect(String pattern,
                           boolean consumeRemainingLine,
                           long timeout)
                    throws ExpectTimeoutException,
                           IOException

Throws:

ExpectTimeoutException

IOException

maybeExpect

public boolean maybeExpect(String pattern,
                           long timeout)
                    throws ExpectTimeoutException,
                           IOException

Throws:

ExpectTimeoutException

IOException

maybeExpect

public boolean maybeExpect(String pattern,
                           boolean consumeRemainingLine)
                    throws ExpectTimeoutException,
                           IOException

Throws:

ExpectTimeoutException

IOException

maybeExpect

public boolean maybeExpect(String pattern)
                    throws ExpectTimeoutException,
                           IOException

Throws:

ExpectTimeoutException

IOException

maybeExpect

public boolean maybeExpect(String pattern,
                           boolean consumeRemainingLine,
                           long timeout,
                           long maxLines)
                    throws ExpectTimeoutException,
                           IOException

Throws:

ExpectTimeoutException

IOException

chat

public String chat(String pattern,
                   boolean consumeRemainingLine,
                   long timeout,
                   long maxLines,
                   boolean ignoreEmptyLines)
            throws ExpectTimeoutException,
                   IOException

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 -

ignoreEmptyLines - blank lines are not counted

Returns:

Throws:

ExpectTimeoutException

IOException

matches

protected boolean matches(String line,
                          String pattern)

read

protected int read(long timeout)
            throws IOException,
                   ExpectTimeoutException

Throws:

IOException

ExpectTimeoutException

readLine

public String readLine()
                throws IOException,
                       ExpectTimeoutException

Throws:

IOException

ExpectTimeoutException

readLine

public String readLine(long timeout)
                throws IOException,
                       ExpectTimeoutException

Throws:

IOException

ExpectTimeoutException

main

public static void main(String[] args)

getIn

public final InputStream getIn()

setIn

public final void setIn(InputStream in)

getOut

public final OutputStream getOut()

setOut

public final void setOut(OutputStream out)

getEol

public final String getEol()

setEol

public final void setEol(String eol)

typeAndReturn

public void typeAndReturn(String string)
                   throws IOException

Type some characters followed by a carriage return on the remote shell.

Parameters:

string - String

Throws:

IOException

write

public void write(byte[] bytes)
           throws IOException

Write some data as input on the remote shell.

Parameters:

bytes -

Throws:

IOException

type

public void type(int b)
          throws IOException

Write a byte of data as input on the remote shell.

Parameters:

b -

Throws:

IOException

carriageReturn

public void carriageReturn()
                    throws IOException

Send a carriage return to the remote shell.

Throws:

IOException