WebEnv.java
| Index Score | ||
|---|---|---|
 |
 |
org.compiere.util |
 |
 |
Compiere |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| EXITS | Procedure exits | |
| LOOPS | Number of loops | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| EXEC_COMMENTS | Comments in executable code | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERANDS | Number of unique operands | |
| DECL_COMMENTS | Comments in declarations | |
| COMPARISONS | Number of comparison operators | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOGICAL_LINES | Number of statements | |
| SIZE | Size of the file in bytes | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| LINES | Number of lines in the source file | |
| LINE_COMMENT | Number of line comments | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| COMMENTS | Comment lines | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0003 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
/******************************************************************************
* Product: Compiere ERP & CRM Smart Business Solution *
* Copyright (C) 1999-2007 ComPiere, Inc. All Rights Reserved. *
* This program is free software, you can redistribute it and/or modify it *
* under the terms version 2 of the GNU General Public License as published *
* by the Free Software Foundation. This program is distributed in the hope *
* that it will be useful, but WITHOUT ANY WARRANTY, without even the implied *
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. *
* See the GNU General Public License for more details. *
* You should have received a copy of the GNU General Public License along *
* with this program, if not, write to the Free Software Foundation, Inc., *
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *
* For the text or an alternative of this public license, you may reach us *
* ComPiere, Inc., 3600 Bridge Parkway #102, Redwood City, CA 94065, USA *
* or via info@compiere.org or http://www.compiere.org/license.html *
*****************************************************************************/
package org.compiere.util;
import java.sql.*;
import java.util.*;
import java.util.logging.*;
import javax.servlet.*;
import javax.servlet.http.*;
import org.apache.ecs.*;
import org.apache.ecs.xhtml.*;
import org.compiere.*;
import org.compiere.model.*;
/**
* Web Environment and debugging
*
* @author Jorg Janke
* @version $Id: WebEnv.java,v 1.2 2006/07/30 00:51:05 jjanke Exp $
*/
public class WebEnv
{
/** Add HTML Debug Info */
public static final boolean DEBUG = true;
/** Logging */
private static CLogger log = CLogger.getCLogger(WebEnv.class);
/**
* Base Directory links <b>http://localhost:8080/compiere</b>
* to the physical <i>%COMPIERE_HOME%/tomcat/webroot/compiere</i> directory
*/
public static final String DIR_BASE = "/compiere"; // /compiere
/** Image Sub-Directory under BASE */
private static final String DIR_IMAGE = "images"; // /compiere/images
/** Stylesheet Name */
private static final String STYLE_STD = "standard.css"; // /compiere/standard.css
/** Small Logo.
/** Removing/modifying the Compiere logo is a violation of the license */
private static final String LOGO = "LogoSmall.gif"; // /compiere/LogoSmall.gif
/** Store Sub-Directory under BASE */
private static final String DIR_STORE = "store"; // /compiere/store
/** Frame name for Commands - WCmd */
public static final String TARGET_CMD = "WCmd";
/** Frame name for Menu - WMenu */
public static final String TARGET_MENU = "WMenu";
/** Frame name for Apps Window - WWindow */
public static final String TARGET_WINDOW = "WWindow";
/** Frame name for Apps PopUp - WPopUp */
public static final String TARGET_POPUP = "WPopUp";
/** Character Set (iso-8859-1 - utf-8) */
public static final String CHARSET = "UTF-8"; // Default: UNKNOWN
/** Encoding (ISO-8859-1 - UTF-8) */
public static final String ENCODING = "UTF-8";
/** Cookie Name */
public static final String COOKIE_INFO = "CompiereInfo";
/** Timeout - 15 Minutes */
public static final int TIMEOUT = 15*60;
/** Initialization OK? */
private static boolean s_initOK = false;
/** Not Braking Space */
public static final String NBSP = " ";
/**
* Init Web Environment.
* To be called from every Servlet in the init method
* or any other Web resource to make sure that the
* environment is properly set.
* @param config config
* @return false if initialization problems
*/
public static boolean initWeb (ServletConfig config)
{
if (s_initOK)
{
log.info(config.getServletName());
return true;
}
Enumeration<?> en = config.getInitParameterNames();
StringBuffer info2 = new StringBuffer("Servlet Init Parameter: ")
.append(config.getServletName());
while (en.hasMoreElements())
{
String name = en.nextElement().toString();
String value = config.getInitParameter(name);
System.setProperty(name, value);
info2.append("\n").append(name).append("=").append(value);
}
boolean retValue = initWeb (config.getServletContext(), config.getServletName());
// Logging now initiated
log.info(info2.toString());
return retValue;
} // initWeb
/**
* Init Web.
* Only call directly for Filters, etc.
* @param context servlet context
* @return false if initialization problems
*/
public static boolean initWeb (ServletContext context, String info)
{
if (s_initOK)
{
log.info(context.getServletContextName());
return true;
}
// Load Environment Variables (serverApps/src/web/WEB-INF/web.xml)
Enumeration<?> en = context.getInitParameterNames();
StringBuffer info2 = new StringBuffer("Servlet Context Init Parameters: ")
.append(context.getServletContextName());
while (en.hasMoreElements())
{
String name = en.nextElement().toString();
String value = context.getInitParameter(name);
System.setProperty(name, value);
info2.append("\n").append(name).append("=").append(value);
}
try
{
s_initOK = Compiere.startup(false, info);
}
catch (Exception ex)
{
log.log(Level.SEVERE, "startup", ex);
}
if (!s_initOK)
return false;
// Logging now initiated
log.info(info2.toString());
//
Ctx ctx = new Ctx();
MClient client = MClient.get(ctx, 0);
MSystem system = MSystem.get(ctx);
client.sendEMail(client.getRequestEMail(), client.getName(),
"Server started: " + system.getName(),
"ServerInfo: " + context.getServerInfo(), null);
return s_initOK;
} // initWeb
/**************************************************************************
* Get Base Directory entry.
* <br>
* /compiere/
* @param entry file entry or path
* @return url to entry in base directory
*/
public static String getBaseDirectory (String entry)
{
StringBuffer sb = new StringBuffer (DIR_BASE);
if (!entry.startsWith("/"))
sb.append("/");
sb.append(entry);
return sb.toString();
} // getBaseDirectory
/**
* Get Image Directory entry.
* <br>
* /compiere/images
* @param entry file entry or path
* @return url to entry in image directory
*/
public static String getImageDirectory(String entry)
{
StringBuffer sb = new StringBuffer (DIR_BASE);
sb.append("/").append(DIR_IMAGE);
if (!entry.startsWith("/"))
sb.append("/");
sb.append(entry);
return sb.toString();
} // getImageDirectory
/**
* Get Store Directory entry.
* <br>
* /compiere/store
* @param entry file entry or path
* @return url to entry in store directory
*/
public static String getStoreDirectory(String entry)
{
StringBuffer sb = new StringBuffer (DIR_BASE);
sb.append("/").append(DIR_STORE);
if (!entry.startsWith("/"))
sb.append("/");
sb.append(entry);
return sb.toString();
} // getStoreDirectory
/**
* Get Logo Path.
* Removing/modifying the Compiere logo is a violation of the license
* <p>
* /compiere/LogoSmall.gif
* @return url to logo
*/
public static String getLogoURL()
{
return getBaseDirectory(LOGO);
} // getLogoPath
/**
* Get Logo Image HTML tag.
* Removing/modifying the Compiere logo or copyright notice is a violation of the license
* @return Image
*/
public static img getLogo()
{
/** Removing/modifying the Compiere logo is a violation of the license */
return new img(getLogoURL()).setAlign(AlignType.RIGHT)
// Changing the copyright notice in any way violates the license
// and you'll be held liable for any damage claims
.setAlt("© Jorg Janke/Compiere");
} // getLogo
/**
* Get Stylesheet Path.
* <p>
* /compiere/standard.css
* @return url of Stylesheet
*/
public static String getStylesheetURL()
{
return getBaseDirectory(STYLE_STD);
} // getStylesheetURL
/**
* Get Cell Content
* @param content optional content
* @return string content or non breaking space
*/
public static String getCellContent (Object content)
{
if (content == null)
return NBSP;
String str = content.toString();
if (str.length() == 0)
return NBSP;
return str;
} // getCellContent
/**
* Get Cell Content
* @param content optional content
* @return string content
*/
public static String getCellContent (int content)
{
return String.valueOf(content);
} // getCellContent
/**************************************************************************
* Dump Servlet Config
* @param config config
*/
public static void dump (ServletConfig config)
{
log.config("ServletConfig " + config.getServletName());
log.config("- Context=" + config.getServletContext());
if (!CLogMgt.isLevelFiner())
return;
boolean first = true;
Enumeration<?> e = config.getInitParameterNames();
while (e.hasMoreElements())
{
if (first)
log.finer("InitParameter:");
first = false;
String key = (String)e.nextElement();
Object value = config.getInitParameter(key);
log.finer("- " + key + " = " + value);
}
} // dump (ServletConfig)
/**
* Dump Session
* @param ctx servlet context
*/
public static void dump (ServletContext ctx)
{
log.config("ServletContext " + ctx.getServletContextName());
log.config("- ServerInfo=" + ctx.getServerInfo());
if (!CLogMgt.isLevelFiner())
return;
boolean first = true;
Enumeration<?> e = ctx.getInitParameterNames();
while (e.hasMoreElements())
{
if (first)
log.finer("InitParameter:");
first = false;
String key = (String)e.nextElement();
Object value = ctx.getInitParameter(key);
log.finer("- " + key + " = " + value);
}
first = true;
e = ctx.getAttributeNames();
while (e.hasMoreElements())
{
if (first)
log.finer("Attributes:");
first = false;
String key = (String)e.nextElement();
Object value = ctx.getAttribute(key);
log.finer("- " + key + " = " + value);
}
} // dump
/**
* Dump Session
* @param session session
*/
public static void dump (HttpSession session)
{
log.config("Session " + session.getId());
log.config("- Created=" + new Timestamp(session.getCreationTime()));
if (!CLogMgt.isLevelFiner())
return;
boolean first = true;
Enumeration<?> e = session.getAttributeNames();
while (e.hasMoreElements())
{
if (first)
log.finer("Attributes:");
first = false;
String key = (String)e.nextElement();
Object value = session.getAttribute(key);
log.finer("- " + key + " = " + value);
}
} // dump (session)
/**
* Dump Request
* @param request request
*/
public static void dump (HttpServletRequest request)
{
log.config("Request " + request.getProtocol() + " " + request.getMethod());
if (!CLogMgt.isLevelFiner())
return;
log.finer("- Server=" + request.getServerName() + ", Port=" + request.getServerPort());
log.finer("- ContextPath=" + request.getContextPath()
+ ", ServletPath=" + request.getServletPath()
+ ", Query=" + request.getQueryString());
log.finer("- From " + request.getRemoteHost() + "/" + request.getRemoteAddr()
// + ":" + request.getRemotePort()
+ " - User=" + request.getRemoteUser());
log.finer("- URI=" + request.getRequestURI() + ", URL=" + request.getRequestURL());
log.finer("- AuthType=" + request.getAuthType());
log.finer("- Secure=" + request.isSecure());
log.finer("- PathInfo=" + request.getPathInfo() + " - " + request.getPathTranslated());
log.finer("- UserPrincipal=" + request.getUserPrincipal());
//
boolean first = true;
Enumeration<?> e = request.getHeaderNames();
/** Header Names */
while (e.hasMoreElements())
{
if (first)
log.finer("- Header:");
first = false;
String key = (String)e.nextElement();
Object value = request.getHeader(key);
log.finer(" - " + key + " = " + value);
}
/** **/
first = true;
/** Parameter */
try
{
String enc = request.getCharacterEncoding();
if (enc == null)
request.setCharacterEncoding(WebEnv.ENCODING);
}
catch (Exception ee)
{
log.log(Level.SEVERE, "Set CharacterEncoding=" + WebEnv.ENCODING, ee);
}
e = request.getParameterNames();
while (e.hasMoreElements())
{
if (first)
log.finer("- Parameter:");
first = false;
String key = (String)e.nextElement();
String value = WebUtil.getParameter (request, key);
log.finer(" - " + key + " = " + value);
}
first = true;
/** Attributes */
e = request.getAttributeNames();
while (e.hasMoreElements())
{
if (first)
log.finer("- Attributes:");
first = false;
String key = (String)e.nextElement();
Object value = request.getAttribute(key);
log.finer(" - " + key + " = " + value);
}
/** Cookies */
Cookie[] ccc = request.getCookies();
if (ccc != null)
{
for (int i = 0; i < ccc.length; i++)
{
if (i == 0)
log.finer("- Cookies:");
log.finer (" - " + ccc[i].getName ()
+ ", Domain=" + ccc[i].getDomain ()
+ ", Path=" + ccc[i].getPath ()
+ ", MaxAge=" + ccc[i].getMaxAge ());
}
}
log.finer("- Encoding=" + request.getCharacterEncoding());
log.finer("- Locale=" + request.getLocale());
first = true;
e = request.getLocales();
while (e.hasMoreElements())
{
if (first)
log.finer("- Locales:");
first = false;
log.finer(" - " + e.nextElement());
}
log.finer("- Class=" + request.getClass().getName());
} // dump (Request)
/**************************************************************************
* Add Footer (with diagnostics)
* @param request request
* @param response response
* @param servlet servlet
* @param body - Body to add footer
*/
public static void addFooter(HttpServletRequest request, HttpServletResponse response,
HttpServlet servlet, body body)
{
body.addElement(new hr());
body.addElement(new comment(" --- Footer Start --- "));
// Command Line
p footer = new p();
footer.addElement(org.compiere.Compiere.DATE_VERSION + ": ");
footer.addElement(new a("javascript:diag_window();", "Window Info"));
footer.addElement(" - ");
footer.addElement(new a("javascript:diag_navigator();", "Browser Info"));
footer.addElement(" - ");
footer.addElement(new a("javascript:diag_request();", "Request Info"));
footer.addElement(" - ");
footer.addElement(new a("javascript:diag_document();", "Document Info"));
footer.addElement(" - ");
footer.addElement(new a("javascript:diag_form();", "Form Info"));
footer.addElement(" - ");
footer.addElement(new a("javascript:toggle('DEBUG');", "Servlet Info"));
footer.addElement(" - ");
footer.addElement(new a("javascript:diag_source();", "Show Source"));
footer.addElement("\n");
body.addElement(footer);
// Add ServletInfo
body.addElement(new br());
body.addElement(getServletInfo(request, response, servlet));
body.addElement(new script("hide('DEBUG');"));
body.addElement(new comment(" --- Footer End --- "));
} // getFooter
/**
* Get Information and put it in a HTML table
* @param request request
* @param response response
* @param servlet servlet
* @return Table
*/
private static table getServletInfo (HttpServletRequest request,
HttpServletResponse response, HttpServlet servlet)
{
table table = new table();
table.setID("DEBUG");
Enumeration<?> e;
tr space = new tr().addElement(new td().addElement("."));
// Request Info
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Request Info")) ));
table.addElement(new tr().addElement(new td().addElement("Method"))
.addElement(new td().addElement(request.getMethod() )));
table.addElement(new tr().addElement(new td().addElement("Protocol"))
.addElement(new td().addElement(request.getProtocol() )));
table.addElement(new tr().addElement(new td().addElement("URI"))
.addElement(new td().addElement(request.getRequestURI() )));
table.addElement(new tr().addElement(new td().addElement("Context Path"))
.addElement(new td().addElement(request.getContextPath() )));
table.addElement(new tr().addElement(new td().addElement("Servlet Path"))
.addElement(new td().addElement(request.getServletPath() )));
table.addElement(new tr().addElement(new td().addElement("Path Info"))
.addElement(new td().addElement(request.getPathInfo() )));
table.addElement(new tr().addElement(new td().addElement("Path Translated"))
.addElement(new td().addElement(request.getPathTranslated() )));
table.addElement(new tr().addElement(new td().addElement("Query String"))
.addElement(new td().addElement(request.getQueryString() )));
table.addElement(new tr().addElement(new td().addElement("Content Length"))
.addElement(new td().addElement("" + request.getContentLength() )));
table.addElement(new tr().addElement(new td().addElement("Content Type"))
.addElement(new td().addElement(request.getContentType() )));
table.addElement(new tr().addElement(new td().addElement("Character Encoding"))
.addElement(new td().addElement(request.getCharacterEncoding() )));
table.addElement(new tr().addElement(new td().addElement("Locale"))
.addElement(new td().addElement(request.getLocale().toString() )));
table.addElement(new tr().addElement(new td().addElement("Schema"))
.addElement(new td().addElement(request.getScheme() )));
table.addElement(new tr().addElement(new td().addElement("Server Name"))
.addElement(new td().addElement(request.getServerName() )));
table.addElement(new tr().addElement(new td().addElement("Server Port"))
.addElement(new td().addElement("" + request.getServerPort() )));
table.addElement(new tr().addElement(new td().addElement("Remote User"))
.addElement(new td().addElement(request.getRemoteUser() )));
table.addElement(new tr().addElement(new td().addElement("Remote Address"))
.addElement(new td().addElement(request.getRemoteAddr() )));
table.addElement(new tr().addElement(new td().addElement("Remote Host"))
.addElement(new td().addElement(request.getRemoteHost() )));
table.addElement(new tr().addElement(new td().addElement("Authorization Type"))
.addElement(new td().addElement(request.getAuthType() )));
table.addElement(new tr().addElement(new td().addElement("User Principal"))
.addElement(new td().addElement(request.getUserPrincipal()==null ? "" : request.getUserPrincipal().toString())));
table.addElement(new tr().addElement(new td().addElement("IsSecure"))
.addElement(new td().addElement(request.isSecure() ? "true" : "false" )));
// Request Attributes
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Request Attributes")) ));
e = request.getAttributeNames();
while (e.hasMoreElements())
{
String name = e.nextElement().toString();
String attrib = request.getAttribute(name).toString();
table.addElement(new tr().addElement(new td().addElement(name))
.addElement(new td().addElement(attrib)));
}
// Request Parameter
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Req Parameters")) ));
try
{
String enc = request.getCharacterEncoding();
if (enc == null)
request.setCharacterEncoding(WebEnv.ENCODING);
}
catch (Exception ee)
{
log.log(Level.SEVERE, "Set CharacterEncoding=" + WebEnv.ENCODING, ee);
}
e = request.getParameterNames();
while (e.hasMoreElements())
{
String name = (String)e.nextElement();
String para = WebUtil.getParameter (request, name);
table.addElement(new tr().addElement(new td().addElement(name))
.addElement(new td().addElement(para)));
}
// Request Header
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Req Header")) ));
e = request.getHeaderNames();
while (e.hasMoreElements())
{
String name = (String)e.nextElement();
if (!name.equals("Cockie"))
{
String hdr = request.getHeader(name);
table.addElement(new tr().addElement(new td().addElement(name))
.addElement(new td().addElement(hdr)));
}
}
// Request Cookies
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Req Cookies")) ));
Cookie[] cc = request.getCookies();
if (cc != null)
{
for (int i = 0; i < cc.length; i++)
{
// Name and Comment
table.addElement(new tr().addElement(new td().addElement(cc[i].getName() ))
.addElement(new td().addElement(cc[i].getValue()) ));
table.addElement(new tr().addElement(new td().addElement(cc[i].getName()+": Comment" ))
.addElement(new td().addElement(cc[i].getComment()) ));
table.addElement(new tr().addElement(new td().addElement(cc[i].getName()+": Domain" ))
.addElement(new td().addElement(cc[i].getDomain()) ));
table.addElement(new tr().addElement(new td().addElement(cc[i].getName()+": Max Age" ))
.addElement(new td().addElement(""+ cc[i].getMaxAge()) ));
table.addElement(new tr().addElement(new td().addElement(cc[i].getName()+": Path" ))
.addElement(new td().addElement(cc[i].getPath()) ));
table.addElement(new tr().addElement(new td().addElement(cc[i].getName()+": Is Secure" ))
.addElement(new td().addElement(cc[i].getSecure() ? "true" : "false") ));
table.addElement(new tr().addElement(new td().addElement(cc[i].getName()+": Version" ))
.addElement(new td().addElement("" + cc[i].getVersion()) ));
}
} // Cookies
// Request Session Info
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Req Session")) ));
HttpSession session = request.getSession(true);
table.addElement(new tr().addElement(new td().addElement("Session ID"))
.addElement(new td().addElement(session.getId() )));
Timestamp ts = new Timestamp(session.getCreationTime());
table.addElement(new tr().addElement(new td().addElement("Created"))
.addElement(new td().addElement(ts.toString() )));
ts = new Timestamp(session.getLastAccessedTime());
table.addElement(new tr().addElement(new td().addElement("Accessed"))
.addElement(new td().addElement(ts.toString() )));
table.addElement(new tr().addElement(new td().addElement("Request Session ID"))
.addElement(new td().addElement(request.getRequestedSessionId() )));
table.addElement(new tr().addElement(new td().addElement(".. via Cookie"))
.addElement(new td().addElement("" + request.isRequestedSessionIdFromCookie() )));
table.addElement(new tr().addElement(new td().addElement(".. via URL"))
.addElement(new td().addElement("" + request.isRequestedSessionIdFromURL() )));
table.addElement(new tr().addElement(new td().addElement("Valid"))
.addElement(new td().addElement("" + request.isRequestedSessionIdValid() )));
// Request Session Attributes
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Session Attributes")) ));
e = session.getAttributeNames();
while (e.hasMoreElements())
{
String name = (String)e.nextElement();
String attrib = session.getAttribute(name).toString();
table.addElement(new tr().addElement(new td().addElement(name))
.addElement(new td().addElement(attrib)));
}
// Response Info
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Response")) ));
table.addElement(new tr().addElement(new td().addElement("Buffer Size"))
.addElement(new td().addElement(String.valueOf(response.getBufferSize()) )));
table.addElement(new tr().addElement(new td().addElement("Character Encoding"))
.addElement(new td().addElement(response.getCharacterEncoding() )));
table.addElement(new tr().addElement(new td().addElement("Locale"))
.addElement(new td().addElement(response.getLocale()==null ? "null" : response.getLocale().toString())));
// Servlet
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Servlet")) ));
table.addElement(new tr().addElement(new td().addElement("Name"))
.addElement(new td().addElement(servlet.getServletName())));
table.addElement(new tr().addElement(new td().addElement("Info"))
.addElement(new td().addElement(servlet.getServletInfo())));
// Servlet Init
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Servlet Init Parameter")) ));
e = servlet.getInitParameterNames();
// same as: servlet.getServletConfig().getInitParameterNames();
while (e.hasMoreElements())
{
String name = (String)e.nextElement();
String para = servlet.getInitParameter(name);
table.addElement(new tr().addElement(new td().addElement(name))
.addElement(new td().addElement(para)));
}
// Servlet Context
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Servlet Context")) ));
ServletContext servCtx = servlet.getServletContext();
e = servCtx.getAttributeNames();
while (e.hasMoreElements())
{
String name = (String)e.nextElement();
String attrib = servCtx.getAttribute(name).toString();
table.addElement(new tr().addElement(new td().addElement(name))
.addElement(new td().addElement(attrib)));
}
// Servlet Context
table.addElement(space);
table.addElement(new tr().addElement(new td().addElement(new h3("Servlet Context Init Parameter")) ));
e = servCtx.getInitParameterNames();
while (e.hasMoreElements())
{
String name = (String)e.nextElement();
String attrib = servCtx.getInitParameter(name).toString();
table.addElement(new tr().addElement(new td().addElement(name))
.addElement(new td().addElement(attrib)));
}
/* */
return table;
} // getServletInfo
} // WEnv
The table below shows all metrics for WebEnv.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 46.00 | Number of blocks | |
| BLOCK_COMMENT | 1.00 | Number of block comment lines | |
| COMMENTS | 167.00 | Comment lines | |
| COMMENT_DENSITY | 0.39 | Comment density | |
| COMPARISONS | 85.00 | Number of comparison operators | |
| CYCLOMATIC | 68.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 35.00 | Comments in declarations | |
| DOC_COMMENT | 142.00 | Number of javadoc comment lines | |
| ELOC | 433.00 | Effective lines of code | |
| EXEC_COMMENTS | 30.00 | Comments in executable code | |
| EXITS | 142.00 | Procedure exits | |
| FUNCTIONS | 16.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 78.13 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 44.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 1.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 1.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 21.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 2.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1713.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 3.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 1.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 1.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 726.00 | Number of lines in the source file | |
| LINE_COMMENT | 24.00 | Number of line comments | |
| LOC | 509.00 | Lines of code | |
| LOGICAL_LINES | 291.00 | Number of statements | |
| LOOPS | 19.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 1750.00 | Number of operands | |
| OPERATORS | 3454.00 | Number of operators | |
| PARAMS | 19.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 5204.00 | Halstead program length | |
| PROGRAM_VOCAB | 488.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 25.00 | Number of return points from functions | |
| SIZE | 26987.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 448.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 40.00 | Number of unique operators | |
| WHITESPACE | 50.00 | Number of whitespace lines | |