net.sf.sshapi.impl.libssh

Class LibsshShell

java.lang.Object

net.sf.sshapi.AbstractLifecycleComponent

net.sf.sshapi.AbstractLifecycleComponentWithEvents

net.sf.sshapi.impl.libssh.LibsshShell

All Implemented Interfaces:

SshDataProducingComponent, SshExtendedStreamChannel, SshLifecycleComponent, SshShell, SshStreamChannel

public class LibsshShell
extends AbstractLifecycleComponentWithEvents
implements SshShell

Constructor Summary

Constructors

Constructor and Description
LibsshShell(SshLibrary.ssh_session libSshSession, SshLibrary library, java.lang.String termType, int cols, int rows, boolean useExtendedStream)

Method Summary

Modifier and Type	Method and Description
void	addDataListener(SshDataListener listener) Add a listener to those informed when a component produces data.
int	exitCode() Get the exit code of this command or shell (when known).
java.io.InputStream	getExtendedInputStream() Get the extended input stream.
java.io.InputStream	getInputStream() Get the input stream for this channel.
java.io.OutputStream	getOutputStream() Get the output stream for this channel.
void	onClose()
void	onOpen()
void	removeDataListener(SshDataListener listener) Remove a listener from those informed when a component produces data.
void	requestPseudoTerminalChange(int width, int height, int pixw, int pixh) Request that the pseudo terminal attributes are changed.

Methods inherited from class net.sf.sshapi.AbstractLifecycleComponentWithEvents

checkOpen, close, isOpen, open

Methods inherited from class net.sf.sshapi.AbstractLifecycleComponent

addListener, fireClosed, fireClosing, fireOpened, getListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.sshapi.SshLifecycleComponent

addListener, close, isOpen, open, removeListener

Constructor Detail

LibsshShell

public LibsshShell(SshLibrary.ssh_session libSshSession,
                   SshLibrary library,
                   java.lang.String termType,
                   int cols,
                   int rows,
                   boolean useExtendedStream)

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Description copied from interface: SshStreamChannel

Get the input stream for this channel.

Specified by:

getInputStream in interface SshStreamChannel

Returns:

input stream

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Description copied from interface: SshStreamChannel

Get the output stream for this channel.

Specified by:

getOutputStream in interface SshStreamChannel

Returns:

output stream

Throws:

java.io.IOException

addDataListener

public void addDataListener(SshDataListener listener)

Description copied from interface: SshDataProducingComponent

Add a listener to those informed when a component produces data.

Specified by:

addDataListener in interface SshDataProducingComponent

Parameters:

listener - listener

removeDataListener

public void removeDataListener(SshDataListener listener)

Description copied from interface: SshDataProducingComponent

Remove a listener from those informed when a component produces data.

Specified by:

removeDataListener in interface SshDataProducingComponent

Parameters:

listener - listener

onOpen

public void onOpen()
            throws SshException

Specified by:

onOpen in class AbstractLifecycleComponentWithEvents

Throws:

SshException

onClose

public void onClose()
             throws SshException

Specified by:

onClose in class AbstractLifecycleComponentWithEvents

Throws:

SshException

getExtendedInputStream

public java.io.InputStream getExtendedInputStream()
                                           throws java.io.IOException

Description copied from interface: SshExtendedStreamChannel

Get the extended input stream.

Specified by:

getExtendedInputStream in interface SshExtendedStreamChannel

Returns:

extended input stream

Throws:

java.io.IOException

requestPseudoTerminalChange

public void requestPseudoTerminalChange(int width,
                                        int height,
                                        int pixw,
                                        int pixh)
                                 throws SshException

Description copied from interface: SshShell

Request that the pseudo terminal attributes are changed.

Specified by:

requestPseudoTerminalChange in interface SshShell

Parameters:

width - new terminal width

height - new terminal height

pixw - new pixel width

pixh - new pixel height

Throws:

SshException

exitCode

public int exitCode()
             throws java.io.IOException

Description copied from interface: SshExtendedStreamChannel

Get the exit code of this command or shell (when known).

Specified by:

exitCode in interface SshExtendedStreamChannel

Returns:

exist code

Throws:

java.io.IOException