* The difference between this ManagerServlet and this
* Servlet is that this Servlet prints out a HTML interface which
* makes it easier to administrate.
*
* However if you use a software that parses the output of
* ManagerServletManagerServlet
*
* @author Bip Thelin
* @author Malcolm Edgar
* @version $Revision: 1.6 $, $Date: 2002/01/05 19:50:48 $
* @see ManagerServlet
*/
public final class HTMLManagerServlet extends ManagerServlet {
// --------------------------------------------------------- Public Methods
/**
* Process a GET request for the specified resource.
*
* @param request The servlet request we are processing
* @param response The servlet response we are creating
*
* @exception IOException if an input/output error occurs
* @exception ServletException if a servlet-specified error occurs
*/
public void doGet(HttpServletRequest request,
HttpServletResponse response)
throws IOException, ServletException {
doPost(request, response);
}
/**
* Process a POST request for the specified resource.
*
* @param request The servlet request we are processing
* @param response The servlet response we are creating
*
* @exception IOException if an input/output error occurs
* @exception ServletException if a servlet-specified error occurs
*/
public void doPost(HttpServletRequest request,
HttpServletResponse response)
throws IOException, ServletException {
// Identify the request parameters that we need
String command = request.getPathInfo();
String path = request.getParameter("path");
String installPath = request.getParameter("installPath");
String installConfig = request.getParameter("installConfig");
String installWar = request.getParameter("installWar");
// Prepare our output writer to generate the response message
response.setContentType("text/html");
PrintWriter writer = response.getWriter();
// Process the requested command
if (command == null) {
response.sendRedirect(request.getRequestURI()+"/list");
} else if (command.equals("/gc")) {
gc(writer);
} else if (command.equals("/install")) {
install(writer, installConfig, installPath, installWar);
} else if (command.equals("/list")) {
list(writer, "");
} else if (command.equals("/reload")) {
reload(writer, path);
} else if (command.equals("/remove")) {
remove(writer, path);
} else if (command.equals("/sessions")) {
sessions(writer, path);
} else if (command.equals("/start")) {
start(writer, path);
} else if (command.equals("/stop")) {
stop(writer, path);
} else {
String message =
sm.getString("managerServlet.unknownCommand", command);
list(writer, message);
}
// Finish up the response
writer.flush();
writer.close();
}
/**
* Invoke the Runtime garbage collector and then the list
* command.
*
* @param writer Writer to render to
*/
public void gc(PrintWriter writer) {
if (debug >= 1)
log("gc: Invoking Runtime garbage collection");
Runtime.getRuntime().gc();
list(writer, "Memory garbage collection complete");
}
/**
* Install an application for the specified path from the specified
* web application archive.
*
* @param writer Writer to render results to
* @param config URL of the context configuration file to be installed
* @param path Context path of the application to be installed
* @param war URL of the web application archive to be installed
*/
protected void install(PrintWriter writer, String config,
String path, String war) {
StringWriter stringWriter = new StringWriter();
PrintWriter printWriter = new PrintWriter(stringWriter);
super.install(printWriter, config, path, war);
list(writer, stringWriter.toString());
}
/**
* Render a HTML list of the currently active Contexts in our virtual host,
* and memory and server status information.
*
* @param writer Writer to render to
* @param message a message to display
*/
public void list(PrintWriter writer, String message) {
if (debug >= 1)
log("list: Listing contexts for virtual host '" +
deployer.getName() + "'");
// HTML Header Section
writer.print(HTML_HEADER_SECTION);
// Body Header Section
Object[] args = new Object[1];
args[0] = sm.getString("htmlManagerServlet.title");
writer.print(MessageFormat.format(BODY_HEADER_SECTION, args));
// Apps Header Section
args = new Object[5];
args[0] = sm.getString("htmlManagerServlet.appsTitle");
args[1] = sm.getString("htmlManagerServlet.appsPath");
args[2] = sm.getString("htmlManagerServlet.appsName");
args[3] = sm.getString("htmlManagerServlet.appsAvailable");
args[4] = sm.getString("htmlManagerServlet.appsSessions");
writer.print(MessageFormat.format(APPS_HEADER_SECTION, args));
// Apps Row Section
// Create sorted map of deployed applications context paths.
String contextPaths[] = deployer.findDeployedApps();
TreeMap sortedContextPathsMap = new TreeMap();
for (int i = 0; i < contextPaths.length; i++) {
String displayPath = contextPaths[i];
if (displayPath.equals("")) {
displayPath = "/";
}
sortedContextPathsMap.put(displayPath, contextPaths[i]);
}
String appsStart = sm.getString("htmlManagerServlet.appsStart");
String appsStop = sm.getString("htmlManagerServlet.appsStop");
String appsReload = sm.getString("htmlManagerServlet.appsReload");
String appsRemove = sm.getString("htmlManagerServlet.appsRemove");
Iterator iterator = sortedContextPathsMap.entrySet().iterator();
while (iterator.hasNext()) {
Map.Entry entry = (Map.Entry) iterator.next();
String displayPath = (String) entry.getKey();
String contextPath = (String) entry.getKey();
Context context = deployer.findDeployedApp(contextPath);
if (context != null ) {
args = new Object[6];
args[0] = displayPath;
args[1] = context.getDisplayName();
if (args[1] == null) {
args[1] = " ";
}
args[2] = new Boolean(context.getAvailable());
args[3] =
new Integer(context.getManager().findSessions().length);
writer.print
(MessageFormat.format(APPS_ROW_DETAILS_SECTION, args));
args = new Object[5];
args[0] = displayPath;
args[1] = appsStart;
args[2] = appsStop;
args[3] = appsReload;
args[4] = appsRemove;
writer.print
(MessageFormat.format(APPS_ROW_BUTTON_SECTION, args));
} else if (displayPath.equals("/")) {
args = new Object[4];
args[0] = displayPath;
args[1] = "ROOT";
args[2] = new Boolean(true);
args[3] = "-";
writer.print
(MessageFormat.format(APPS_ROOT_ROW_SECTION, args));
}
}
// Install Section
args = new Object[5];
args[0] = sm.getString("htmlManagerServlet.installTitle");
args[1] = sm.getString("htmlManagerServlet.installPath");
args[2] = sm.getString("htmlManagerServlet.installConfig");
args[3] = sm.getString("htmlManagerServlet.installWar");
args[4] = sm.getString("htmlManagerServlet.installButton");
writer.print(MessageFormat.format(INSTALL_SECTION, args));
// Memory Header Section
args = new Object[5];
args[0] = sm.getString("htmlManagerServlet.memoryTitle");
args[1] = sm.getString("htmlManagerServlet.memoryTotal");
args[2] = sm.getString("htmlManagerServlet.memoryAvailable");
args[3] = sm.getString("htmlManagerServlet.memoryUsed");
args[4] = sm.getString("htmlManagerServlet.memoryTime");
writer.print(MessageFormat.format(MEMORY_HEADER_SECTION, args));
// Memory Row Section
long totalMemory = Runtime.getRuntime().totalMemory();
long freeMemory = Runtime.getRuntime().freeMemory();
long percentageUsed = (totalMemory - freeMemory) * 100/ totalMemory;
args = new Object[6];
args[0] = new Long(totalMemory / 1024);
args[1] = new Long(freeMemory / 1024);
args[2] = new Long(percentageUsed);
args[3] = new Date();
args[4] = sm.getString("htmlManagerServlet.memoryRefresh");
args[5] = sm.getString("htmlManagerServlet.memoryRunGC");
writer.print(MessageFormat.format(MEMORY_ROW_SECTION, args));
// Server Header Section
args = new Object[7];
args[0] = sm.getString("htmlManagerServlet.serverTitle");
args[1] = sm.getString("htmlManagerServlet.serverVersion");
args[2] = sm.getString("htmlManagerServlet.serverJVMVersion");
args[3] = sm.getString("htmlManagerServlet.serverJVMVendor");
args[4] = sm.getString("htmlManagerServlet.serverOSName");
args[5] = sm.getString("htmlManagerServlet.serverOSVersion");
args[6] = sm.getString("htmlManagerServlet.serverOSArch");
writer.print(MessageFormat.format(SERVER_HEADER_SECTION, args));
// Server Row Section
args = new Object[6];
args[0] = ServerInfo.getServerInfo();
args[1] = System.getProperty("java.runtime.version");
args[2] = System.getProperty("java.vm.vendor");
args[3] = System.getProperty("os.name");
args[4] = System.getProperty("os.version");
args[5] = System.getProperty("os.arch");
writer.print(MessageFormat.format(SERVER_ROW_SECTION, args));
// Message Section
args = new Object[3];
args[0] = sm.getString("htmlManagerServlet.messageLabel");
args[1] = (message != null) ? message : "";
writer.print(MessageFormat.format(MESSAGE_SECTION, args));
}
/**
* Reload the web application at the specified context path.
*
* @see ManagerServlet#reload(PrintWriter, String)
*
* @param writer Writer to render to
* @param path Context path of the application to be restarted
*/
protected void reload(PrintWriter writer, String path) {
StringWriter stringWriter = new StringWriter();
PrintWriter printWriter = new PrintWriter(stringWriter);
super.reload(printWriter, path);
list(writer, stringWriter.toString());
}
/**
* Remove the web application at the specified context path.
*
* @see ManagerServlet#remove(PrintWriter, String)
*
* @param writer Writer to render to
* @param path Context path of the application to be removed
*/
protected void remove(PrintWriter writer, String path) {
StringWriter stringWriter = new StringWriter();
PrintWriter printWriter = new PrintWriter(stringWriter);
super.remove(printWriter, path);
list(writer, stringWriter.toString());
}
/**
* Display session information and invoke list.
*
* @see ManagerServlet#sessions(PrintWriter, String)
*
* @param writer Writer to render to
* @param path Context path of the application to list session information for
*/
public void sessions(PrintWriter writer, String path) {
StringWriter stringWriter = new StringWriter();
PrintWriter printWriter = new PrintWriter(stringWriter);
super.sessions(printWriter, path);
list(writer, stringWriter.toString());
}
/**
* Start the web application at the specified context path.
*
* @see ManagerServlet#start(PrintWriter, String)
*
* @param writer Writer to render to
* @param path Context path of the application to be started
*/
public void start(PrintWriter writer, String path) {
StringWriter stringWriter = new StringWriter();
PrintWriter printWriter = new PrintWriter(stringWriter);
super.start(printWriter, path);
list(writer, stringWriter.toString());
}
/**
* Stop the web application at the specified context path.
*
* @see ManagerServlet#stop(PrintWriter, String)
*
* @param writer Writer to render to
* @param path Context path of the application to be stopped
*/
protected void stop(PrintWriter writer, String path) {
StringWriter stringWriter = new StringWriter();
PrintWriter printWriter = new PrintWriter(stringWriter);
super.stop(printWriter, path);
list(writer, stringWriter.toString());
}
// ------------------------------------------------------ Private Constants
// These HTML sections are broken in relatively small sections, because of
// limited number of subsitutions MessageFormat can process
// (maximium of 10).
private static final String HTML_HEADER_SECTION =
" \n" +
" \n" +
" \n";
private static final String BODY_HEADER_SECTION =
"