org.apache.catalina.manager.StatusTransformer Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.manager;
import java.io.PrintWriter;
import java.lang.management.ManagementFactory;
import java.lang.management.MemoryPoolMXBean;
import java.lang.management.MemoryUsage;
import java.lang.reflect.Method;
import java.text.MessageFormat;
import java.util.Date;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;
import java.util.Vector;
import javax.management.MBeanServer;
import javax.management.ObjectInstance;
import javax.management.ObjectName;
import javax.servlet.http.HttpServletResponse;
import org.apache.catalina.util.RequestUtil;
import org.apache.tomcat.util.ExceptionUtils;
/**
* This is a refactoring of the servlet to externalize
* the output into a simple class. Although we could
* use XSLT, that is unnecessarily complex.
*
* @author Peter Lin
*/
public class StatusTransformer {
// --------------------------------------------------------- Public Methods
public static void setContentType(HttpServletResponse response,
int mode) {
if (mode == 0){
response.setContentType("text/html;charset="+Constants.CHARSET);
} else if (mode == 1){
response.setContentType("text/xml;charset="+Constants.CHARSET);
}
}
/**
* Write an HTML or XML header.
*
* @param writer the PrintWriter to use
* @param args Path prefix for URLs
* @param mode - 0 = HTML header, 1 = XML declaration
*
*/
public static void writeHeader(PrintWriter writer, Object[] args, int mode) {
if (mode == 0){
// HTML Header Section
writer.print(Constants.HTML_HEADER_SECTION);
} else if (mode == 1){
writer.write(Constants.XML_DECLARATION);
writer.print(MessageFormat.format
(Constants.XML_STYLE, args));
writer.write("");
}
}
/**
* Write the header body. XML output doesn't bother
* to output this stuff, since it's just title.
*
* @param writer The output writer
* @param args What to write
* @param mode 0 means write
*/
public static void writeBody(PrintWriter writer, Object[] args, int mode) {
if (mode == 0){
writer.print(MessageFormat.format
(Constants.BODY_HEADER_SECTION, args));
}
}
/**
* Write the manager webapp information.
*
* @param writer The output writer
* @param args What to write
* @param mode 0 means write
*/
public static void writeManager(PrintWriter writer, Object[] args,
int mode) {
if (mode == 0){
writer.print(MessageFormat.format(Constants.MANAGER_SECTION, args));
}
}
public static void writePageHeading(PrintWriter writer, Object[] args,
int mode) {
if (mode == 0){
writer.print(MessageFormat.format
(Constants.SERVER_HEADER_SECTION, args));
}
}
public static void writeServerInfo(PrintWriter writer, Object[] args,
int mode){
if (mode == 0){
writer.print(MessageFormat.format(Constants.SERVER_ROW_SECTION, args));
}
}
/**
*
*/
public static void writeFooter(PrintWriter writer, int mode) {
if (mode == 0){
// HTML Tail Section
writer.print(Constants.HTML_TAIL_SECTION);
} else if (mode == 1){
writer.write(" ");
}
}
/**
* Write the OS state.
*
* @param writer The output writer
* @param mode Mode 0 will generate HTML.
* Mode 1 will generate XML.
* @param args I18n labels for the OS state values
*/
public static void writeOSState(PrintWriter writer, int mode, Object[] args) {
long[] result = new long[16];
boolean ok = false;
try {
String methodName = "info";
Class paramTypes[] = new Class[1];
paramTypes[0] = result.getClass();
Object paramValues[] = new Object[1];
paramValues[0] = result;
Method method = Class.forName("org.apache.tomcat.jni.OS")
.getMethod(methodName, paramTypes);
method.invoke(null, paramValues);
ok = true;
} catch (Throwable t) {
t = ExceptionUtils.unwrapInvocationTargetException(t);
ExceptionUtils.handleThrowable(t);
}
if (ok) {
if (mode == 0){
writer.print("OS
");
writer.print("");
writer.print( args[0] );
writer.print(formatSize(Long.valueOf(result[0]), true));
writer.print(" " + args[1]);
writer.print(formatSize(Long.valueOf(result[1]), true));
writer.print(" " + args[2]);
writer.print(formatSize(Long.valueOf(result[2]), true));
writer.print(" " + args[3]);
writer.print(formatSize(Long.valueOf(result[3]), true));
writer.print(" " + args[4]);
writer.print(Long.valueOf(result[6]));
writer.print("
");
writer.print(" " + args[5]);
writer.print(formatTime(Long.valueOf(result[11] / 1000), true));
writer.print(" " + args[6]);
writer.print(formatTime(Long.valueOf(result[12] / 1000), true));
writer.print("
");
} else if (mode == 1){
// NO-OP
}
}
}
/**
* Write the VM state.
* @param writer The output writer
* @param mode Mode 0 will generate HTML.
* Mode 1 will generate XML.
* @param args I18n labels for the VM state values
* @throws Exception Propagated JMX error
*/
public static void writeVMState(PrintWriter writer, int mode, Object[] args)
throws Exception {
SortedMap memoryPoolMBeans =
new TreeMap();
for (MemoryPoolMXBean mbean: ManagementFactory.getMemoryPoolMXBeans()) {
String sortKey = mbean.getType() + ":" + mbean.getName();
memoryPoolMBeans.put(sortKey, mbean);
}
if (mode == 0){
writer.print("JVM
");
writer.print("");
writer.print( args[0] );
writer.print(formatSize(
Long.valueOf(Runtime.getRuntime().freeMemory()), true));
writer.print(" " + args[1] );
writer.print(formatSize(
Long.valueOf(Runtime.getRuntime().totalMemory()), true));
writer.print(" " + args[2] );
writer.print(formatSize(
Long.valueOf(Runtime.getRuntime().maxMemory()), true));
writer.print("
");
writer.write("" + args[3] + " " + args[4] + " " + args[5] + " " + args[6] + " " + args[7] + " " + args[8] + " ");
writer.print(memoryPoolMBean.getName());
writer.write(" ");
writer.print(memoryPoolMBean.getType());
writer.write(" ");
writer.print(formatSize(Long.valueOf(usage.getInit()), true));
writer.write(" ");
writer.print(formatSize(Long.valueOf(usage.getCommitted()), true));
writer.write(" ");
writer.print(formatSize(Long.valueOf(usage.getMax()), true));
writer.write(" ");
writer.print(formatSize(Long.valueOf(usage.getUsed()), true));
if (usage.getMax() > 0) {
writer.write(" ("
+ (usage.getUsed() * 100 / usage.getMax()) + "%)");
}
writer.write("
");
} else if (mode == 1){
writer.write("");
writer.write(" ");
}
}
/**
* Write connector state.
* @param writer The output writer
* @param tpName MBean name of the thread pool
* @param name Connector name
* @param mBeanServer MBean server
* @param globalRequestProcessors MBean names for the global request processors
* @param requestProcessors MBean names for the request processors
* @param mode Mode 0 will generate HTML.
* Mode 1 will generate XML.
* @param args I18n labels for the Connector state values
* @throws Exception Propagated JMX error
*/
public static void writeConnectorState(PrintWriter writer,
ObjectName tpName, String name, MBeanServer mBeanServer,
Vector globalRequestProcessors,
Vector requestProcessors, int mode, Object[] args) throws Exception {
if (mode == 0) {
writer.print("");
writer.print(name);
writer.print("
");
writer.print("");
writer.print( args[0] );
writer.print(mBeanServer.getAttribute(tpName, "maxThreads"));
writer.print(" " + args[1]);
writer.print(mBeanServer.getAttribute(tpName, "currentThreadCount"));
writer.print(" " + args[2]);
writer.print(mBeanServer.getAttribute(tpName, "currentThreadsBusy"));
try {
Object value = mBeanServer.getAttribute(tpName, "keepAliveCount");
writer.print(" " + args[3]);
writer.print(value);
} catch (Exception e) {
// Ignore
}
writer.print("
");
ObjectName grpName = null;
Enumeration enumeration =
globalRequestProcessors.elements();
while (enumeration.hasMoreElements()) {
ObjectName objectName = enumeration.nextElement();
if (name.equals(objectName.getKeyProperty("name"))) {
grpName = objectName;
}
}
if (grpName == null) {
return;
}
writer.print( args[4] );
writer.print(formatTime(mBeanServer.getAttribute
(grpName, "maxTime"), false));
writer.print(" " + args[5]);
writer.print(formatTime(mBeanServer.getAttribute
(grpName, "processingTime"), true));
writer.print(" " + args[6]);
writer.print(mBeanServer.getAttribute(grpName, "requestCount"));
writer.print(" " + args[7]);
writer.print(mBeanServer.getAttribute(grpName, "errorCount"));
writer.print(" " + args[8]);
writer.print(formatSize(mBeanServer.getAttribute
(grpName, "bytesReceived"), true));
writer.print(" " + args[9]);
writer.print(formatSize(mBeanServer.getAttribute
(grpName, "bytesSent"), true));
writer.print("
");
writer.print(""+ args[10] + " " + args[11] + " " + args[12] +" " + args[13] +" " + args[14] + " " + args[15] + " " + args[16] + " " + args[17] + " ");
writeProcessorState(writer, objectName, mBeanServer, mode);
writer.print(" ");
}
}
writer.print("
");
writer.print("");
writer.print( args[18] );
writer.print("
");
} else if (mode == 1){
writer.write("");
writer.write(" enumeration =
globalRequestProcessors.elements();
while (enumeration.hasMoreElements()) {
ObjectName objectName = enumeration.nextElement();
if (name.equals(objectName.getKeyProperty("name"))) {
grpName = objectName;
}
}
if (grpName != null) {
writer.write("");
enumeration = requestProcessors.elements();
while (enumeration.hasMoreElements()) {
ObjectName objectName = enumeration.nextElement();
if (name.equals(objectName.getKeyProperty("worker"))) {
writeProcessorState(writer, objectName, mBeanServer, mode);
}
}
writer.write(" ");
}
writer.write(" ");
}
}
/**
* Write processor state.
*/
protected static void writeProcessorState(PrintWriter writer,
ObjectName pName,
MBeanServer mBeanServer,
int mode)
throws Exception {
Integer stageValue =
(Integer) mBeanServer.getAttribute(pName, "stage");
int stage = stageValue.intValue();
boolean fullStatus = true;
boolean showRequest = true;
String stageStr = null;
switch (stage) {
case (1/*org.apache.coyote.Constants.STAGE_PARSE*/):
stageStr = "P";
fullStatus = false;
break;
case (2/*org.apache.coyote.Constants.STAGE_PREPARE*/):
stageStr = "P";
fullStatus = false;
break;
case (3/*org.apache.coyote.Constants.STAGE_SERVICE*/):
stageStr = "S";
break;
case (4/*org.apache.coyote.Constants.STAGE_ENDINPUT*/):
stageStr = "F";
break;
case (5/*org.apache.coyote.Constants.STAGE_ENDOUTPUT*/):
stageStr = "F";
break;
case (7/*org.apache.coyote.Constants.STAGE_ENDED*/):
stageStr = "R";
fullStatus = false;
break;
case (6/*org.apache.coyote.Constants.STAGE_KEEPALIVE*/):
stageStr = "K";
fullStatus = true;
showRequest = false;
break;
case (0/*org.apache.coyote.Constants.STAGE_NEW*/):
stageStr = "R";
fullStatus = false;
break;
default:
// Unknown stage
stageStr = "?";
fullStatus = false;
}
if (mode == 0) {
writer.write("");
writer.write(stageStr);
writer.write(" ");
if (fullStatus) {
writer.write("");
writer.print(formatTime(mBeanServer.getAttribute
(pName, "requestProcessingTime"), false));
writer.write(" ");
writer.write("");
if (showRequest) {
writer.print(formatSize(mBeanServer.getAttribute
(pName, "requestBytesSent"), false));
} else {
writer.write("?");
}
writer.write(" ");
writer.write("");
if (showRequest) {
writer.print(formatSize(mBeanServer.getAttribute
(pName, "requestBytesReceived"),
false));
} else {
writer.write("?");
}
writer.write(" ");
writer.write("");
writer.print(filter(mBeanServer.getAttribute
(pName, "remoteAddrForwarded")));
writer.write(" ");
writer.write("");
writer.print(filter(mBeanServer.getAttribute
(pName, "remoteAddr")));
writer.write(" ");
writer.write("");
writer.write(filter(mBeanServer.getAttribute
(pName, "virtualHost")));
writer.write(" ");
writer.write("");
if (showRequest) {
writer.write(filter(mBeanServer.getAttribute
(pName, "method")));
writer.write(" ");
writer.write(filter(mBeanServer.getAttribute
(pName, "currentUri")));
String queryString = (String) mBeanServer.getAttribute
(pName, "currentQueryString");
if ((queryString != null) && (!queryString.equals(""))) {
writer.write("?");
writer.print(RequestUtil.filter(queryString));
}
writer.write(" ");
writer.write(filter(mBeanServer.getAttribute
(pName, "protocol")));
} else {
writer.write("?");
}
writer.write(" ");
} else {
writer.write("? ? ? ? ? ? ");
}
} else if (mode == 1){
writer.write(" hostsON = mBeanServer.queryNames(queryHosts, null);
// Navigation menu
writer.print("");
writer.print("Application list");
writer.print("
");
writer.print("");
int count = 0;
Iterator iterator = hostsON.iterator();
while (iterator.hasNext()) {
ObjectName contextON = iterator.next();
String webModuleName = contextON.getKeyProperty("name");
if (webModuleName.startsWith("//")) {
webModuleName = webModuleName.substring(2);
}
int slash = webModuleName.indexOf('/');
if (slash == -1) {
count++;
continue;
}
writer.print("");
writer.print(filter(webModuleName));
writer.print("");
if (iterator.hasNext()) {
writer.print("
");
}
}
writer.print("
");
// Webapp list
count = 0;
iterator = hostsON.iterator();
while (iterator.hasNext()) {
ObjectName contextON = iterator.next();
writer.print("");
writeContext(writer, contextON, mBeanServer, mode);
}
} else if (mode == 1){
// for now we don't write out the Detailed state in XML
}
}
/**
* Write context state.
*/
protected static void writeContext(PrintWriter writer,
ObjectName objectName,
MBeanServer mBeanServer, int mode)
throws Exception {
if (mode == 0){
String webModuleName = objectName.getKeyProperty("name");
String name = webModuleName;
if (name == null) {
return;
}
String hostName = null;
String contextName = null;
if (name.startsWith("//")) {
name = name.substring(2);
}
int slash = name.indexOf('/');
if (slash != -1) {
hostName = name.substring(0, slash);
contextName = name.substring(slash);
} else {
return;
}
ObjectName queryManager = new ObjectName
(objectName.getDomain() + ":type=Manager,context=" + contextName
+ ",host=" + hostName + ",*");
Set managersON =
mBeanServer.queryNames(queryManager, null);
ObjectName managerON = null;
Iterator iterator2 = managersON.iterator();
while (iterator2.hasNext()) {
managerON = iterator2.next();
}
ObjectName queryJspMonitor = new ObjectName
(objectName.getDomain() + ":type=JspMonitor,WebModule=" +
webModuleName + ",*");
Set jspMonitorONs =
mBeanServer.queryNames(queryJspMonitor, null);
// Special case for the root context
if (contextName.equals("/")) {
contextName = "";
}
writer.print("");
writer.print(filter(name));
writer.print("
");
writer.print(" ");
writer.print("");
Object startTime = mBeanServer.getAttribute(objectName,
"startTime");
writer.print(" Start time: " +
new Date(((Long) startTime).longValue()));
writer.print(" Startup time: ");
writer.print(formatTime(mBeanServer.getAttribute
(objectName, "startupTime"), false));
writer.print(" TLD scan time: ");
writer.print(formatTime(mBeanServer.getAttribute
(objectName, "tldScanTime"), false));
if (managerON != null) {
writeManager(writer, managerON, mBeanServer, mode);
}
if (jspMonitorONs != null) {
writeJspMonitor(writer, jspMonitorONs, mBeanServer, mode);
}
writer.print("
");
String onStr = objectName.getDomain()
+ ":j2eeType=Servlet,WebModule=" + webModuleName + ",*";
ObjectName servletObjectName = new ObjectName(onStr);
Set set =
mBeanServer.queryMBeans(servletObjectName, null);
Iterator iterator = set.iterator();
while (iterator.hasNext()) {
ObjectInstance oi = iterator.next();
writeWrapper(writer, oi.getObjectName(), mBeanServer, mode);
}
} else if (mode == 1){
// for now we don't write out the context in XML
}
}
/**
* Write detailed information about a manager.
*/
public static void writeManager(PrintWriter writer, ObjectName objectName,
MBeanServer mBeanServer, int mode)
throws Exception {
if (mode == 0) {
writer.print("
");
writer.print(" Active sessions: ");
writer.print(mBeanServer.getAttribute
(objectName, "activeSessions"));
writer.print(" Session count: ");
writer.print(mBeanServer.getAttribute
(objectName, "sessionCounter"));
writer.print(" Max active sessions: ");
writer.print(mBeanServer.getAttribute(objectName, "maxActive"));
writer.print(" Rejected session creations: ");
writer.print(mBeanServer.getAttribute
(objectName, "rejectedSessions"));
writer.print(" Expired sessions: ");
writer.print(mBeanServer.getAttribute
(objectName, "expiredSessions"));
writer.print(" Longest session alive time: ");
writer.print(formatSeconds(mBeanServer.getAttribute(
objectName,
"sessionMaxAliveTime")));
writer.print(" Average session alive time: ");
writer.print(formatSeconds(mBeanServer.getAttribute(
objectName,
"sessionAverageAliveTime")));
writer.print(" Processing time: ");
writer.print(formatTime(mBeanServer.getAttribute
(objectName, "processingTime"), false));
} else if (mode == 1) {
// for now we don't write out the wrapper details
}
}
/**
* Write JSP monitoring information.
*/
public static void writeJspMonitor(PrintWriter writer,
Set jspMonitorONs,
MBeanServer mBeanServer,
int mode)
throws Exception {
int jspCount = 0;
int jspReloadCount = 0;
Iterator iter = jspMonitorONs.iterator();
while (iter.hasNext()) {
ObjectName jspMonitorON = iter.next();
Object obj = mBeanServer.getAttribute(jspMonitorON, "jspCount");
jspCount += ((Integer) obj).intValue();
obj = mBeanServer.getAttribute(jspMonitorON, "jspReloadCount");
jspReloadCount += ((Integer) obj).intValue();
}
if (mode == 0) {
writer.print("
");
writer.print(" JSPs loaded: ");
writer.print(jspCount);
writer.print(" JSPs reloaded: ");
writer.print(jspReloadCount);
} else if (mode == 1) {
// for now we don't write out anything
}
}
/**
* Write detailed information about a wrapper.
*/
public static void writeWrapper(PrintWriter writer, ObjectName objectName,
MBeanServer mBeanServer, int mode)
throws Exception {
if (mode == 0) {
String servletName = objectName.getKeyProperty("name");
String[] mappings = (String[])
mBeanServer.invoke(objectName, "findMappings", null, null);
writer.print("");
writer.print(filter(servletName));
if ((mappings != null) && (mappings.length > 0)) {
writer.print(" [ ");
for (int i = 0; i < mappings.length; i++) {
writer.print(filter(mappings[i]));
if (i < mappings.length - 1) {
writer.print(" , ");
}
}
writer.print(" ] ");
}
writer.print("
");
writer.print("");
writer.print(" Processing time: ");
writer.print(formatTime(mBeanServer.getAttribute
(objectName, "processingTime"), true));
writer.print(" Max time: ");
writer.print(formatTime(mBeanServer.getAttribute
(objectName, "maxTime"), false));
writer.print(" Request count: ");
writer.print(mBeanServer.getAttribute(objectName, "requestCount"));
writer.print(" Error count: ");
writer.print(mBeanServer.getAttribute(objectName, "errorCount"));
writer.print(" Load time: ");
writer.print(formatTime(mBeanServer.getAttribute
(objectName, "loadTime"), false));
writer.print(" Classloading time: ");
writer.print(formatTime(mBeanServer.getAttribute
(objectName, "classLoadTime"), false));
writer.print("
");
} else if (mode == 1){
// for now we don't write out the wrapper details
}
}
/**
* Filter the specified message string for characters that are sensitive
* in HTML. This avoids potential attacks caused by including JavaScript
* codes in the request URL that is often reported in error messages.
*
* @param obj The message string to be filtered
*/
public static String filter(Object obj) {
if (obj == null)
return ("?");
String message = obj.toString();
char content[] = new char[message.length()];
message.getChars(0, message.length(), content, 0);
StringBuilder result = new StringBuilder(content.length + 50);
for (int i = 0; i < content.length; i++) {
switch (content[i]) {
case '<':
result.append("<");
break;
case '>':
result.append(">");
break;
case '&':
result.append("&");
break;
case '"':
result.append(""");
break;
default:
result.append(content[i]);
}
}
return (result.toString());
}
/**
* Escape the 5 entities defined by XML.
* @param s The message string to be filtered
* @return filtered XML content
*/
public static String filterXml(String s) {
if (s == null)
return "";
StringBuilder sb = new StringBuilder();
for (int i = 0; i < s.length(); i++) {
char c = s.charAt(i);
if (c == '<') {
sb.append("<");
} else if (c == '>') {
sb.append(">");
} else if (c == '\'') {
sb.append("'");
} else if (c == '&') {
sb.append("&");
} else if (c == '"') {
sb.append(""");
} else {
sb.append(c);
}
}
return sb.toString();
}
/**
* Display the given size in bytes, either as KB or MB.
*
* @param mb true to display megabytes, false for kilobytes
*/
public static String formatSize(Object obj, boolean mb) {
long bytes = -1L;
if (obj instanceof Long) {
bytes = ((Long) obj).longValue();
} else if (obj instanceof Integer) {
bytes = ((Integer) obj).intValue();
}
if (mb) {
StringBuilder buff = new StringBuilder();
if (bytes < 0) {
buff.append('-');
bytes = -bytes;
}
long mbytes = bytes / (1024 * 1024);
long rest =
((bytes - (mbytes * (1024 * 1024))) * 100) / (1024 * 1024);
buff.append(mbytes).append('.');
if (rest < 10) {
buff.append('0');
}
buff.append(rest).append(" MB");
return buff.toString();
} else {
return ((bytes / 1024) + " KB");
}
}
/**
* Display the given time in ms, either as ms or s.
*
* @param seconds true to display seconds, false for milliseconds
*/
public static String formatTime(Object obj, boolean seconds) {
long time = -1L;
if (obj instanceof Long) {
time = ((Long) obj).longValue();
} else if (obj instanceof Integer) {
time = ((Integer) obj).intValue();
}
if (seconds) {
return ((((float) time ) / 1000) + " s");
} else {
return (time + " ms");
}
}
/**
* Formats the given time (given in seconds) as a string.
*
* @param obj Time object to be formatted as string
*
* @return String formatted time
*/
public static String formatSeconds(Object obj) {
long time = -1L;
if (obj instanceof Long) {
time = ((Long) obj).longValue();
} else if (obj instanceof Integer) {
time = ((Integer) obj).intValue();
}
return (time + " s");
}
}