com.ls.cockpit.shell
Class CockpitShell

java.lang.Object
  |
  +--com.ls.cockpit.shell.CockpitShell
All Implemented Interfaces:
ICockpitConstants, IShellConstants, IUserInterface, Runnable

public class CockpitShell
extends Object
implements IShellConstants, IUserInterface, ICockpitConstants, Runnable

The shell implementation of cockpit to connect lars and sending messages, ... --> administrate the platform

Version:
$Revision: 1.10 $
Author:
Last modified by $Author: ASchneider $

Field Summary
protected  String revisionInformation
          revision information string, managed by our version control system.
 
Fields inherited from interface com.ls.cockpit.shell.IShellConstants
MAX_COLUMNS_STRING, MAX_ROWS_STRING, MIN_REST_SPACE_STRING, TAB_SIZE_STRING
 
Fields inherited from interface com.ls.cockpit.ICockpitConstants
ADD_HISTORY_STRING, ADD_INBOX_STRING, ADD_OUTBOX_STRING, ADMIN_STRING, ADMINISTRATOR_TAG, AGENT_LIST_TAG, AGENT_MANAGER_NAME, AGENT_NUMBER_TAG, AGENT_SYNCHRONIZE_SUPERVISOR_NAME, ALIAS_TAG, ALIASES_TAG, AUTHENTICATE_TIMEOUT, AUTO_COMPRESSION_START_SIZE_TAG, AUTO_COMPRESSION_TAG, BROADCAST_MESSAGE_STRING, BROADCAST_MESSAGE_TAG, CFG_FILE_TAG, CLASS_TAG, CLOSE_CFG_FILE_TAG, CLOSE_CONTENT_TAG, COCKPIT_APPLET_CLASS_NAME, COCKPIT_GUI_CLASS_NAME, COCKPIT_SERVLET_CLASS_NAME, COCKPIT_SHELL_CLASS_NAME, COMMAND_ADD_MONITOR_STRING, COMMAND_CLEAR_HISTORY_STRING, COMMAND_CLEAR_INBOX_STRING, COMMAND_CLEAR_MONITOR_STRING, COMMAND_CLEAR_OUTBOX_STRING, COMMAND_COMMAND_PATH_STRING, COMMAND_COMPRESSION_STRING, COMMAND_CONNECT_STRING, COMMAND_CONNECTION_STRING, COMMAND_CREATE_REPLY_STRING, COMMAND_CURRENT_CONNECTION_STRING, COMMAND_DELETE_GROUP_STRING, COMMAND_DELETE_STRING, COMMAND_DISCONNECT_STRING, COMMAND_FORWARD_MESSAGE_STRING, COMMAND_HELP_PATH_STRING, COMMAND_HELP_STRING, COMMAND_HISTORY_ENTRY_STRING, COMMAND_HISTORY_PATH_STRING, COMMAND_HISTORY_STRING, COMMAND_INBOX_ENTRY_STRING, COMMAND_INBOX_STRING, COMMAND_KILL_GROUP_STRING, COMMAND_KILL_STRING, COMMAND_LIST_ACTIVE_STRING, COMMAND_LIST_INACTIVE_STRING, COMMAND_LIST_PLATFORMS_STRING, COMMAND_LIST_STRING, COMMAND_LOAD_COMMAND_STRING, COMMAND_LOAD_HELP_STRING, COMMAND_LOAD_HISTORY_STRING, COMMAND_LOAD_MONITOR_STRING, COMMAND_LOG_SYSTEM_STRING, COMMAND_MANAGER_CLASS_NAME, COMMAND_MANAGER_PARAMETERS, COMMAND_MONITOR_PATH_STRING, COMMAND_MONITOR_STRING, COMMAND_NEW_STRING, COMMAND_OUTBOX_ENTRY_STRING, COMMAND_OUTBOX_STRING, COMMAND_PING_STRING, COMMAND_QUIT_STRING, COMMAND_RELOAD_STRING, COMMAND_REMOVE_CONNECTION_STRING, COMMAND_REMOVE_MONITOR_STRING, COMMAND_RESTART_GROUP_STRING, COMMAND_RESTART_LARS_STRING, COMMAND_RESTART_MONITOR_STRING, COMMAND_RESTART_STRING, COMMAND_SAVE_HISTORY_STRING, COMMAND_SEND_HISTORY_STRING, COMMAND_SEND_STRING, COMMAND_SEND_SYNC_STRING, COMMAND_SET_COMMAND_PATH_STRING, COMMAND_SET_COMPRESSION_STRING, COMMAND_SET_CONNECTION_STRING, COMMAND_SET_HELP_PATH_STRING, COMMAND_SET_HISTORY_PATH_STRING, COMMAND_SET_MONITOR_PATH_STRING, COMMAND_SHUTDOWN_LARS_STRING, COMMAND_START_LARS_STRING, COMMAND_TAG, COMMAND_UPDATE_MONITOR_STRING, COMMANDLIST_DIR_TAG, COMMANDLIST_TAG, COMPRESSION_CLASS_NAME, COMPRESSION_LEVEL_TAG, COMPRESSION_PARAMETERS, COMPRESSION_TAG, COMPRESSION_TYPE_TAG, CONNECT_CLASS_NAME, CONNECTION_PARAMETERS, CONNECTION_TAG, CONNECTION_TYPE_TAG, CONTENT_TAG, CURRENT_HOPS_TAG, DEFAULT_AUTO_COMPRESSION, DEFAULT_AUTO_COMPRESSION_START_SIZE, DEFAULT_COMPRESSION_LEVEL, DEFAULT_COMPRESSION_TYPE, DEFAULT_CONFIG_FILE_NAME, DEFAULT_CONNECTION_TYPE, DEFAULT_HELP_FILE_NAME, DEFAULT_KEY_FILE, DEFAULT_LOG_FILE_NAME, DEFAULT_LOG_LEVEL, DEFAULT_MESSAGE_LENGTH, DEFAULT_PASSWORD, DEFAULT_PLATFORM_DIRECTORY, DEFAULT_PLATFORM_ID, DEFAULT_PLATFORM_IP, DEFAULT_PLATFORM_PORT, DEFAULT_PROTOCOL, DEFAULT_PROVIDER, DEFAULT_STRING, DEFAULT_USER, DEFAULT_USER_INTERFACE_TYPE, DEFAULT_ZIP_ENTRY_NAME, DEPENDENCIES_TAG, DESCRIPTION_TAG, DIRECTORIES_TAG, EXAMPLE_STRING, EXAMPLE_TAG, EXPIRE_HOPS_TAG, GET_AGENTS_STATUS_STRING, GET_DEPENDENCY_STRING, GLOBAL_DIR_TAG, GROUP_MESSAGE_STRING, GROUP_MESSAGE_TAG, HELP_CLASS_NAME, HELP_DIR_TAG, HELP_FILE_NAME_TAG, HELP_PARAMETERS, HISTORY_CLASS_NAME, HISTORY_DIR_TAG, HISTORY_PARAMETERS, ICOMMAND_INTERFACE_NAME, IN_REPLY_TO_TAG, INBOX_CLASS_NAME, INBOX_NUMBER_TAG, IS_HISTORY_SAVED_STRING, KEY_FILE_TAG, LIST_TAG, LOG_FILE_TAG, LOG_LEVEL_TAG, LOG_SYSTEM_INFORMATION_NAME, LOGGING_TAG, LONG_DESCRIPTION_TAG, MAP_CLASS_NAME, MESSAGE_LENGTH_TAG, MESSAGE_TAG, MONITOR_CLASS_NAME, MONITOR_DIR_TAG, MONITOR_PARAMETERS, MONITORING_TAG, MULTICAST_MESSAGE_STRING, MULTICAST_MESSAGE_TAG, NAME_TAG, OPEN_CFG_FILE_TAG, OPEN_CONTENT_TAG, OUTBOX_CLASS_NAME, PARAMETER_TAG, PARAMETERS_TAG, PASSWORD_STRING, PASSWORD_TAG, PLATFORM_DIRECTORY_TAG, PLATFORM_ID_TAG, PLATFORM_IP_TAG, PLATFORM_PORT_TAG, PLATFORM_TAG, PRIORITY_TAG, PROTOCOL_TAG, PROVIDER_TAG, PWD_STRING, QUALITY_OF_SERVICE_TAG, QUIT_CLASS_NAME, RECEIVER_TAG, REPLY_WITH_TAG, SEND_ALL_MESSAGES_FROM_HISTORY_STRING, SEND_MESSAGE_PARAMETERS, SENDER_TAG, SENT_TIME_TAG, SERVICE_BROADCAST_MESSAGE_STRING, SERVICE_BROADCAST_MESSAGE_TAG, SERVICE_SINGLE_MESSAGE_STRING, SERVICE_SINGLE_MESSAGE_TAG, SERVICE_TAG, SET_AGENTS_STATUS_ACTIVE_STRING, SET_AGENTS_STATUS_INACTIVE_STRING, SET_HISTORY_SAVED_STRING, SHORT_DESCRIPTION_TAG, SINGLE_MESSAGE_STRING, SINGLE_MESSAGE_TAG, STANDARD_COMMAND_LIB_CLASS_NAME, START_AGENT_TAG, STRING_CONTENT_TAG, TYPE_TAG, UI_TAG, USAGE_STRING, USAGE_TAG, USER_INTERFACE_TYPE_APPLET, USER_INTERFACE_TYPE_SERVLET, USER_INTERFACE_TYPE_SHELL, USER_INTERFACE_TYPE_SWING, USER_INTERFACE_TYPE_TAG, USER_TAG, VALID_PARAMETERS, XML_CONTENT_TAG, XML_TAG, ZIP_ENTRY_NAME_TAG
 
