UserServlet.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 |  |
| RETURNS | Number of return points from functions | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| CYCLOMATIC | Cyclomatic complexity | |
| EXITS | Procedure exits | |
| COMPARISONS | Number of comparison operators | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| SIZE | Size of the file in bytes | |
| OPERATORS | Number of operators | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOGICAL_LINES | Number of statements | |
| ELOC | Effective lines of code | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LINE_COMMENT | Number of line comments | |
| LOC | Lines of code | |
| BLOCKS | Number of blocks | |
| JAVA0007 | JAVA0007 Should not declare public field | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| PARAMS | Number of formal parameter declarations | |
| LINES | Number of lines in the source file | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| FUNCTIONS | Number of function declarations | |
| JAVA0071 | JAVA0071 Strings compared with == | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LOOPS | Number of loops | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* ***** 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) 2005, 2006 Zimbra, Inc.
* All Rights Reserved.
*
* Contributor(s):
*
* ***** END LICENSE BLOCK *****
*/
package com.zimbra.cs.service;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
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.HttpURL;
import org.apache.commons.httpclient.HttpsURL;
import org.apache.commons.httpclient.methods.GetMethod;
import com.zimbra.cs.account.Account;
import com.zimbra.cs.account.AuthToken;
import com.zimbra.cs.account.AuthTokenException;
import com.zimbra.cs.account.Provisioning;
import com.zimbra.cs.account.Server;
import com.zimbra.cs.account.Provisioning.AccountBy;
import com.zimbra.cs.mailbox.ACL;
import com.zimbra.cs.mailbox.Folder;
import com.zimbra.cs.mailbox.MailItem;
import com.zimbra.cs.mailbox.MailServiceException;
import com.zimbra.cs.mailbox.Mailbox;
import com.zimbra.cs.mailbox.MailboxManager;
import com.zimbra.cs.mailbox.Mountpoint;
import com.zimbra.cs.mailbox.MailServiceException.NoSuchItemException;
import com.zimbra.cs.mailbox.Mailbox.OperationContext;
import com.zimbra.cs.mime.MimeCompoundHeader;
import com.zimbra.cs.service.formatter.*;
import com.zimbra.cs.service.mail.GetItem;
import com.zimbra.cs.service.util.ItemId;
import com.zimbra.cs.servlet.ZimbraServlet;
import com.zimbra.common.service.ServiceException;
import com.zimbra.common.util.ByteUtil;
import com.zimbra.common.util.DateUtil;
import com.zimbra.common.util.HttpUtil;
import com.zimbra.common.util.Pair;
import com.zimbra.common.util.ZimbraLog;
/**
*
* <pre>
* http://server/service/user/[˜][{username}]/[{folder}]?[{query-params}]
* fmt={ics, csv, etc}
* id={item-id}
* imap_id={item-imap-id}
* part={mime-part}
* query={search-query}
* types={types} // when searching
* auth={auth-types}
* start={time}
* end={time}
* sync="1"
*
* {types} = comma-separated list. Legal values are:
* conversation|message|contact|appointment|note
* (default is "conversation")
*
* {auth-types} = comma-separated list. Legal values are:
* co cookie
* ba basic auth
* nsc do not set a cookie when using basic auth
* (default is "co,ba", i.e. check both)
*
* {time} = (time in milliseconds) |
* YYYY/dd/mm |
* mm/dd/YYYY |
* [-]nnnn{minute,hour,day,week,month,year} // relative
* </pre>
*/
public class UserServlet extends ZimbraServlet {
private static final long serialVersionUID = -5313094316561384586L;
public static final String SERVLET_PATH = "/home";
public static final String QP_FMT = "fmt"; // format query param
public static final String QP_ID = "id"; // id query param
public static final String QP_IMAP_ID = "imap_id"; // IMAP id query param
public static final String QP_PART = "part"; // part query param
public static final String QP_BODY = "body"; // body query param
public static final String BODY_TEXT = "text"; // return text body
public static final String BODY_HTML = "html"; // return html body if possible
public static final String QP_QUERY = "query"; // query query param
public static final String QP_VIEW = "view"; // view query param
public static final String QP_TYPES = "types"; // types
public static final String QP_START = "start"; // start time
public static final String QP_END = "end"; // end time
public static final String QP_OFFSET = "offset"; // offset into results
public static final String QP_LIMIT = "limit"; // offset into results
public static final String QP_AUTH = "auth"; // auth types
public static final String QP_DISP = "disp"; // disposition (a = attachment, i = inline)
public static final String QP_NAME = "name"; // filename/path segments, added to pathInfo
public static final String AUTH_COOKIE = "co"; // auth by cookie
public static final String AUTH_BASIC = "ba"; // basic auth
public static final String AUTH_NO_SET_COOKIE = "nsc"; // don't set auth token cookie after basic auth
public static final String AUTH_DEFAULT = "co,ba"; // both
private HashMap<String, Formatter> mFormatters;
private HashMap<String, Formatter> mDefaultFormatters;
protected static final String MSGPAGE_BLOCK = "errorpage.attachment.blocked";
private String mBlockPage = null;
/** Default maximum upload size for PUT/POST write ops: 10MB. */
private static final long DEFAULT_MAX_SIZE = 10 * 1024 * 1024;
/** Returns the REST URL for the account. */
public static String getRestUrl(Account acct) throws ServiceException {
return getServiceUrl(acct, UserServlet.SERVLET_PATH);
}
/** Returns the REST URL for the mail item. */
public static String getRestUrl(MailItem item) throws ServiceException, IOException {
Account acct = item.getMailbox().getAccount();
String url = getRestUrl(acct) + item.getPath();
if (item instanceof Folder)
url = url + "/";
if (url.startsWith("https"))
url = new HttpsURL(url).toString();
else
url = new HttpURL(url).toString();
return url;
}
public UserServlet() {
mFormatters = new HashMap<String, Formatter>();
addFormatter(new CsvFormatter());
addFormatter(new VcfFormatter());
addFormatter(new IcsFormatter());
addFormatter(new RssFormatter());
addFormatter(new AtomFormatter());
addFormatter(new NativeFormatter());
addFormatter(new ZipFormatter());
addFormatter(new IfbFormatter());
addFormatter(new SyncFormatter());
addFormatter(new WikiFormatter());
addFormatter(new XmlFormatter());
addFormatter(new JsonFormatter());
mDefaultFormatters = new HashMap<String, Formatter>();
for (Formatter fmt : mFormatters.values())
for (String mimeType : fmt.getDefaultMimeTypes())
mDefaultFormatters.put(mimeType, fmt);
}
private void addFormatter(Formatter f) {
mFormatters.put(f.getType(), f);
}
public Formatter getFormatter(String type) {
return mFormatters.get(type);
}
private void getAccount(Context context) throws IOException, ServletException {
try {
boolean isAdminRequest = isAdminRequest(context);
// check cookie first
if (context.cookieAuthAllowed()) {
context.authAccount = cookieAuthRequest(context.req, context.resp, true);
if (context.authAccount != null) {
context.cookieAuthHappened = true;
try {
AuthToken at = isAdminRequest ? getAdminAuthTokenFromCookie(context.req, context.resp, true) : getAuthTokenFromCookie(context.req, context.resp, true);
context.authTokenCookie = at.getEncoded();
} catch (AuthTokenException e) {
}
return;
}
}
// fallback to basic auth
if (context.basicAuthAllowed()) {
context.authAccount = basicAuthRequest(context.req, context.resp, false);
if (context.authAccount != null) {
context.basicAuthHappened = true;
// send cookie back if need be.
if (!context.noSetCookie()) {
try {
context.authTokenCookie = new AuthToken(context.authAccount, isAdminRequest).getEncoded();
context.resp.addCookie(new Cookie(isAdminRequest ? COOKIE_ZM_ADMIN_AUTH_TOKEN : COOKIE_ZM_AUTH_TOKEN, context.authTokenCookie));
} catch (AuthTokenException e) {
}
}
}
// always return
return;
}
// there is no credential at this point. assume anonymous public access and continue.
} catch (ServiceException e) {
throw new ServletException(e);
}
}
private boolean isAdminRequest(Context context) throws ServiceException {
int adminPort = Provisioning.getInstance().getLocalServer().getIntAttr(Provisioning.A_zimbraAdminPort, -1);
return (context.req.getLocalPort() == adminPort);
}
private void sendError(Context ctxt, HttpServletRequest req, HttpServletResponse resp, String message) throws IOException {
if (ctxt == null) {
resp.sendError(HttpServletResponse.SC_FORBIDDEN, message);
} else if (!ctxt.cookieAuthHappened && ctxt.basicAuthAllowed() && !ctxt.basicAuthHappened) {
resp.addHeader(WWW_AUTHENTICATE_HEADER, getRealmHeader());
resp.sendError(HttpServletResponse.SC_UNAUTHORIZED, message);
} else {
resp.sendError(HttpServletResponse.SC_FORBIDDEN, message);
}
}
public void doGet(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
Context context = null;
try {
context = new Context(req, resp, this);
if (!checkAuthentication(req, resp, context)) {
sendError(context, req, resp, "must authenticate");
return;
}
if (isProxyRequest(req, resp, context))
return;
// at this point context.authAccount is set either from the Cookie,
// or from basic auth. if there was no credential in either the Cookie
// or basic auth, authAccount is set to anonymous account.
if (context.authAccount != null)
ZimbraLog.addAccountNameToContext(context.authAccount.getName());
ZimbraLog.addIpToContext(context.req.getRemoteAddr());
doAuthGet(req, resp, context);
} catch (NoSuchItemException e) {
resp.sendError(HttpServletResponse.SC_NOT_FOUND, "no such item");
} catch (ServiceException se) {
if (se.getCode() == ServiceException.PERM_DENIED)
sendError(context, req, resp, se.getMessage());
else
throw new ServletException(se);
} catch (UserServletException e) {
// add check for ServiceException root cause?
resp.sendError(e.getHttpStatusCode(), e.getMessage());
} finally {
ZimbraLog.clearContext();
}
}
private boolean checkAuthentication(HttpServletRequest req, HttpServletResponse resp, Context context) throws IOException, ServletException, UserServletException {
// if they specify /~/, we must auth
if (context.targetAccount == null && context.accountPath.equals("~")) {
getAccount(context);
if (context.authAccount == null)
return false;
context.targetAccount = context.authAccount;
}
// at this point we must have a target account
if (context.targetAccount == null)
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "target account not found");
// auth is required if we haven't yet authed and they've specified a formatter that requires auth (including write ops).
boolean authRequired = context.authAccount == null &&
(context.formatter == null || context.formatter.requiresAuth() || req.getMethod().equalsIgnoreCase("POST"));
// need this before proxy if we want to support sending cookie from a basic-auth
if (authRequired) {
getAccount(context);
if (context.authAccount == null) {
context.setAnonymousRequest();
}
}
return true;
}
private boolean isProxyRequest(HttpServletRequest req, HttpServletResponse resp, Context context) throws IOException, ServiceException {
// this should handle both explicit /user/user-on-other-server/ and
// /user/~/?id={account-id-on-other-server}:id
if (!Provisioning.onLocalServer(context.targetAccount)) {
try {
if (context.basicAuthHappened && context.authTokenCookie == null)
context.authTokenCookie = new AuthToken(context.authAccount, isAdminRequest(context)).getEncoded();
Provisioning prov = Provisioning.getInstance();
proxyServletRequest(req, resp, prov.getServer(context.targetAccount), context.basicAuthHappened ? context.authTokenCookie : null);
return true;
} catch (ServletException e) {
throw ServiceException.FAILURE("proxy error", e);
} catch (AuthTokenException e) {
throw ServiceException.FAILURE("proxy error", e);
}
}
return false;
}
private void doAuthGet(HttpServletRequest req, HttpServletResponse resp, Context context)
throws ServletException, IOException, ServiceException, UserServletException {
Mailbox mbox = context.targetMailbox = MailboxManager.getInstance().getMailboxByAccount(context.targetAccount);
if (mbox == null)
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "mailbox not found");
ZimbraLog.addMboxToContext(mbox.getId());
if (ZimbraLog.mailbox.isDebugEnabled()) {
StringBuffer reqURL = context.req.getRequestURL();
String queryParam = context.req.getQueryString();
if (queryParam != null) reqURL.append('?').append(queryParam);
ZimbraLog.mailbox.debug("UserServlet: " + reqURL.toString());
}
context.opContext = new OperationContext(context.authAccount, isAdminRequest(context));
MailItem item = resolveItem(context, true);
if (item instanceof Mountpoint) {
// if the target is a mountpoint, proxy the request on to the resolved target
proxyOnMountpoint(req, resp, context, (Mountpoint) item);
return;
}
resolveFormatter(context, item);
if (context.formatter.canBeBlocked()) {
if (Formatter.checkGlobalOverride(Provisioning.A_zimbraAttachmentsBlocked, context.authAccount)) {
sendbackBlockMessage(context.req, context.resp);
return;
}
}
context.formatter.format(context, item);
}
/** Adds an item to a folder specified in the URI. The item content is
* provided in the PUT request's body.
* @see #doPost(HttpServletRequest, HttpServletResponse) */
public void doPut(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
doPost(req, resp);
}
/** Adds an item to a folder specified in the URI. The item content is
* provided in the POST request's body. */
public void doPost(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
Context context = null;
try {
context = new Context(req, resp, this);
if (!checkAuthentication(req, resp, context)) {
sendError(context, req, resp, "must authenticate");
return;
}
if (isProxyRequest(req, resp, context))
return;
if (context.authAccount != null)
ZimbraLog.addAccountNameToContext(context.authAccount.getName());
ZimbraLog.addIpToContext(context.req.getRemoteAddr());
Mailbox mbox = context.targetMailbox = MailboxManager.getInstance().getMailboxByAccount(context.targetAccount);
if (mbox == null)
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "mailbox not found");
ZimbraLog.addMboxToContext(mbox.getId());
ZimbraLog.mailbox.info("UserServlet (POST): " + context.req.getRequestURL().toString());
context.opContext = new OperationContext(context.authAccount, isAdminRequest(context));
MailItem item;
String filename = null;
try {
item = resolveItem(context, false);
} catch (NoSuchItemException nsie) {
// perhaps it's a POST to "Notebook/new-file-name" -- find the parent folder and proceed from there
if (context.itemPath == null)
throw nsie;
int separator = context.itemPath.lastIndexOf('/');
if (separator <= 0)
throw nsie;
filename = context.itemPath.substring(separator + 1);
context.itemPath = context.itemPath.substring(0, separator);
item = resolveItem(context, false);
}
Folder folder = (item instanceof Folder ? (Folder) item : mbox.getFolderById(context.opContext, item.getFolderId()));
if (item != folder) {
if (filename == null)
filename = item.getName();
else
// need to fail on POST to "Notebook/existing-file/random-cruft"
throw MailServiceException.NO_SUCH_FOLDER(context.itemPath);
}
if (folder instanceof Mountpoint) {
// if the target is a mountpoint, proxy the request on to the resolved target
context.extraPath = filename;
proxyOnMountpoint(req, resp, context, (Mountpoint) folder);
return;
}
// if they specified a filename, default to the native formatter
if (context.format == null && filename != null)
context.format = NativeFormatter.FMT_NATIVE;
String ctype = context.req.getContentType();
// if no format explicitly specified, try to guess it from the Content-Type header
if (context.format == null && ctype != null) {
String normalizedType = new MimeCompoundHeader.ContentType(ctype).getValue();
Formatter fmt = mDefaultFormatters.get(normalizedType);
if (fmt != null)
context.format = fmt.getType();
}
// get the POST body content
long sizeLimit = Provisioning.getInstance().getLocalServer().getLongAttr(Provisioning.A_zimbraFileUploadMaxSize, DEFAULT_MAX_SIZE);
byte[] body = ByteUtil.getContent(req.getInputStream(), req.getContentLength(), sizeLimit);
resolveFormatter(context, folder);
context.formatter.save(body, context, ctype, folder, filename);
} catch (NoSuchItemException e) {
resp.sendError(HttpServletResponse.SC_NOT_FOUND, "no such item");
} catch (ServiceException se) {
if (se.getCode() == ServiceException.PERM_DENIED)
sendError(context, req, resp, se.getMessage());
else
throw new ServletException(se);
} catch (UserServletException e) {
// add check for ServiceException root cause?
resp.sendError(e.getHttpStatusCode(), e.getMessage());
} finally {
ZimbraLog.clearContext();
}
}
/** Determines the <code>format</code> and <code>formatter<code> for the
* request, if not already set. */
private void resolveFormatter(Context context, MailItem target) throws UserServletException {
if (context.format == null) {
context.format = defaultFormat(target, context);
if (context.format == null)
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "unsupported format");
}
if (context.formatter == null)
context.formatter = mFormatters.get(context.format);
if (context.formatter == null)
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "unsupported format");
}
/*
* Parses the pathInfo, then returns MailItem corresponding to the resource in pathInfo.
*
* If the formatter does not require authentication, e.g. IfbFormatter,
* then the path resolution is skipped and returns null. That's because
* IfbFormatter does not internally use the resource identified in the URL.
* It gets the ifb information directly from the Mailbox.
*
* If the formatter declares that the authentication is not required, it's
* the formatter's responsibility to make sure the MailItems returned to
* the clients has gone through the access checks.
*
*/
private MailItem resolveItem(Context context, boolean checkExtension) throws ServiceException, UserServletException {
if (context.formatter != null && !context.formatter.requiresAuth())
return null;
// special-case the fetch-by-IMAP-id option
if (context.imapId > 0) {
// fetch the folder from the path
Folder folder = context.targetMailbox.getFolderByPath(context.opContext, context.itemPath);
// and then fetch the item from the "imap_id" query parameter
return GetItem.getItemByImapId(context.opContext, context.targetMailbox, context.imapId, folder.getId());
}
MailItem item = null;
if (context.itemId != null) {
item = GetItem.getItemById(context.opContext, context.targetMailbox, context.itemId.getId(), MailItem.TYPE_UNKNOWN);
context.itemPath = item.getPath();
if (item instanceof Mountpoint || context.extraPath == null || context.extraPath.equals(""))
return item;
if (context.itemPath == null)
throw MailServiceException.NO_SUCH_ITEM("?id=" + context.itemId + "&name=" + context.extraPath);
context.itemId = null;
}
if (context.extraPath != null && !context.extraPath.equals("")) {
context.itemPath = (context.itemPath + '/' + context.extraPath).replaceAll("//+", "/");
context.extraPath = null;
}
try {
// first, try the full path
item = GetItem.getItemByPath(context.opContext, context.targetMailbox, context.itemPath, MailItem.TYPE_UNKNOWN);
} catch (ServiceException e) {
if (!(e instanceof NoSuchItemException) && e.getCode() != ServiceException.PERM_DENIED)
throw e;
// no joy. if they asked for something like "calendar.csv" (where "calendar" was the folder name), try again minus the extension
if (!checkExtension || context.format != null)
throw e;
/* if path == /foo/bar/baz.html, then
* format -> html
* path -> /foo/bar/baz */
int dot = context.itemPath.lastIndexOf('.');
if (dot == -1)
throw e;
String unsuffixedPath = context.itemPath.substring(0, dot);
// try again, w/ the extension removed...
item = GetItem.getItemByPath(context.opContext, context.targetMailbox, unsuffixedPath, MailItem.TYPE_UNKNOWN);
context.format = context.itemPath.substring(dot + 1);
context.itemPath = unsuffixedPath;
}
// don't think this code can ever get called because <tt>item</tt> can't be null at this point
if (item == null && context.getQueryString() == null)
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "item not found");
return item;
}
private void proxyOnMountpoint(HttpServletRequest req, HttpServletResponse resp, Context context, Mountpoint mpt)
throws IOException, ServletException, ServiceException, UserServletException {
String uri = SERVLET_PATH + "/~/?" + QP_ID + '=' + mpt.getOwnerId() + "%3A" + mpt.getRemoteId();
if (context.format != null)
uri += '&' + QP_FMT + '=' + URLEncoder.encode(context.format, "UTF-8");
if (context.extraPath != null)
uri += '&' + QP_NAME + '=' + URLEncoder.encode(context.extraPath, "UTF-8");
for (Map.Entry<String, String> entry : HttpUtil.getURIParams(req).entrySet()) {
String qp = entry.getKey();
if (!qp.equals(QP_ID) && !qp.equals(QP_FMT))
uri += '&' + URLEncoder.encode(qp, "UTF-8") + '=' + URLEncoder.encode(entry.getValue(), "UTF-8");
}
try {
if (context.basicAuthHappened && context.authTokenCookie == null)
context.authTokenCookie = new AuthToken(context.authAccount, isAdminRequest(context)).getEncoded();
} catch (AuthTokenException e) {
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "cannot generate auth token");
}
Provisioning prov = Provisioning.getInstance();
Account targetAccount = prov.get(AccountBy.id, mpt.getOwnerId());
if (targetAccount == null)
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "referenced account not found");
proxyServletRequest(req, resp, prov.getServer(targetAccount), uri,
context.basicAuthHappened ? context.authTokenCookie : null);
}
public static class Context {
public HttpServletRequest req;
public HttpServletResponse resp;
public Map<String, String> params;
public String format;
public Formatter formatter;
public boolean cookieAuthHappened;
public boolean basicAuthHappened;
public String accountPath;
public String authTokenCookie;
public String itemPath;
public String extraPath;
public ItemId itemId;
public int imapId = -1;
public boolean sync;
public Account authAccount;
public Account targetAccount;
public Mailbox targetMailbox;
public OperationContext opContext;
private long mStartTime = -2;
private long mEndTime = -2;
Context(HttpServletRequest request, HttpServletResponse response, UserServlet servlet)
throws UserServletException, ServiceException {
Provisioning prov = Provisioning.getInstance();
this.req = request;
this.resp = response;
this.params = HttpUtil.getURIParams(request);
String pathInfo = request.getPathInfo().toLowerCase();
if (pathInfo == null || pathInfo.equals("/") || pathInfo.equals("") || !pathInfo.startsWith("/"))
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "invalid path");
int pos = pathInfo.indexOf('/', 1);
if (pos == -1)
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "invalid path");
String checkInternalDispatch = (String) request.getAttribute("zimbra-internal-dispatch");
if (checkInternalDispatch != null && checkInternalDispatch.equals("yes")) {
// XXX extra decoding is necessary if the HttpRequest was
// re-dispatched internally from SetHeaderFilter class in
// zimbra app. it appears org.apache.catalina.core.ApplicationHttpRequest
// does not perform URL decoding on pathInfo. refer to
// bug 8159.
try {
pathInfo = URLDecoder.decode(pathInfo, "UTF-8");
} catch (UnsupportedEncodingException uee) {
ZimbraLog.misc.info("cannot decode pathInfo " + pathInfo);
}
}
this.accountPath = pathInfo.substring(1, pos);
this.itemPath = pathInfo.substring(pos + 1);
if (itemPath.equals(""))
itemPath = "/";
this.extraPath = this.params.get(QP_NAME);
this.format = this.params.get(QP_FMT);
String id = this.params.get(QP_ID);
try {
this.itemId = id == null ? null : new ItemId(id, (String) null);
} catch (ServiceException e) {
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "invalid id requested");
}
String imap = this.params.get(QP_IMAP_ID);
try {
this.imapId = imap == null ? -1 : Integer.parseInt(imap);
} catch (NumberFormatException nfe) {
throw new UserServletException(HttpServletResponse.SC_BAD_REQUEST, "invalid imap id requested");
}
if (this.format != null) {
this.format = this.format.toLowerCase();
this.formatter = servlet.getFormatter(this.format);
if (this.formatter == null)
throw new UserServletException(HttpServletResponse.SC_NOT_IMPLEMENTED, "not implemented yet");
}
// see if we can get target account or not
if (itemId != null && itemId.getAccountId() != null) {
targetAccount = prov.get(AccountBy.id, itemId.getAccountId());
return;
} else if (accountPath.equals("~")) {
// can't resolve this yet
return;
} else if (accountPath.startsWith("~")) {
accountPath = accountPath.substring(1);
}
targetAccount = prov.get(AccountBy.name, accountPath);
}
public long getStartTime() {
if (mStartTime == -2) {
String st = params.get(QP_START);
long defaultStartTime = formatter.getDefaultStartTime();
mStartTime = (st != null) ? DateUtil.parseDateSpecifier(st, defaultStartTime) : defaultStartTime;
}
return mStartTime;
}
public long getEndTime() {
if (mEndTime == -2) {
String et = params.get(QP_END);
long defaultEndTime = formatter.getDefaultEndTime();
mEndTime = (et != null) ? DateUtil.parseDateSpecifier(et, defaultEndTime) : defaultEndTime;
}
return mEndTime;
}
public String getQueryString() {
return params.get(QP_QUERY);
}
public boolean cookieAuthAllowed() {
return getAuth().indexOf(AUTH_COOKIE) != -1;
}
public boolean noSetCookie() {
return authAccount != null && authAccount instanceof ACL.GuestAccount
|| getAuth().indexOf(AUTH_NO_SET_COOKIE) != -1;
}
public boolean basicAuthAllowed() {
return getAuth().indexOf(AUTH_BASIC) != -1;
}
public String getAuth() {
String a = params.get(QP_AUTH);
return (a == null || a.length() == 0) ? AUTH_DEFAULT : a;
}
public boolean hasPart() {
String p = getPart();
return p != null && p.length() > 0;
}
public String getPart() {
return params.get(QP_PART);
}
public boolean hasBody() {
String p = getBody();
return p != null;
}
public String getBody() {
return params.get(QP_BODY);
}
public boolean hasView() {
String v = getView();
return v != null && v.length() > 0;
}
public String getView() {
return params.get(QP_VIEW);
}
public int getOffset() {
String s = params.get(QP_OFFSET);
if (s != null) {
int offset = Integer.parseInt(s);
if (offset > 0)
return offset;
}
return 0;
}
public int getLimit() {
String s = params.get(QP_LIMIT);
if (s != null) {
int limit = Integer.parseInt(s);
if (limit > 0)
return limit;
}
return 50;
}
public String getTypesString() {
return params.get(QP_TYPES);
}
public void setAnonymousRequest() {
authAccount = ACL.ANONYMOUS_ACCT;
}
public boolean isAnonymousRequest() {
return authAccount.equals(ACL.ANONYMOUS_ACCT);
}
public String toString() {
StringBuffer sb = new StringBuffer();
sb.append("account(" + accountPath + ")\n");
sb.append("itemPath(" + itemPath + ")\n");
sb.append("foramt(" + format + ")\n");
return sb.toString();
}
}
protected String getRealmHeader() {
return "BASIC realm=\"Zimbra\"";
}
private String defaultFormat(MailItem item, Context context) {
if (context.hasPart())
return "native";
byte type = MailItem.TYPE_UNKNOWN;
if (item instanceof Folder)
type = ((Folder) item).getDefaultView();
else if (item != null)
type = item.getType();
switch (type) {
case MailItem.TYPE_APPOINTMENT:
case MailItem.TYPE_TASK:
return "ics";
case MailItem.TYPE_CONTACT:
return item instanceof Folder? "csv" : "vcf";
case MailItem.TYPE_WIKI:
case MailItem.TYPE_DOCUMENT:
return "wiki";
default:
return "native";
}
}
/**
* @param req
* @param resp
* @throws IOException
* @throws ServletException
*/
private void sendbackBlockMessage(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
RequestDispatcher dispatcher = getServletContext().getRequestDispatcher(mBlockPage);
if (dispatcher != null) {
dispatcher.forward(req, resp);
return;
}
resp.sendError(HttpServletResponse.SC_FORBIDDEN, "The attachment download has been disabled per security policy.");
}
public void init() throws ServletException {
String name = getServletName();
ZimbraLog.mailbox.info("Servlet " + name + " starting up");
super.init();
mBlockPage = getInitParameter(MSGPAGE_BLOCK);
}
public void destroy() {
String name = getServletName();
ZimbraLog.mailbox.info("Servlet " + name + " shutting down");
super.destroy();
}
public static byte[] getRemoteContent(String authToken, ItemId iid, Map<String, String> params) throws ServiceException {
return getRemoteResource(authToken, iid, params).getSecond();
}
public static byte[] getRemoteContent(String authToken, Account target, String folder, Map<String,String> params) throws ServiceException {
return getRemoteResource(authToken, target, folder, params).getSecond();
}
public static byte[] getRemoteContent(String authToken, String hostname, String url) throws ServiceException {
return getRemoteResource(authToken, hostname, url).getSecond();
}
public static Pair<Header[], byte[]> getRemoteResource(String authToken, ItemId iid, Map<String, String> params) throws ServiceException {
Account target = Provisioning.getInstance().get(AccountBy.id, iid.getAccountId());
Map<String, String> pcopy = new HashMap<String, String>(params);
pcopy.put(QP_ID, iid.toString());
return getRemoteResource(authToken, target, null, pcopy);
}
public static Pair<Header[], byte[]> getRemoteResource(String authToken, Account target, String folder, Map<String,String> params) throws ServiceException {
// fetch from remote store
Provisioning prov = Provisioning.getInstance();
Server server = (target == null ? prov.getLocalServer() : prov.getServer(target));
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);
if (folder == null) {
folder = "";
} else {
if (folder.endsWith("/"))
folder = folder.substring(0, folder.length() - 1);
if (folder.startsWith("/"))
folder = folder.substring(1);
}
StringBuffer url = new StringBuffer(useHTTP ? "http" : "https");
url.append("://").append(hostname).append(':').append(port).append(SERVLET_PATH);
url.append('/').append(target == null ? "~" : target.getName());
url.append('/').append(folder).append("/?");
url.append(QP_AUTH).append('=').append(AUTH_COOKIE);
if (params != null) {
for (Map.Entry<String, String> param : params.entrySet())
url.append('&').append(param.getKey()).append('=').append(param.getValue());
}
return getRemoteResource(authToken, hostname, url.toString());
}
public static Pair<Header[], byte[]> getRemoteResource(String authToken, String hostname, String url) throws ServiceException {
// create an HTTP client with the same cookies
HttpState state = new HttpState();
state.addCookie(new org.apache.commons.httpclient.Cookie(hostname, COOKIE_ZM_AUTH_TOKEN, authToken, "/", null, false));
HttpClient client = new HttpClient();
client.setState(state);
GetMethod get = new GetMethod(url);
try {
int statusCode = client.executeMethod(get);
if (statusCode == HttpStatus.SC_NOT_FOUND)
throw MailServiceException.NO_SUCH_ITEM(-1);
else if (statusCode != HttpStatus.SC_OK)
throw ServiceException.RESOURCE_UNREACHABLE(get.getStatusText(), null);
Header[] headers = get.getResponseHeaders();
return new Pair<Header[], byte[]>(headers, get.getResponseBody());
} catch (HttpException e) {
throw ServiceException.RESOURCE_UNREACHABLE("HttpException while fetching " + url, e);
} catch (IOException e) {
throw ServiceException.RESOURCE_UNREACHABLE("IOException while fetching " + url, e);
} finally {
get.releaseConnection();
}
}
}
The table below shows all metrics for UserServlet.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 122.00 | Number of blocks | |
| BLOCK_COMMENT | 40.00 | Number of block comment lines | |
| COMMENTS | 126.00 | Comment lines | |
| COMMENT_DENSITY | 0.22 | Comment density | |
| COMPARISONS | 136.00 | Number of comparison operators | |
| CYCLOMATIC | 199.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 10.00 | Comments in declarations | |
| DOC_COMMENT | 47.00 | Number of javadoc comment lines | |
| ELOC | 579.00 | Effective lines of code | |
| EXEC_COMMENTS | 33.00 | Comments in executable code | |
| EXITS | 150.00 | Procedure exits | |
| FUNCTIONS | 48.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 105.41 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 243.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 | 18.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 | 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 | 53.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 | 2.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 | 3.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 | 1.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 | 1.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 | 4.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 2.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 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 8.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 40.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 26.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.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 | 3.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 | 1.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 | 10.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 9.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 | 2.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 | 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 | 0.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 | 953.00 | Number of lines in the source file | |
| LINE_COMMENT | 39.00 | Number of line comments | |
| LOC | 677.00 | Lines of code | |
| LOGICAL_LINES | 384.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 2134.00 | Number of operands | |
| OPERATORS | 3710.00 | Number of operators | |
| PARAMS | 60.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 5844.00 | Halstead program length | |
| PROGRAM_VOCAB | 634.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 183.00 | Number of return points from functions | |
| SIZE | 40093.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 577.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 57.00 | Number of unique operators | |
| WHITESPACE | 150.00 | Number of whitespace lines | |