Telnet Bundle
The Telnet Bundle provides administration and monitoring of the mBS
framework over Telnet. Administrators can supervise the server using Telnet
client applications. The bundle provides administration commands by contacting
the Parser Service of the
ProSyst Util Bundle and mapping the command collection from this service to
Telnet.
Contents:
Bundle Information
Bundle JAR
The bundle JAR file of the Telnet Bundle is called telnet.jar, and is
found in the bundles folder.
Import
The Telnet Bundle imports the following packages:
| Package |
Exporter |
Description |
com.prosyst.util.parser |
ProSyst Util Bundle
/
ProSyst Util Full Bundle
|
Contains the Parser Service. The Telnet Bundle employs
the Parser Service to forward the plugged commands to the Telnet output. |
com.prosyst.util.ref |
Contains the log utility in the ProSyst
Util Bundle that the Telnet Bundle uses for writing log messages
about its runtime status. |
com.prosyst.util.timer |
The Timer service that sends notification after a specified
period of time. |
com.prosyst.util.time |
|
The time utility for high-resolution time measurement. |
prosyst.util.hash |
Hashtable utilities. |
com.prosyst.mbs.services.useradmin |
User Admin Extension
Bundle
|
Contains the Simple Login Service. The Telnet Bundle
verifies users at mBS login, and examines their administrative
rights. |
org.osgi.service.cm |
OSGi Library Bundle
|
Holds the resources for the configuration management,
which is provided by the Config
Bundle, of the Telnet Bundle. |
|
Export
The Telnet Bundle provides no packages for external use.
Managed Service
The Telnet Bundle registers the org.osgi.service.cm.ManagedService
service with the mbs.telnet.pid configuration PID.
Configuration
The Telnet Bundle can be configured using system properties and through the
mConsole of the Framework Professional Edition Package .
Configuration Resources
The Managed Service allows the configuration of the Telnet communication properties.
The configuration properties for Telnet communication are described in the table
below:
| Configuration
Property |
Name |
Data Type |
Description |
| primaryPort |
Primary Port |
java.lang.Integer |
Defines the primary port for communication
over Telnet. |
| historyLength |
Max Number of Remembered
Commands |
java.lang.Integer |
Defines the Telnet history length for the
commands, that are being cached. |
| snmpSupport |
SNMP Support |
java.lang.Boolean |
If true, allows a configuration over SNMP
on part of an SNMP manager. |
| userTimeOut |
User Timeout |
java.lang.Integer |
Assigns the timeout in milliseconds for
disconnecting a Telnet client. |
| bufferLength |
Max Length of Command |
java.lang.Integer |
Defines the greatest number of characters
in a command line. |
| maxUsers |
Max Users |
java.lang.Integer |
Assigns the greatest number of Telnet clients,
who may concurrently communicate with the Telnet Bundle. |
| maxLoginTries |
Max Login Tries |
java.lang.Integer |
Defines the greatest number of login attempts,
that a Telnet client is able to make. |
| secondaryPort |
Secondary Port |
java.lang.Integer |
Defines the secondary port for Telnet data
exchange, that is activated if the primary one is already in use. |
| loginTimeOut |
Login Timeout |
java.lang.Integer |
Assigns the timeout in milliseconds for
Telnet client login to the framework. |
|
Visual Administration
The Telnet Bundle owns a property editor that modifies the features of the
Telnet communication. It contacts remotely the Config
Bundle and fetches from it the configuration properties available for the
Telnet Bundle.
To load the editor:
- Start the framework if it is on the same host, or make sure that it is running
if it is on a distant one.
- Start the mConsole.
- From the bundle tree in the mConsole window, select console/Telnet
Bundle and unfold Telnet Configuration.
Figure 1: Configuration options for Telnet communication.
To settle some changes, click Set. If another framework administrator
altered the attributes of the Telnet Bundle, to view them, use Refresh.
The Defaults button loads the default settings for Telnet communication.
Changed properties are valid only for the subsequent connections made to the
Telnet Bundle. When altering a port number, the update comes dynamically.
System Properties
The Telnet Bundle supports the following system properties:
| System Property |
Description |
telnet.primaryport |
Refers to the primary port, used for Telnet communication.
(default value: 23) |
telnet.secondaryport |
Refers to the secondary port, used for Telnet communication.
(default value: 2323) |
|
Note: Both of the above mentioned system properties
have priority over the correspondent configuration properties.
|
mbs.so.timeout |
If true, the server socket timeout is set to 3 sec.
|
mbs.useradmin.anonymousConnect |
Turns on/off connecting to the framework with arbitrary
user name and password. It should be enabled when Simple Login service
(found in the User Admin Bundle
and in the User Admin
Extension Bundle) is not available. (default value: true) |
mbs.telnet.debug |
Turns on or off generation of debug information about
the runtime operation of the Telnet Bundle. |
mbs.measurements.full |
Enables generation of debug information
about the startup time of Telnet Bundle's functional parts. |
mbs.measurements.bundles |
mbs.telnet.debug.onconsole |
Prints produced debug information in the framework's
text console. |
|
You can set the above properties in the default.prs file.
Another way to set the system properties is through the framework's starting
script file or the command line. For more information refer to the "System
Properties" chapter from Getting Started.
References
Console Bundles