Constructor Summary
CockpitShell()
          the default constructor
CockpitShell(ICommand commandTemplate, Map settings)
          the constructor containing a reference to cockpit (CommandInterface)
 
Method Summary
 String askToSaveHistory()
          asks if the history should be saved if a new history will be loaded or cockpit will be ended.
 void run()
          runs the thread.
 void setUserInterfaceReference()
          sets the reference to the user interface for the commandTemplate
 boolean updateUI(Object arguments)
          is called by cockpit if something changes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

revisionInformation

protected String revisionInformation
revision information string, managed by our version control system.
Constructor Detail

CockpitShell

public CockpitShell()
the default constructor

CockpitShell

public CockpitShell(ICommand commandTemplate,
                    Map settings)
the constructor containing a reference to cockpit (CommandInterface)
Parameters:
commandTemplate - the reference to the commandTemplate interface
settings - the settings for the shell like maximum visible rows and columns
Method Detail

setUserInterfaceReference

public void setUserInterfaceReference()
sets the reference to the user interface for the commandTemplate
Specified by:
setUserInterfaceReference in interface IUserInterface

askToSaveHistory

public String askToSaveHistory()
asks if the history should be saved if a new history will be loaded or cockpit will be ended.
Specified by:
askToSaveHistory in interface IUserInterface
Returns:
String the user entry

updateUI

public boolean updateUI(Object arguments)
is called by cockpit if something changes. This is used that e.g. the monitor state should be updated. The just arguments contains the command strings should be called to update the needed changes.
Specified by:
updateUI in interface IUserInterface
Parameters:
arguments - contains all commands should be called to update the needed changes
Returns:
boolean true if successful

run

public void run()
runs the thread. Waits for entries by user to execute any command.
Specified by:
run in interface IUserInterface