net.wimpi.telnetd.shell
Class ShellManager

java.lang.Object
  net.wimpi.telnetd.shell.ShellManager

public class ShellManager
extends java.lang.Object

This class implements a Manager Singleton that takes care for all shells to be offered.

The resources can be defined via properties that contain following information:

• All system defined shells:
  1. Login: first shell run on top of the connection.
  2. Queue: shell thats run for connections placed into the queue.
  3. Admin: shell for administrative tasks around the embedded telnetd.
• Custom defined shells:
  Declared as value to the customshells key, in form of a comma seperated list of names. For each declared name there has to be an entry defining the shell.

The definition of any shell is simply represented by a fully qualified class name, of a class that implements the shell interface. Please read the documentation of this interface carefully.
The properties are passed on creation through the factory method, which is called by the net.wimpi.telnetd.TelnetD class.

Version:

2.0 (16/07/2006)

Author:

Dieter Wimberger

See Also:

Shell

Method Summary

static ShellManager	createShellManager(java.util.HashMap shells) creates an empty shell manager
static ShellManager	createShellManager(java.util.Properties settings) Factory method for creating the Singleton instance of this class. Note that this factory method is called by the net.wimpi.telnetd.TelnetD class.
static ShellManager	getReference() Accessor method for the Singleton instance of this class. Note that it returns null if the instance was not properly created beforehand.
Shell	getShell(java.lang.String key) Accessor method for shells that have been set up. Note that it uses a factory method that any shell should provide via a specific class operation.
java.util.HashMap	getShells()
void	setShells(java.util.HashMap shells)

Methods inherited from class java.lang.Object

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

Method Detail

getShell

public Shell getShell(java.lang.String key)

Accessor method for shells that have been set up.
Note that it uses a factory method that any shell should provide via a specific class operation.

Parameters:

key - String that represents a shell name.

Returns:

Shell instance that has been obtained from the factory method.

createShellManager

public static ShellManager createShellManager(java.util.Properties settings)
                                       throws BootException

Factory method for creating the Singleton instance of this class.
Note that this factory method is called by the net.wimpi.telnetd.TelnetD class.

Parameters:

settings - Properties defining the shells as described in the class documentation.

Returns:

ShellManager Singleton instance.

Throws:

BootException

createShellManager

public static ShellManager createShellManager(java.util.HashMap shells)

creates an empty shell manager

getReference

public static ShellManager getReference()

Accessor method for the Singleton instance of this class.
Note that it returns null if the instance was not properly created beforehand.

Returns:

ShellManager Singleton instance reference.

getShells

public java.util.HashMap getShells()

setShells

public void setShells(java.util.HashMap shells)