Package com.tailf.ned

Class SSHJSession

Object

com.tailf.ned.SSHJSession

All Implemented Interfaces:

CliSession, SSHClient.CliSession

public class SSHJSession
extends Object
implements SSHClient.CliSession

Class implementing the SSHClient.CliSession interface using the net.schmizz.sshj framework.

Author:

jrendel

Field Summary

Fields inherited from interface com.tailf.ned.SSHClient.CliSession

MODE_OCRNL, MODE_ONLRET, MODE_ONOCR

Method Summary

Modifier and Type	Method	Description
void	close()	Close the SSH session
InputStream	getErrorStream()
InputStream	getInputStream()
StringBuilder	getLine()	Return the line buffer
OutputStream	getOutputStream()
BufferedReader	getReader()	Return the session input reader
int	getReadTimeout()	Return the configured read timeout
String	getTermPrintlnMode()	Get configured println mode
PrintWriter	getWriter()	Return the session output writer
void	logDebug(String msg)	Log on debug level
void	logInfo(String msg)	Log on info level
boolean	ready(int timeout)	Checks if the input reader is ready for reading.
boolean	serverSideClosed()	Returns true if session has been closed
void	setReadTimeout(int readTimeout)	Configure the readTimeout
void	setTermPrintlnMode(String mode)	Configure println mode
void	setTracer(NedTracer tracer)	Enable tracer
void	trace(String msg, String direction)	Append to tracer
void	traceInBufAppend(String msg)	Append to trace in buf
void	traceInBufFlush()	Flush trace in buffer

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tailf.ned.SSHClient.CliSession

expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, expect, flush, print, print, println, println, ready

Method Details

ready

public boolean ready(int timeout)
              throws IOException

Checks if the input reader is ready for reading. Done with a blocking read in a separate thread. Called through a Java Future to ensure timeout exception.

Specified by:

ready in interface SSHClient.CliSession

Parameters:

timeout - timeout

Returns:

true if the input reader is ready, false otherwise

Throws:

IOException - if an I/O error occurs

serverSideClosed

public boolean serverSideClosed()

Returns true if session has been closed

Specified by:

serverSideClosed in interface CliSession

close

public void close()

Close the SSH session

Specified by:

close in interface CliSession

getReadTimeout

public int getReadTimeout()

Return the configured read timeout

Specified by:

getReadTimeout in interface SSHClient.CliSession

setReadTimeout

public void setReadTimeout(int readTimeout)

Configure the readTimeout

Specified by:

setReadTimeout in interface SSHClient.CliSession

getReader

public BufferedReader getReader()

Return the session input reader

Specified by:

getReader in interface SSHClient.CliSession

getWriter

public PrintWriter getWriter()

Return the session output writer

Specified by:

getWriter in interface SSHClient.CliSession

getLine

public StringBuilder getLine()

Return the line buffer

Specified by:

getLine in interface SSHClient.CliSession

setTracer

public void setTracer(NedTracer tracer)

Enable tracer

Specified by:

setTracer in interface CliSession

trace

public void trace(String msg,
 String direction)

Append to tracer

Specified by:

trace in interface SSHClient.CliSession

traceInBufAppend

public void traceInBufAppend(String msg)

Append to trace in buf

Specified by:

traceInBufAppend in interface SSHClient.CliSession

traceInBufFlush

public void traceInBufFlush()

Flush trace in buffer

Specified by:

traceInBufFlush in interface SSHClient.CliSession

logInfo

public void logInfo(String msg)

Log on info level

Specified by:

logInfo in interface SSHClient.CliSession

logDebug

public void logDebug(String msg)

Log on debug level

Specified by:

logDebug in interface SSHClient.CliSession

getTermPrintlnMode

public String getTermPrintlnMode()

Get configured println mode

Specified by:

getTermPrintlnMode in interface SSHClient.CliSession

setTermPrintlnMode

public void setTermPrintlnMode(String mode)

Configure println mode

Specified by:

setTermPrintlnMode in interface SSHClient.CliSession

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface SSHClient.CliSession

getErrorStream

public InputStream getErrorStream()

Specified by:

getErrorStream in interface SSHClient.CliSession

getOutputStream

public OutputStream getOutputStream()

Specified by:

getOutputStream in interface SSHClient.CliSession