Tomcat Server Management UI Spec
Author: Stepan Herold
$Revision: 1.7 $
$Date: 2005/08/19 12:35:11 $
This document describes the Tomcat specific parts of the Server Manager and the Add Server Instance wizard UI.
See the J2EE Server Management UI Spec for the general parts of the UI, the Tomcat specific parts mentioned in this general spec are obsolete.
Table of Contents:
This specification is the basis for migration of the Tomcat server settings from the property sheet to the customizer in the Server Manager. In addition to the migration of the current settings, this specification also introduces some new, namely: Java Platform, VM Options and custom catalina script. Since some of the settings had been renamed to be in compliance with the Tomcat documentation and less confusing, the Add Server Instance wizard had to be updated accordingly.
See all the issues related to these changes.
The first step of this wizard is common for all servers and is described in the J2EE Server Management UI Spec.
Figure: Connection wizard panel
+----------------------------------------------------------------------------+
| Add Tomcat 5 Server |
+----------------------------------------------------------------------------+
| Connection |
| -------------------------------------------------------------------------- |
| |
| Specify the installation folder (Catalina Home) and login details. |
| |
| Catalina Home: |_________________________________________| [ Browse... ] |
| |
| [ ] Use Private Configuration Folder (Catalina Base) |
| Catalina Base: |_________________________________________| [ Browse... ] |
| |
| Username: |__________________________________| (for "manager" role) |
| Password: |__________________________________| |
| |
| |
| |
| |
+----------------------------------------------------------------------------+
Components of this wizard panel are following:
- Catalina Home editable text field - specifies location of the server installation.
- Browse (Catalina Home) button - opens a file chooser titled Browse Catalina Home Folder with OK and Cancel buttons. The Files of Type combo box shows one value - Folder. The initial browse location is the user home.
- Use Base Folder for Configuration and Deployment editable check box - specifies whether the Catalina Base directory should be used. Unchecked by default.
- Catalina Base editable text field - specifies the folder used for server configuration and deployment.
- Browse (Catalina Base) button - opens a file chooser titled Browse Catalina Base Folder with OK and Cancel buttons. The Files of Type combo box shows one value - Folder. The initial browse location is the user home.
- Username editable text field - specifies the manager role user name.
- Password editable password field - specifies the password.
Wizard buttons' behavior:
- Back button - always enabled.
- Next button - always disabled.
- Finish button - enabled only if all values are valid and catalina home and username fields are not empty.
UI for Classes, Sources and Javadoc tabs is common for all servers and is described in the J2EE Server Management UI Spec.
Connection Tab
Figure: Server Manager dialog showing Tomcat 5 Connection Tab
+---------------------------------------------------------------------------------------------------+
| Server Manager |
+---------------------------------------------------------------------------------------------------+
| Servers: |
| +-------------------------+ |
| |J2EE Servers | Server Name: |_Tomcat 5_____________________________________________| |
| | Sun Java System Appli. | Server Type: |_Tomcat 5_____________________________________________| |
| |//Tomcat 5////////////// | __________ _______ ________ _______ _______ _______ |
| | | /Connection\/Startup\/Platform\/Classes\/Sources\/Javadoc\ |
| | | | \-------------------------------------------------------+ |
| | | | | |
| | | | Catalina Home: |________________________________________________| | |
| | | | Catalina Base: |________________________________________________| | |
| | | | | |
| | | | Username: |___________________________| (for "manager" role) | |
| | | | Password: |___________________________| | |
| | | | | |
| | | | Server Port: |_______|8| | |
| | | | Shutdown Port: |_______|8| | |
| | | | | |
| | | | [x] Enable HTTP Monitor | |
| | | | | |
| | | | Note: Changes will take effect the next time you start the server | |
| +-------------------------+ +-------------------------------------------------------------------+ |
| [ Add Server...] [ Remove ] |
| |
| [[ Close ]] [ Help ] |
+---------------------------------------------------------------------------------------------------+
Components of this dialog are:
- Catalina Home non-editable text field - specifies location of the server installation.
- Catalina Base non-editable text field - specifies the folder used for server configuration and deployment.
- Username editable text field - specifies the username in the manager role.
- Password editable text field - specifies the password.
- Server Port editable spinner - specifies the server port number.
- Shutdown Port editable spinner - specifies the port number on which the server waits for a shutdown command.
- Enable HTTP Monitor check box - specifies whether to use the HTTP Monitor or not.
Startup Tab
Figure: Server Manager dialog showing Tomcat 5 Startup Tab
+---------------------------------------------------------------------------------------------------+
| Server Manager |
+---------------------------------------------------------------------------------------------------+
| Servers: |
| +-------------------------+ |
| |J2EE Servers | Server Name: |_Tomcat 5_____________________________________________| |
| | Sun Java System Appli. | Server Type: |_Tomcat 5_____________________________________________| |
| |//Tomcat 5////////////// | __________ _______ ________ _______ _______ _______ |
| | | /Connection\/Startup\/Platform\/Classes\/Sources\/Javadoc\ |
| | | +----------/ \----------------------------------------------+ |
| | | | | |
| | | | [x] Use Custom Catalina Script | |
| | | | Catalina Script: |_______________________________| [ Browse... ] | |
| | | | | |
| | | | [x] Force Shutdown | |
| | | | | |
| | | | Debugger Transport: | |
| | | | o Shared Memory Name: |__________________________| | |
| | | | o Socket Port: |_______|8| | |
| | | | | |
| | | | | |
| | | | | |
| | | | Note: Changes will take effect the next time you start the server | |
| +-------------------------+ +-------------------------------------------------------------------+ |
| [ Add Server...] [ Remove ] |
| |
| [[ Close ]] [ Help ] |
+---------------------------------------------------------------------------------------------------+
Components of this dialog are:
- Use custom catalina startup script check box - specifies whether to use custom catalina script or not. Unchecked by default.
- Catalina Script editable text field - specifies the custom catalina startup script.
- Force Shutdown check box - specifies whether to use the force shutdown (shutdown is followed by the kill command). Unchecked by default. Disabled on Windows.
- Debugger Transport radio button - specifies whether to use shared memory or socked based transport for debugging. Shared Memory is default on Windows, socket on other systems. Shared Memory is enabled only on Windows.
- Shared Memory Name editable text field - specifies the shared memory name. Enabled only on Windows.
- Socket Port editable spinner - specifies the socket port number.
Platform Tab
Figure: Server Manager dialog showing Tomcat 5 Platform Tab
+---------------------------------------------------------------------------------------------------+
| Server Manager |
+---------------------------------------------------------------------------------------------------+
| Servers: |
| +-------------------------+ |
| |J2EE Servers | Server Name: |_Tomcat 5_____________________________________________| |
| | Sun Java System Appli. | Server Type: |_Tomcat 5_____________________________________________| |
| |//Tomcat 5////////////// | __________ _______ ________ _______ _______ _______ |
| | | /Connection\/Startup\/Platform\/Classes\/Sources\/Javadoc\ |
| | | +-------------------/ \------------------------------------+ |
| | | | | |
| | | | Java Platform: |____________________|_v_| [ Manage Platforms... ] | |
| | | | VM Options: |________________________________________________| | |
| | | | (e.g. -Xms64m) | |
| | | | | |
| | | | [x] Use Security Manager | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | Note: Changes will take effect the next time you start the server | |
| +-------------------------+ +-------------------------------------------------------------------+ |
| [ Add Server...] [ Remove ] |
| |
| [[ Close ]] [ Help ] |
+---------------------------------------------------------------------------------------------------+
Components of this dialog are:
- Java Platform non-editable combo box - specifies the Java Platform the server will use. The Default Java Platform is the dafault.
- Manage Platforms button - opens the Java Platform Manager.
- VM Options editable text field - specifies the Java Virtual Machine options.
- Use Security Manager check box - specifies whether to use security manager or not. Unchecked by default.
