FileUploadServlet.java
| Index Score | ||
|---|---|---|
 |
 |
com.zimbra.cs.service |
 |
 |
Zimbra Collaboration Suite |
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 | |
| EXEC_COMMENTS | Comments in executable code | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| COMPARISONS | Number of comparison operators | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| CYCLOMATIC | Cyclomatic complexity | |
| OPERATORS | Number of operators | |
| LOGICAL_LINES | Number of statements | |
| SIZE | Size of the file in bytes | |
| LINE_COMMENT | Number of line comments | |
| ELOC | Effective lines of code | |
| RETURNS | Number of return points from functions | |
| LOC | Lines of code | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| UNIQUE_OPERATORS | Number of unique operators | |
| BLOCKS | Number of blocks | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0008 | JAVA0008 Empty catch block | |
| LINES | Number of lines in the source file | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0043 | JAVA0043 Inner class does not use outer class | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0067 | JAVA0067 Array descriptor on identifier name | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| COMMENTS | Comment lines | |
/*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 ("License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.zimbra.com/license
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is: Zimbra Collaboration Suite Server.
*
* The Initial Developer of the Original Code is Zimbra, Inc.
* Portions created by Zimbra are Copyright (C) 2004, 2005, 2006 Zimbra, Inc.
* All Rights Reserved.
*
* Contributor(s):
*
* ***** END LICENSE BLOCK *****
*/
package com.zimbra.cs.service;
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.TimerTask;
import javax.mail.MessagingException;
import javax.mail.internet.ContentDisposition;
import javax.mail.internet.MimeUtility;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.fileupload.DefaultFileItem;
import org.apache.commons.fileupload.DiskFileUpload;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadBase;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.httpclient.Cookie;
import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpException;
import org.apache.commons.httpclient.HttpState;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.httpclient.methods.GetMethod;
import com.zimbra.common.util.Log;
import com.zimbra.common.util.LogFactory;
import com.zimbra.cs.account.Account;
import com.zimbra.cs.account.AccountServiceException;
import com.zimbra.cs.account.AuthToken;
import com.zimbra.cs.account.Provisioning;
import com.zimbra.cs.account.Server;
import com.zimbra.cs.account.Provisioning.AccountBy;
import com.zimbra.cs.account.Provisioning.ServerBy;
import com.zimbra.cs.account.ldap.LdapUtil;
import com.zimbra.cs.mailbox.MailServiceException;
import com.zimbra.cs.mailbox.Mailbox;
import com.zimbra.cs.mailbox.MailboxManager;
import com.zimbra.cs.servlet.ZimbraServlet;
import com.zimbra.common.service.ServiceException;
import com.zimbra.common.util.ByteUtil;
import com.zimbra.common.util.Constants;
import com.zimbra.common.util.FileUtil;
import com.zimbra.common.util.ZimbraLog;
import com.zimbra.cs.util.Zimbra;
public class FileUploadServlet extends ZimbraServlet {
private static final long serialVersionUID = -3156986245375108467L;
/** The character separating upload IDs in a list */
public static final String UPLOAD_DELIMITER = ",";
/** The character separating server ID from upload ID */
private static final char UPLOAD_PART_DELIMITER = ':';
/** The length of a fully-qualified upload ID (2 UUIDs and a ':') */
private static final int UPLOAD_ID_LENGTH = 73;
public static final class Upload {
final String accountId;
final String uuid;
final String name;
final FileItem file;
long time;
Upload(String acctId, FileItem attachment) throws ServiceException {
this(acctId, attachment, attachment.getName());
}
Upload(String acctId, FileItem attachment, String filename) throws ServiceException {
String localServer = Provisioning.getInstance().getLocalServer().getId();
accountId = acctId;
time = System.currentTimeMillis();
uuid = localServer + UPLOAD_PART_DELIMITER + LdapUtil.generateUUID();
name = FileUtil.trimFilename(filename);
file = attachment;
}
public String getName() { return name; }
public String getContentType() { return file.getContentType(); }
public InputStream getInputStream() throws IOException {
return file.getInputStream();
}
boolean accessedAfter(long checkpoint) { return time > checkpoint; }
void purge() { if (file != null) file.delete(); }
public String toString() {
return "Upload: { accountId=" + accountId + ", time=" + new Date(time) +
", uploadId=" + uuid + ", " + (file == null ? "no file" : name) + "}";
}
}
static HashMap<String, Upload> mPending = new HashMap<String, Upload>(100);
static Log mLog = LogFactory.getLog(FileUploadServlet.class);
static final long DEFAULT_MAX_SIZE = 10 * 1024 * 1024;
/** Returns the zimbra id of the server the specified upload resides on.
*
* @param uploadId The id of the upload.
* @throws ServiceException if the upload id is malformed. */
static String getUploadServerId(String uploadId) throws ServiceException {
if (uploadId == null || uploadId.length() != UPLOAD_ID_LENGTH || uploadId.charAt(UPLOAD_ID_LENGTH / 2) != UPLOAD_PART_DELIMITER)
throw ServiceException.INVALID_REQUEST("invalid upload ID: " + uploadId, null);
return uploadId.substring(0, UPLOAD_ID_LENGTH / 2);
}
/** Returns whether the specified upload resides on this server.
*
* @param uploadId The id of the upload.
* @throws ServiceException if the upload id is malformed or if there is
* an error accessing LDAP. */
static boolean isLocalUpload(String uploadId) throws ServiceException {
String serverId = getUploadServerId(uploadId);
return Provisioning.getInstance().getLocalServer().getId().equals(serverId);
}
public static Upload fetchUpload(String accountId, String uploadId, String authtoken) throws ServiceException {
String context = "accountId=" + accountId + ", uploadId=" + uploadId;
if (accountId == null || uploadId == null)
throw ServiceException.FAILURE("fetchUploads(): missing parameter: " + context, null);
if (uploadId.length() != UPLOAD_ID_LENGTH || uploadId.charAt(UPLOAD_ID_LENGTH / 2) != UPLOAD_PART_DELIMITER)
throw ServiceException.INVALID_REQUEST("invalid upload ID: " + uploadId, null);
// if the upload is remote, fetch it from the other server
if (!isLocalUpload(uploadId))
return fetchRemoteUpload(accountId, uploadId, authtoken);
// the upload is local, so get it from the cache
synchronized (mPending) {
Upload up = mPending.get(uploadId);
if (up == null) {
mLog.warn("upload not found: " + context);
throw MailServiceException.NO_SUCH_UPLOAD(uploadId);
}
if (!accountId.equals(up.accountId)) {
mLog.warn("mismatched accountId for upload: " + up + "; expected: " + context);
throw MailServiceException.NO_SUCH_UPLOAD(uploadId);
}
up.time = System.currentTimeMillis();
return up;
}
}
private static Upload fetchRemoteUpload(String accountId, String uploadId, String authtoken) throws ServiceException {
// the first half of the upload id is the server id where it lives
Server server = Provisioning.getInstance().get(ServerBy.id, uploadId.substring(0, UPLOAD_ID_LENGTH / 2));
if (server == null)
return null;
// determine the URI for the remote ContentServlet
int port = server.getIntAttr(Provisioning.A_zimbraMailPort, 0);
boolean useHTTP = port > 0;
if (!useHTTP)
port = server.getIntAttr(Provisioning.A_zimbraMailSSLPort, 0);
if (port <= 0)
throw ServiceException.FAILURE("remote server " + server.getName() + " has neither http nor https port enabled", null);
String hostname = server.getAttr(Provisioning.A_zimbraServiceHostname);
String url;
try {
url = (useHTTP ? "http" : "https") + "://" + hostname + ':' + port +
ContentServlet.SERVLET_PATH + ContentServlet.PREFIX_PROXY + '?' +
ContentServlet.PARAM_UPLOAD_ID + '=' + URLEncoder.encode(uploadId, "UTF-8");
} catch (UnsupportedEncodingException e) {
throw ServiceException.FAILURE("fetchRemoteUpload(): unsupported encoding", e);
}
// create an HTTP client with auth cookie to fetch the file from the remote ContentServlet
HttpState state = new HttpState();
state.addCookie(new Cookie(hostname, ZimbraServlet.COOKIE_ZM_AUTH_TOKEN, authtoken, "/", null, false));
HttpClient client = new HttpClient();
client.setState(state);
GetMethod method = new GetMethod(url);
InputStream is = null;
try {
// fetch the remote item
int statusCode = client.executeMethod(method);
if (statusCode != HttpStatus.SC_OK)
return null;
// metadata is encoded in the response's HTTP headers
Header ctHeader = method.getResponseHeader("Content-Type");
String contentType = ctHeader == null ? "text/plain" : ctHeader.getValue();
Header cdispHeader = method.getResponseHeader("Content-Disposition");
String filename = cdispHeader == null ? "unknown" : new ContentDisposition(cdispHeader.getValue()).getParameter("filename");
if (filename != null && filename.indexOf("=?") != -1 && filename.indexOf("?=") != -1)
try {
filename = MimeUtility.decodeText(filename);
} catch (UnsupportedEncodingException uee) { }
// store the fetched file as a normal upload
DiskFileUpload upload = getUploader();
FileItem fi = upload.getFileItemFactory().createItem("upload", contentType, false, filename);
ByteUtil.copy(is = method.getResponseBodyAsStream(), false, fi.getOutputStream(), false);
return new Upload(accountId, fi);
} catch (HttpException e) {
throw ServiceException.PROXY_ERROR(e, url);
} catch (MessagingException e) {
throw ServiceException.PROXY_ERROR(e, url);
} catch (IOException e) {
throw ServiceException.FAILURE("can't fetch remote upload: " + uploadId, e);
} finally {
if (is != null)
try { is.close(); } catch (IOException e1) { }
method.releaseConnection();
}
}
public static void deleteUploads(List<Upload> uploads) {
if (uploads != null && !uploads.isEmpty())
for (Upload up : uploads)
deleteUpload(up);
}
public static void deleteUpload(Upload upload) {
if (upload == null)
return;
Upload up = null;
synchronized (mPending) {
up = mPending.remove(upload.uuid);
}
if (up == upload)
up.purge();
}
private static String getTempDirectory() {
return System.getProperty("java.io.tmpdir", "/tmp");
}
private static class TempFileFilter implements FileFilter {
private long mNow = System.currentTimeMillis();
/** Returns <code>true</code> if the specified <code>File</code>
* follows the {@link DefaultFileItem} naming convention
* (<code>upload_*.tmp</code>) and is older than
* {@link FileUploadServlet#UPLOAD_TIMEOUT_MSEC}. */
public boolean accept(File pathname) {
// upload_ XYZ .tmp
if (pathname == null)
return false;
String name = pathname.getName();
// file naming convention used by DefaultFileItem class
return name.startsWith("upload_") && name.endsWith(".tmp") &&
(mNow - pathname.lastModified() > UPLOAD_TIMEOUT_MSEC);
}
}
private static void cleanupLeftoverTempFiles() {
File files[] = new File(getTempDirectory()).listFiles(new TempFileFilter());
if (files == null || files.length < 1) return;
mLog.info("deleting " + files.length + " temporary upload files left over from last time");
for (int i = 0; i < files.length; i++) {
String path = files[i].getAbsolutePath();
if (files[i].delete())
mLog.info("deleted leftover upload file " + path);
else
mLog.error("unable to delete leftover upload file " + path);
}
}
public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException, ServletException {
int status = HttpServletResponse.SC_OK;
List<FileItem> items = null;
String attachmentId = null;
String reqId = null;
ZimbraLog.addIpToContext(req.getRemoteAddr());
do {
// file upload requires authentication
int adminPort = -1;
try {
adminPort = Provisioning.getInstance().getLocalServer().getIntAttr(Provisioning.A_zimbraAdminPort, -1);
} catch (ServiceException e) {
throw new ServletException(e);
}
boolean isAdminRequest = (req.getLocalPort() == adminPort);
AuthToken at = isAdminRequest ? getAdminAuthTokenFromCookie(req, resp, true) : getAuthTokenFromCookie(req, resp, true);
if (at == null) {
status = HttpServletResponse.SC_UNAUTHORIZED;
break;
}
if (!isAdminRequest) {
try {
// make sure we're on the right host; proxy if we're not...
Provisioning prov = Provisioning.getInstance();
Account acct = prov.get(AccountBy.id, at.getAccountId());
if (acct == null)
throw AccountServiceException.NO_SUCH_ACCOUNT(at.getAccountId());
ZimbraLog.addAccountNameToContext(acct.getName());
if (!Provisioning.onLocalServer(acct)) {
proxyServletRequest(req, resp, prov.getServer(acct), null);
return;
}
// make sure the authenticated account is active
if (acct.getAccountStatus().equals(Provisioning.ACCOUNT_STATUS_MAINTENANCE))
throw AccountServiceException.MAINTENANCE_MODE();
else if (!acct.getAccountStatus().equals(Provisioning.ACCOUNT_STATUS_ACTIVE))
throw AccountServiceException.ACCOUNT_INACTIVE(acct.getName());
// fetching the mailbox will except if it's in maintenance mode
Mailbox mbox = MailboxManager.getInstance().getMailboxByAccountId(acct.getId(), false);
if (mbox != null) {
ZimbraLog.addMboxToContext(mbox.getId());
}
} catch (ServiceException e) {
throw new ServletException(e);
}
}
// file upload requires multipart enctype
if (!FileUploadBase.isMultipartContent(req)) {
status = HttpServletResponse.SC_BAD_REQUEST;
break;
}
DiskFileUpload upload = getUploader();
try {
items = upload.parseRequest(req);
} catch (FileUploadBase.SizeLimitExceededException e) {
// at least one file was over max allowed size
status = HttpServletResponse.SC_REQUEST_ENTITY_TOO_LARGE;
mLog.info("Exceeded maximum upload size of " + upload.getSizeMax() + " bytes: " + e);
break;
} catch (FileUploadBase.InvalidContentTypeException e) {
// at least one file was of a type not allowed
status = HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE;
mLog.info("File upload failed", e);
break;
} catch (FileUploadException e) {
// parse of request failed for some other reason
status = HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
mLog.info("File upload failed", e);
break;
}
String lastName = null, charset = "utf-8";
HashMap<FileItem, String> filenames = new HashMap<FileItem, String>();
if (items != null)
for (Iterator<FileItem> it = items.iterator(); it.hasNext(); ) {
FileItem fi = it.next();
if (fi == null)
continue;
if (fi.isFormField()) {
// correlate this file upload session's request and response
if (fi.getFieldName().equals("requestId"))
reqId = fi.getString();
// get the form value charset, if specified
if (fi.getFieldName().equals("_charset_") && !fi.getString().equals(""))
charset = fi.getString();
// allow a client to explicitly provide filenames for the uploads
if (fi.getFieldName().startsWith("filename"))
lastName = fi.getString(charset);
// strip form fields out of the list of uploads
it.remove();
} else {
if (fi.getName() == null || fi.getName().trim().equals("")) {
it.remove();
} else {
filenames.put(fi, lastName);
lastName = null;
}
}
}
// empty upload is not a "success"
if (items == null || items.isEmpty()) {
status = HttpServletResponse.SC_NO_CONTENT;
break;
}
// cache the uploaded files in the hash and construct the list of upload IDs
try {
for (FileItem fi : items) {
String name = filenames.get(fi);
if (name == null || name.trim().equals(""))
name = fi.getName();
Upload up = new Upload(at.getAccountId(), fi, name);
ZimbraLog.mailbox.info("FileUploadServlet received %s", up);
synchronized (mPending) {
mPending.put(up.uuid, up);
}
attachmentId = (attachmentId == null ? up.uuid : attachmentId + UPLOAD_DELIMITER + up.uuid);
}
} catch (ServiceException e) {
status = HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
mLog.info("File upload failed", e);
}
} while (false);
StringBuffer results = new StringBuffer();
results.append(status).append(",'").append(reqId != null ? reqId : "null").append('\'');
if (status == HttpServletResponse.SC_OK)
results.append(",'").append(attachmentId).append('\'');
resp.setContentType("text/html");
PrintWriter out = resp.getWriter();
String fmt = req.getParameter(ContentServlet.PARAM_FORMAT);
if (ContentServlet.FORMAT_RAW.equals(fmt))
out.println(results);
else {
out.println("<html><head></head><body onload=\"window.parent._uploadManager.loaded(" + results + ");\">");
out.println("</body></html>");
}
out.close();
// handle failure by cleaning up the failed upload
if (status != HttpServletResponse.SC_OK && items != null && items.size() > 0)
for (FileItem fi : items)
fi.delete();
}
private static DiskFileUpload getUploader() {
// look up the maximum file size for uploads
long maxSize = DEFAULT_MAX_SIZE;
try {
Server config = Provisioning.getInstance().getLocalServer();
maxSize = config.getLongAttr(Provisioning.A_zimbraFileUploadMaxSize, DEFAULT_MAX_SIZE);
} catch (ServiceException e) {
mLog.error("Unable to read " + Provisioning.A_zimbraFileUploadMaxSize + " attribute", e);
}
DiskFileUpload upload = new DiskFileUpload();
upload.setSizeThreshold(4096); // in-memory limit
upload.setSizeMax(maxSize);
upload.setRepositoryPath(getTempDirectory());
return upload;
}
/** Uploads time out after 15 minutes. */
static final long UPLOAD_TIMEOUT_MSEC = 15 * Constants.MILLIS_PER_MINUTE;
/** Purge uploads once every minute. */
private static final long REAPER_INTERVAL_MSEC = 1 * Constants.MILLIS_PER_MINUTE;
public void init() throws ServletException {
String name = getServletName();
mLog.info("Servlet " + name + " starting up");
super.init();
File tempDir = new File(getTempDirectory());
if (!tempDir.exists()) {
if (!tempDir.mkdirs()) {
String msg = "Unable to create temporary upload directory " + tempDir;
mLog.error(msg);
throw new ServletException(msg);
}
}
cleanupLeftoverTempFiles();
Zimbra.sTimer.schedule(new MapReaperTask(), REAPER_INTERVAL_MSEC, REAPER_INTERVAL_MSEC);
}
public void destroy() {
String name = getServletName();
mLog.info("Servlet " + name + " shutting down");
super.destroy();
}
private final class MapReaperTask extends TimerTask {
public void run() {
ArrayList<Upload> reaped = new ArrayList<Upload>();
int sizeBefore;
int sizeAfter;
synchronized(mPending) {
sizeBefore = mPending.size();
long cutoffTime = System.currentTimeMillis() - UPLOAD_TIMEOUT_MSEC;
for (Iterator<Upload> it = mPending.values().iterator(); it.hasNext(); ) {
Upload up = it.next();
if (!up.accessedAfter(cutoffTime)) {
mLog.debug("Purging cached upload: " + up);
it.remove();
reaped.add(up);
assert(mPending.get(up.uuid) == null);
}
}
sizeAfter = mPending.size();
}
if (mLog.isInfoEnabled()) {
int removed = sizeBefore - sizeAfter;
if (removed > 0)
mLog.info("Removed " + removed + " expired file uploads; " +
sizeAfter + " pending file uploads");
else if (sizeAfter > 0)
mLog.info(sizeAfter + " pending file uploads");
}
for (Upload up : reaped)
up.purge();
}
}
}
The table below shows all metrics for FileUploadServlet.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 71.00 | Number of blocks | |
| BLOCK_COMMENT | 24.00 | Number of block comment lines | |
| COMMENTS | 68.00 | Comment lines | |
| COMMENT_DENSITY | 0.19 | Comment density | |
| COMPARISONS | 82.00 | Number of comparison operators | |
| CYCLOMATIC | 105.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 9.00 | Comments in declarations | |
| DOC_COMMENT | 18.00 | Number of javadoc comment lines | |
| ELOC | 354.00 | Effective lines of code | |
| EXEC_COMMENTS | 26.00 | Comments in executable code | |
| EXITS | 127.00 | Procedure exits | |
| FUNCTIONS | 22.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 84.36 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 74.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 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 2.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 | 0.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 | 32.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 | 1.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 | 1.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 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 3.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 | 6.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 2.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 | 49.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 | 0.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 | 3.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 | 1.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 | 528.00 | Number of lines in the source file | |
| LINE_COMMENT | 26.00 | Number of line comments | |
| LOC | 406.00 | Lines of code | |
| LOGICAL_LINES | 253.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 1257.00 | Number of operands | |
| OPERATORS | 2176.00 | Number of operators | |
| PARAMS | 19.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3433.00 | Halstead program length | |
| PROGRAM_VOCAB | 507.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 55.00 | Number of return points from functions | |
| SIZE | 23236.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 447.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 60.00 | Number of unique operators | |
| WHITESPACE | 54.00 | Number of whitespace lines | |