GlassFish Project - Admin Console (GUI) home page

New to GlassFish | Community Guidelines | Downloads | FAQ | How-Tos


Welcome to the Admin Console (GUI) home page. Admin Console is a browser-based administration user interface for the application server. This tool is designed for ease of use for administrators and developers. It provides graphical representation of the objects under management, enhanced log file viewing, and better display of overall system status and monitoring data.
This page is dedicated to discussing GUI in GlassFish. The source code of GUI is part of the cvs repository.
Please send any questions or comments to dev@glassfish.dev.java.net.

Admin Console News

GUI now supports all the new features available in GlassFish, including Call Flow, Web Service Management, Log Analyzer etc. The ability to launch an application client with Java Web Start enabled is also available. See below for more information on the features included and the architectural design of Admin Console.

Page Contents

Technologies


The majority of the GlassFish code is available under the Common Development and Distribution License (CDDL) v1.0  The following page contains details about the components in GlassFish and the licenses under which they are covered.



The Admin GUI is designed as a typical J2EE web application using servlets. The primary servlet is a based on the Sun ONE Application Framework (JATO) library, with Lockhart Common Components. The Lockhart Common Components provide I18N support and HCI-Admin style guideline compliance. On top of JATO and Lockhart, we have designed a reasonably general web GUI framework. This Declarative Framework provides a convenient way to declare and describe the GUI components on each web page through XML files. The framework is event driven, such that each page and each component has a set of events that can optionally specify Java event handlers to be called. For example, a beginDisplay event handler can call a Java method to retrieve data from the back-end and populate the display fields on a web page.

A Declarative Framework slide presentation with notes that gives you more information about the framework is available for further reading.

The Lockhart Common Components are a set of general purpose tags that follow HCI-Admin style guidelines. This component will work in any web container complying with Servlet 2.3 or higher and JSP 1.2 or higher and can be used in tools like Creator or Netbeans. This code is currently included as binary only.

The GUI layer interacts with the back-end through JMX MBeans exclusively. The MBeans provide calls to store and retrieve data as well as operational methods, such as deploy an application.

The source code includes Java, JSP, XML and HTML files. JSP files define the HTML page layout in terms of JATO and Lockhart components. XML files are used to describe the detailed page layouts and the event handler calls. Other XML files include Lockhart's action table and property sheet descriptions, and the tree hierarchy description files. All the XML files are considered project private files such that the customer need not be aware of their existence any more than they are aware of JSP files and should not have the need to edit them.

In the future we will migrate to the next generation of Lockhart components that are based on JSF. This release will use the Lockhart 3 JSF tree component, other portions of the UI will remain JATO based for this release.

The engine to run the admin application is the app server itself. The Admin GUI application is designed to run remotely by connecting to a remote MBean server via a JMX Connector.

In a future release of this Administrative GUI, the technology responsible for generating the GUI (Lockhart) will be upgraded to a version that supports JSF. This may require a substantial conversion effort. This is necessary to be able to utilize new Lockhart features that are only available in the JSF version, and to promote JSF by using it within our own products.

Working with GUI

Building

GUI is one of the modules in the GlassFish project. The name of the module is admin-gui. Admin GUI will be built when following the instructions on how to build GlassFish.
After the build is finished, source code will be available under ${glassfish.root}/glassfish/admin-gui.
The assembled war file for admin GUI will be installed under ${glassfish.home}/lib/install/applications/admingui.

If you only want to build Admin GUI module, you can set up your build environment, and do

maven checkout -Dmodules=admin-gui bootstrap build configure-runtime

The above command will only check out the source for admin-gui module and build it.
You can also browse the GUI source code without actually downloading it.

Customizing

GUI is designed so that you can easily customize or add a page to it without writing any Java code. We are currently working to provide you with detailed steps on how to do it. This will be available soon.

Debugging

We are writing up the hints and tips in developing and debugging GUI. Check back periodically for updates.



Usage

The Admin Console is a browser-based tool that features an easy-to-navigate interface and online help. The administration server must be running to use the Admin Console. The application server is built with 4848 as the default port listener for Admin Console. There is also a default user name and password for the administrator. Refer to build step #5 regarding the defaults. Use the CLI command to start the server, and then in a browser, type in http://hostname:4848. The login page will be presented and once you are logged in, you will be able to perform any task available in the common task page, or navigate the object tree to find out more about the server configuration.

The browsers supported are the browsers supported by the Lockhart libraries. They include the following:



Unit/Acceptance Tests

Per commit procedures the Quicklook Tests are required for GUI. In addition to the quicklook tests, we are also developing a way to track the performance such as the startup rate of GUI. Refer to the ToDo List below.

Supporting Documentation

Here is a list of useful documents and information about the technologies used in the implementation of Admin Console.


Specifications:



ToDo List

ToDo list will be maintained using Issue Tracker Task issue type. You can query Issue Tracker using issue type Task or click here to check out the ToDo list.