|
RSE Release 3.0 |
|||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
IBaseShell | A basic shell, representing the connection to some process that may be running local or remote. |
ITerminalService | Interface for getting Terminal Connections from a remote side, also known as terminal session with Streams. |
ITerminalShell | Interface representing a terminal connection through Streams. |
Class Summary | |
---|---|
AbstractTerminalService | Abstract base class for clients to create an ITerminalService. |
AbstractTerminalShell | Abstract base class for clients to create an ITerminalShell instance. |
BaseShellDecorator | Abstract base class for clients to decorate an IBaseShell instance they have with additional functionality. |
ProcessBaseShell | A wrapper for Java Process objects to give more convenient access to
them through the IBaseShell interface. |
TerminalShellDecorator | Abstract base class for clients to decorate an ITerminalShell instance they have with additional functionality. |
PROVISIONAL Application programming interface for the RSE Base Shell and Terminal Services.
EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the Target Management team.
The RSE Terminal Services packages provides interfaces and basic utility classes for shell or terminal connections. The classes in this package are especially designed to be extendable by means of the Decorator pattern as well as the Adapter pattern:
IBaseShell
is the basic interface for communicating with a (potentially remote) process
through a channel supporting Streams. The Interface is modeled after the
java.lang.Process
class, but provides some nice enhancements such as a timeout for the
waitFor()
method, as well as an isActive()
method.ProcessBaseShell
is a sample class implementing IBaseShell, that wraps an existing
java.lang.Process
object in the IBaseShell interface for easier consumption.ITerminalShell
extends IBaseShell, adding methods specific to the presentation of the data
transferred from the (remote) process: it provides for getDefaultEncoding(),
getPtyType(), isLocalEcho() as well as setTerminalSize() methods.AbstractTerminalShell
is an abstract base class that implementers of ITerminalShell must extend.
It provides default implementations of all methods where possible, and
ensures that future evolving of the ITerminalShell interface
can be done without breaking binary compatibility with extenders implementing it.BaseShellDecorator
and
TerminalShellDecorator
abstract base
classes should be used when clients want to add functionality by decorating
an existing IBaseShell or ITerminalShell object they have. Again, extending
these not only saves the extender typing default delegation methods, but also
ensures that they remain binary compatible in case the interfaces evolve.ITerminalService
is the RSE Service Interface, and currently only
provides one factory method launchTerminal()
for creating
a new Terminal Connection.
AbstractTerminalService
must be used as base
class by extenders who wish to implement the ITerminalService, in order to ensure
binary compatibility in case the interface evolves - even though
the AbstractTerminalService is currently empty.IBaseShell
, along with
ProcessBaseShell
and
BaseShellDecorator
are usable in
any environment, provided that mock objects are provided for Eclipse
IAdaptable and PlatformObject.
|
RSE Release 3.0 |
|||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |