Package com.tailf.ned

Interface SSHClient.CliSession

All Superinterfaces:

CliSession

All Known Implementing Classes:

SSHJSession

Enclosing interface:

SSHClient

public static interface SSHClient.CliSession
extends CliSession

The SSH CLI session interface. Inherited from the old SSHSession implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODE_OCRNL	Newline modes supported by the CLI session
static final String	MODE_ONLRET
static final String	MODE_ONOCR

Method Summary

Modifier and Type	Method	Description
default String	expect(String str)
default NedExpectResult	expect(String[] str)
default NedExpectResult	expect(String[] str, boolean include, int timeout)
default NedExpectResult	expect(String[] str, boolean include, int timeout, NedWorker worker)
default NedExpectResult	expect(String[] str, NedWorker worker)
default String	expect(String str, boolean include, boolean full, int timeout)
default String	expect(String str, boolean include, boolean full, int timeout, NedWorker worker)
default String	expect(String str, boolean include, int timeout)
default String	expect(String str, boolean include, int timeout, NedWorker worker)
default String	expect(String str, int timeout)
default String	expect(String str, int timeout, NedWorker worker)
default String	expect(String str, NedWorker worker)
default String	expect(Pattern p)
default NedExpectResult	expect(Pattern[] p)
default NedExpectResult	expect(Pattern[] p, boolean include, int timeout)
default NedExpectResult	expect(Pattern[] p, boolean include, int timeout, boolean full)
default NedExpectResult	expect(Pattern[] p, boolean include, int timeout, boolean full, NedWorker worker)
default NedExpectResult	expect(Pattern[] p, boolean include, int timeout, NedWorker worker)
default NedExpectResult	expect(Pattern[] p, NedWorker worker)
default String	expect(Pattern p, boolean include, int timeout)
default String	expect(Pattern p, boolean include, int timeout, NedWorker worker)
default String	expect(Pattern p, NedWorker worker)
default void	flush()	Signals that the final chunk of data has to be printed to the output transport stream.
InputStream	getErrorStream()
InputStream	getInputStream()
StringBuilder	getLine()
OutputStream	getOutputStream()
BufferedReader	getReader()
int	getReadTimeout()	Interface methods that must be implemented
String	getTermPrintlnMode()
PrintWriter	getWriter()
void	logDebug(String msg)
void	logInfo(String msg)
default void	print(int iVal)	Prints an integer (as text) to the output stream.
default void	print(String s)	Prints text to the output stream.
default void	println(int iVal)	Prints an integer (as text) to the output stream.
default void	println(String s)	Print text to the output stream.
default boolean	ready()	Interface methods with default implementation
boolean	ready(int timeout)
void	setReadTimeout(int readTimeout)
void	setTermPrintlnMode(String mode)
void	trace(String msg, String direction)
void	traceInBufAppend(String msg)
void	traceInBufFlush()

Methods inherited from interface com.tailf.ned.CliSession

close, serverSideClosed, setTracer

Field Details

MODE_OCRNL

static final String MODE_OCRNL

Newline modes supported by the CLI session

See Also:

• Constant Field Values

MODE_ONOCR

static final String MODE_ONOCR

See Also:

• Constant Field Values

MODE_ONLRET

static final String MODE_ONLRET

See Also:

• Constant Field Values

Method Details

getReadTimeout

int getReadTimeout()

Interface methods that must be implemented

setReadTimeout

void setReadTimeout(int readTimeout)

getReader

BufferedReader getReader()

getWriter

PrintWriter getWriter()

getLine

StringBuilder getLine()

trace

void trace(String msg,
 String direction)

traceInBufAppend

void traceInBufAppend(String msg)

traceInBufFlush

void traceInBufFlush()

logInfo

void logInfo(String msg)

logDebug

void logDebug(String msg)

getTermPrintlnMode

String getTermPrintlnMode()

setTermPrintlnMode

void setTermPrintlnMode(String mode)

ready

boolean ready(int timeout)
       throws IOException

Throws:

IOException

getInputStream

InputStream getInputStream()

getErrorStream

InputStream getErrorStream()

getOutputStream

OutputStream getOutputStream()

ready

default boolean ready()
               throws IOException

Interface methods with default implementation

Throws:

IOException

expect

default String expect(String str)
               throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default String expect(Pattern p)
               throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default String expect(String str,
 NedWorker worker)
               throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default String expect(Pattern p,
 NedWorker worker)
               throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default String expect(String str,
 int timeout)
               throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default String expect(String str,
 int timeout,
 NedWorker worker)
               throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default String expect(String str,
 boolean include,
 int timeout)
               throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default String expect(Pattern p,
 boolean include,
 int timeout)
               throws SSHSessionException,
IOException

Throws:

SSHSessionException

IOException

expect

default NedExpectResult expect(String[] str)
                        throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default NedExpectResult expect(Pattern[] p)
                        throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default NedExpectResult expect(String[] str,
 boolean include,
 int timeout)
                        throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default NedExpectResult expect(Pattern[] p,
 boolean include,
 int timeout)
                        throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default String expect(String str,
 boolean include,
 int timeout,
 NedWorker worker)
               throws SSHSessionException,
IOException

Throws:

SSHSessionException

IOException

expect

default String expect(Pattern p,
 boolean include,
 int timeout,
 NedWorker worker)
               throws SSHSessionException,
IOException

Throws:

SSHSessionException

IOException

expect

default NedExpectResult expect(String[] str,
 NedWorker worker)
                        throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default NedExpectResult expect(Pattern[] p,
 NedWorker worker)
                        throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default NedExpectResult expect(String[] str,
 boolean include,
 int timeout,
 NedWorker worker)
                        throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default NedExpectResult expect(Pattern[] p,
 boolean include,
 int timeout,
 NedWorker worker)
                        throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

expect

default NedExpectResult expect(Pattern[] p,
 boolean include,
 int timeout,
 boolean full)
                        throws SSHSessionException,
IOException

Throws:

SSHSessionException

IOException

expect

default NedExpectResult expect(Pattern[] p,
 boolean include,
 int timeout,
 boolean full,
 NedWorker worker)
                        throws SSHSessionException,
IOException

Throws:

SSHSessionException

IOException

expect

default String expect(String str,
 boolean include,
 boolean full,
 int timeout)
               throws IOException,
SSHSessionException

Specified by:

expect in interface CliSession

Throws:

IOException

SSHSessionException

expect

default String expect(String str,
 boolean include,
 boolean full,
 int timeout,
 NedWorker worker)
               throws SSHSessionException,
IOException

Specified by:

expect in interface CliSession

Throws:

SSHSessionException

IOException

print

default void print(int iVal)

Prints an integer (as text) to the output stream.

Parameters:

iVal - Text to send to the stream.

print

default void print(String s)

Prints text to the output stream.

Specified by:

print in interface CliSession

Parameters:

s - Text to send to the stream.

println

default void println(int iVal)

Prints an integer (as text) to the output stream. A newline char is appended to end of the output stream.

Parameters:

iVal - Text to send to the stream.

println

default void println(String s)

Print text to the output stream. A newline char is appended to end of the output stream.

Specified by:

println in interface CliSession

Parameters:

s - Text to send to the stream.

flush

default void flush()

Signals that the final chunk of data has to be printed to the output transport stream. This method furthermore flushes the transport output stream buffer.

Specified by:

flush in interface CliSession