Package fr.gedeon.telnetservice

This package homes the core components of the telnetservice.

See:
Description

Interface Summary

ActionListener	It is provided by a registered TelnetServiceExtension implementation, and is added as a listener of user activity.
ConsoleDelegate	Represents the user console in the context of an active connection.
OutputFormat	The OutputFormat interface is used by extensions and integration modules.
OutputFormatSpi	This is the service provider's additional interface definition to the OutputFormat API.
OutputFormatVT100Constants	VT100 formatting constants.
PromptDecorator	Classes implementing this interface can be provided by a TelnetServiceExtension for contribution in the construction of the user console prompt.
SessionListener	Classes that implement this interface can register to receive session connection events.
TelnetServiceExtension	The ServiceExtension is the entry point for customizing the service. A service extension has 2 purposes: it acts as a factory for ActionListeners, and specifies their priority in receiving action events, and it acts as a factory for PromptDecorators, and specifies the order in which they are invoked to construct the console prompt It is expected that the service extension name is unique, as it will be used when notifying about error situations and when logging activity.

Class Summary

ActionListenerAbstractImpl	This is the default implementation of a ActionListener, it does nothing, and returns true to all notify* calls.
OutputFormatDefaultImpl	This is the default output format implementation provided by the basic package, it formats everything by calling String.valueOf(...) on the subject.
OutputFormatVelocityImpl	This implementation of the OutputFormat interface formats a given subject using a selected Apache Velocity Engine template.
OutputFormatVT100Impl	Abstract implementation of the OutputFormat interface that provides VT100 coloring helper methods.
Prompt	This is the data representation of the console prompt.
PromptDecoratorDefaultImpl	The default prompt decorator implementation, decorates the prompt by appending "> ".
Session	The Telnet Session is the main engine for a telnet connection; it handles inputs and outputs, keeping telnet state, responding to telnet specific commands, and notifies the Telnet Session Controller of important events (such as client input, client screen resize, etc) through the available notify* methods of ActionListeners provided by registered TelnetServiceExtension.
SessionState	Holds the state of the session, as well as that of the integrating application relating to the session. There is one Session State instance per session, and it is provided by the Session.
StateHolder	Provides a location to store state entries. This class is expected to change as means of simplifying the state storage are designed.
TelnetService	The service's main daemon component is the Telnet Service.
TelnetServiceExtensionAbstractImpl	Provides the implementation of the most basic API methods.

Exception Summary

ActionListenerCreateException	Thrown when there was an error acquiring an ActionListener instance from a provided TelnetServiceExtension implementation that flags itself as a provider of an action listener.
ActionListenerInitializationException	Thrown by an ActionListener implementation when it failed its initialization process.
OutputFormatException	Thrown by an OutputFormat implementation when there was an issue that prevented the formatting of a subject.
PromptDecoratorCreateException	Thrown by the service when an exception occurs while trying to acquire an instance of the prompt decorator provided by a TelnetServiceExtension.
PromptDecoratorInitializationException	Thrown by a PromptDecorator implementation when it fails to initialize.
StateEntryNotFoundException	Thrown by a SessionHolder when an entry was requested with a key but was not found.
TelnetServiceException	This is the common exception thrown by the different telnet service components.
TelnetServiceStartException	Thrown by the service on start failure.

Package fr.gedeon.telnetservice Description

This package homes the core components of the telnetservice. For an introduction to the service and its main components, please refer to 'Introduction to Telnet Service'