SolutionRepositoryService.java
| Index Score | ||
|---|---|---|
 |
 |
org.pentaho.ui.servlet |
 |
 |
Pentaho |
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 | |
|---|---|---|
| EXITS | Procedure exits |  |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| OPERANDS | Number of operands | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| PARAMS | Number of formal parameter declarations | |
| PROGRAM_LENGTH | Halstead program length | |
| RETURNS | Number of return points from functions | |
| SIZE | Size of the file in bytes | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| LOGICAL_LINES | Number of statements | |
| OPERATORS | Number of operators | |
| JAVA0082 | JAVA0082 Unnecessary widening cast | |
| UNIQUE_OPERATORS | Number of unique operators | |
| ELOC | Effective lines of code | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| JAVA0283 | JAVA0283 Control variable not updated in loop body | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| LOC | Lines of code | |
| JAVA0043 | JAVA0043 Inner class does not use outer class | |
| JAVA0171 | JAVA0171 Unused local variable | |
| BLOCKS | Number of blocks | |
| JAVA0067 | JAVA0067 Array descriptor on identifier name | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| COMMENTS | Comment lines | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright 2006 Pentaho Corporation. All rights reserved.
* This software was developed by Pentaho Corporation and is provided under the terms
* of the Mozilla Public License, Version 1.1, or any later version. You may not use
* this file except in compliance with the license. If you need a copy of the license,
* please go to http://www.mozilla.org/MPL/MPL-1.1.txt. The Original Code is the Pentaho
* BI Platform. The Initial Developer is Pentaho Corporation.
*
* Software distributed under the Mozilla Public License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
* the license for the specific language governing your rights and limitations.
*
* @created Jul 12, 2005
* @author James Dixon, Angelo Rodriguez, Steven Barkdull
*
*/
package org.pentaho.ui.servlet;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.dom4j.Document;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.pentaho.core.cache.CacheManager;
import org.pentaho.core.repository.ISolutionRepository;
import org.pentaho.core.repository.SolutionRepositoryBase;
import org.pentaho.core.session.IPentahoSession;
import org.pentaho.core.solution.HttpRequestParameterProvider;
import org.pentaho.core.solution.IFileFilter;
import org.pentaho.core.solution.IParameterProvider;
import org.pentaho.core.solution.ISolutionFile;
import org.pentaho.core.solution.PermissionFilter;
import org.pentaho.core.system.PentahoSystem;
import org.pentaho.core.util.CleanXmlHelper;
import org.pentaho.messages.Messages;
import org.pentaho.messages.util.LocaleHelper;
import org.pentaho.util.StringUtil;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import com.pentaho.repository.dbbased.solution.RepositoryFile;
import com.pentaho.security.IPermissionMask;
import com.pentaho.security.IPermissionRecipient;
import com.pentaho.security.PentahoAccessControlException;
import com.pentaho.security.SimplePermissionMask;
import com.pentaho.security.SimpleRole;
import com.pentaho.security.SimpleUser;
import com.pentaho.security.acls.IAclSolutionFile;
import com.pentaho.security.acls.PentahoAclEntry;
public class SolutionRepositoryService extends ServletBase {
/**
*
*/
private static final long serialVersionUID = -5870073658756939643L;
private static final Log logger = LogFactory.getLog(SolutionRepositoryService.class);
/**
* contains instance of a sax parser factory. Use getSAXParserFactory() method
* to get a copy of the factory.
*/
private static final ThreadLocal<SAXParserFactory> SAX_FACTORY = new ThreadLocal<SAXParserFactory>();
private static final String RESPONSE_DOCUMENT_ENCODING = "UTF-8";
private static final String RESPONSE_DOCUMENT_VERSION_NUM = "1.0";
public Log getLogger() {
return logger;
}
public SolutionRepositoryService() {
super();
}
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
PentahoSystem.systemEntryPoint();
OutputStream outputStream = response.getOutputStream();
try {
boolean wrapWithSoap = "false".equals(request.getParameter("ajax")); //$NON-NLS-1$ //$NON-NLS-2$
String component = request.getParameter("component"); //$NON-NLS-1$
response.setContentType("text/xml"); //$NON-NLS-1$
response.setCharacterEncoding(LocaleHelper.getSystemEncoding());
IPentahoSession userSession = getPentahoSession(request);
// send the header of the message to prevent time-outs while we are working
response.setHeader("expires", "0"); //$NON-NLS-1$ //$NON-NLS-2$
dispatch(request, response, component, outputStream, userSession, wrapWithSoap);
/**
* NOTE: PLEASE DO NOT CATCH Exception, since this is the super class of RuntimeException.
* We do NOT want to catch RuntimeException, only CHECKED exceptions!
*/
} catch (IOException ex) {
commonErrorHandler( outputStream, ex );
} catch (SolutionRepositoryServiceException ex) {
commonErrorHandler( outputStream, ex );
} catch (PentahoAccessControlException ex) {
commonErrorHandler( outputStream, ex );
} finally {
PentahoSystem.systemExitPoint();
}
if (debug) {
debug(Messages.getString("HttpWebService.DEBUG_WEB_SERVICE_END")); //$NON-NLS-1$
}
}
private void commonErrorHandler( OutputStream outputStream, Exception ex ) throws IOException
{
String msg = Messages.getErrorString("SolutionRepositoryService.ERROR_0001_ERROR_DURING_SERVICE_REQUEST"); //$NON-NLS-1$;
error(msg, ex);
WebServiceUtil.writeString(outputStream, WebServiceUtil.getErrorXml(msg), false);
}
private static String[] getFilters( HttpServletRequest request )
{
String filter = request.getParameter("filter"); //$NON-NLS-1$
List<String> filters = new ArrayList<String>();
if (!StringUtils.isEmpty(filter)) {
StringTokenizer st = new StringTokenizer(filter, "*.,");
while (st.hasMoreTokens()) {
filters.add(st.nextToken());
}
}
return filters.toArray(new String[] {});
}
protected void dispatch(HttpServletRequest request, HttpServletResponse response, String component, OutputStream outputStream,
IPentahoSession userSession, boolean wrapWithSOAP) throws IOException, SolutionRepositoryServiceException, PentahoAccessControlException {
IParameterProvider parameterProvider = new HttpRequestParameterProvider(request);
if ("getSolutionRepositoryDoc".equals(component)) { //$NON-NLS-1$
String[] filters = getFilters( request );
Document doc = getSolutionRepositoryDoc(userSession, filters);
WebServiceUtil.writeDocument(outputStream, doc, wrapWithSOAP);
} else if ("createNewFolder".equals(component)) { //$NON-NLS-1$
String path = request.getParameter("path"); //$NON-NLS-1$
String name = request.getParameter("name"); //$NON-NLS-1$
String desc = request.getParameter("desc"); //$NON-NLS-1$
createFolder(userSession, path, name, desc);
WebServiceUtil.writeString(outputStream, "", wrapWithSOAP); //$NON-NLS-1$
} else if ("setAcl".equals(component)) { //$NON-NLS-1$
setAcl(parameterProvider, outputStream, userSession, wrapWithSOAP);
} else if ("getAcl".equals(component)) { //$NON-NLS-1$
getAcl(parameterProvider, outputStream, userSession, wrapWithSOAP);
} else {
throw new RuntimeException(Messages.getErrorString("HttpWebService.UNRECOGNIZED_COMPONENT_REQUEST", component)); //$NON-NLS-1$
}
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doGet(request, response);
}
private void createFolder(IPentahoSession userSession, String path, String name, String desc) throws IOException {
ISolutionRepository repository = PentahoSystem.getSolutionRepository(userSession);
File parent = new File(PentahoSystem.getApplicationContext().getSolutionPath(path));
File newFolder = new File(parent, name);
repository.createFolder(newFolder);
String defaultIndex = "<index><name>" + name + "</name><description>" + desc //$NON-NLS-1$
+ "</description><icon>reporting.png</icon><visible>true</visible><display-type>list</display-type></index>"; //$NON-NLS-1$
repository.addSolutionFile(PentahoSystem.getApplicationContext().getSolutionPath(""), path + RepositoryFile.SEPARATOR + name,
SolutionRepositoryBase.INDEX_FILENAME, defaultIndex
.getBytes(), true);
repository.reloadSolutionRepository( userSession, repository.getLoggingLevel() );
CacheManager cacheManager = PentahoSystem.getCacheManager();
if (null != cacheManager) {
cacheManager.removeFromSessionCache(userSession, repository.getRootFolder().getFileName());
}
}
private boolean acceptFilter(String name, String[] filters) {
if (filters == null || filters.length == 0) {
return true;
}
for (int i = 0; i < filters.length; i++) {
if (name.endsWith(filters[i])) {
return true;
}
}
return false;
}
private void processRepositoryFile(Element parentElement, ISolutionFile parentFile, IFileFilter permissionFilter, String[] filters) {
ISolutionFile children[] = parentFile.listFiles(permissionFilter);
for (int i = 0; children != null && i < children.length; i++) {
String name = children[i].getFileName();
if (!name.startsWith(".") && (children[i].isDirectory() || acceptFilter(name, filters))) { //$NON-NLS-1$
Element child = parentElement.addElement("file"); //$NON-NLS-1$
child.addAttribute("name", name); //$NON-NLS-1$
child.addAttribute("isDirectory", "" + children[i].isDirectory()); //$NON-NLS-1$
child.addAttribute("lastModifiedDate", "" + children[i].getLastModified()); //$NON-NLS-1$
if (children[i].isDirectory()) {
processRepositoryFile(child, children[i], permissionFilter, filters);
}
}
}
}
private Document getSolutionRepositoryDoc(IPentahoSession userSession, String[] filters) {
ISolutionRepository repository = PentahoSystem.getSolutionRepository(userSession);
PermissionFilter permissionFilter = new PermissionFilter(repository);
ISolutionFile rootFile = repository.getRootFolder();
Document document = null;
CacheManager cacheManager = PentahoSystem.getCacheManager();
if (null != cacheManager) {
document = (Document) cacheManager.getFromSessionCache(userSession, rootFile.getFileName());
if (document == null) {
document = DocumentHelper.createDocument();
Element root = document.addElement("repository");
root.addAttribute("path", rootFile.getFullPath());
processRepositoryFile(root, rootFile, permissionFilter, filters);
cacheManager.putInSessionCache(userSession, rootFile.getFileName(), document);
}
} else {
document = DocumentHelper.createDocument();
Element root = document.addElement("repository");
root.addAttribute("path", rootFile.getFullPath());
processRepositoryFile(root, rootFile, permissionFilter, filters);
}
return document;
}
private void getAcl(IParameterProvider parameterProvider, OutputStream outputStream,
IPentahoSession userSession, boolean wrapWithSOAP) throws SolutionRepositoryServiceException, IOException
{
String solution = parameterProvider.getStringParameter("solution", null); //$NON-NLS-1$
String path = parameterProvider.getStringParameter("path", null); //$NON-NLS-1$
String filename = parameterProvider.getStringParameter("filename", null); //$NON-NLS-1$
if ( StringUtil.doesPathContainParentPathSegment( solution )
|| StringUtil.doesPathContainParentPathSegment( path ) ) {
String msg = Messages.getString( "AdhocWebService.ERROR_0008_MISSING_OR_INVALID_REPORT_NAME" ); //$NON-NLS-1$
throw new SolutionRepositoryServiceException( msg );
}
ISolutionRepository repository = PentahoSystem.getSolutionRepository(userSession);
String fullPath = WebServiceUtil.buildSolutionPath( solution, path, filename );
ISolutionFile solutionFile = repository.getFileByPath( fullPath );
String strXml = null;
//ouch, i hate instanceof
if ( solutionFile instanceof IAclSolutionFile ) {
Map <IPermissionRecipient, IPermissionMask> filePermissions = repository.getPermissions((solutionFile));
String processingInstruction = CleanXmlHelper.createXmlProcessingInstruction( RESPONSE_DOCUMENT_VERSION_NUM, RESPONSE_DOCUMENT_ENCODING );
strXml = processingInstruction + getAclAsXml( filePermissions );
}
else
{
strXml = "<acl notsupported='true'/>"; //$NON-NLS-1$
}
WebServiceUtil.writeString( outputStream, strXml, false );
}
// TODO sbarkdull, this method belongs in an AclUtils class?
// turn acl into an XML representation, and return the document.
// probably belongs in the SecurityUtils class, but does this class still exist?
String getAclAsXml( Map<IPermissionRecipient, IPermissionMask> filePermissions )
{
StringBuffer sb = new StringBuffer( CleanXmlHelper.createXmlProcessingInstruction( RESPONSE_DOCUMENT_VERSION_NUM, RESPONSE_DOCUMENT_ENCODING));
sb.append( "<acl>" );
for (Map.Entry<IPermissionRecipient, IPermissionMask> filePerm : filePermissions.entrySet()) {
IPermissionRecipient permRecipient = filePerm.getKey();
if (permRecipient instanceof SimpleRole) {
sb.append( "<entry role='" + permRecipient.getName()
+ "' permissions='" + filePerm.getValue().getMask() + "'/>" );
} else {
// entry belongs to a user
sb.append( "<entry user='" + permRecipient.getName()
+ "' permissions='" + filePerm.getValue().getMask() + "'/>" );
}
}
sb.append( "</acl>" );
return sb.toString();
}
Map<IPermissionRecipient, IPermissionMask> createAclFromXml( String strXml ) throws ParserConfigurationException, SAXException, IOException
{
SAXParser parser = SolutionRepositoryService.getSAXParserFactory().newSAXParser();
Map<IPermissionRecipient, IPermissionMask> m = new HashMap<IPermissionRecipient, IPermissionMask>();
DefaultHandler h = new AclParserHandler( m );
String encoding = CleanXmlHelper.getEncoding( strXml );
InputStream is = new ByteArrayInputStream( strXml.getBytes( encoding ) );
parser.parse(is, h );
return m;
}
private class AclParserHandler extends DefaultHandler {
Map<IPermissionRecipient, IPermissionMask> acl;
public AclParserHandler( Map<IPermissionRecipient, IPermissionMask> acl )
{
this.acl = acl;
}
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException
{
if ( qName.equalsIgnoreCase( "entry" ) ) {
PentahoAclEntry entry = null;
String permissions = (String)attributes.getValue("", "permissions" );
IPermissionRecipient permRecipient = null;
String user = (String)attributes.getValue("", "user" );
if (null != user) {
permRecipient = new SimpleUser(user);
} else {
permRecipient = new SimpleRole((String)attributes.getValue("", "role" ));
}
this.acl.put(permRecipient, new SimplePermissionMask(Integer.parseInt( permissions )));
}
}
}
private void setAcl(IParameterProvider parameterProvider, OutputStream outputStream,
IPentahoSession userSession, boolean wrapWithSOAP) throws SolutionRepositoryServiceException, IOException, PentahoAccessControlException
{
String solution = parameterProvider.getStringParameter("solution", null); //$NON-NLS-1$ //$NON-NLS-2$
String path = parameterProvider.getStringParameter("path", null); //$NON-NLS-1$ //$NON-NLS-2$
String filename = parameterProvider.getStringParameter("filename", null); //$NON-NLS-1$
String strAclXml = parameterProvider.getStringParameter("aclXml", null); //$NON-NLS-1$
if ( StringUtil.doesPathContainParentPathSegment( solution )
|| StringUtil.doesPathContainParentPathSegment( path ) ) {
String msg = Messages.getString( "AdhocWebService.ERROR_0008_MISSING_OR_INVALID_REPORT_NAME" ); //$NON-NLS-1$
throw new SolutionRepositoryServiceException( msg );
}
ISolutionRepository repository = PentahoSystem.getSolutionRepository(userSession);
String fullPath = WebServiceUtil.buildSolutionPath( solution, path, filename );
ISolutionFile solutionFile = repository.getFileByPath( fullPath );
//ouch, i hate instanceof
if ( solutionFile instanceof IAclSolutionFile ) {
Map<IPermissionRecipient, IPermissionMask> acl;
try {
acl = createAclFromXml( strAclXml );
// TODO sbarkdull, fix these really really lame exception msgs
} catch (ParserConfigurationException e) {
throw new SolutionRepositoryServiceException( "ParserConfigurationException", e );
} catch (SAXException e) {
throw new SolutionRepositoryServiceException( "SAXException", e );
} catch (IOException e) {
throw new SolutionRepositoryServiceException( "IOException", e );
}
repository.setPermissions(solutionFile, acl);
}
// TODO sbarkdull, what if its not instanceof
String msg = WebServiceUtil.getStatusXml( Messages.getString("AdhocWebService.ACL_UPDATE_SUCCESSFUL") ); //$NON-NLS-1$
WebServiceUtil.writeString( outputStream, msg, false );
}
/**
* Get a SAX Parser Factory
*
* NOTE: Need sax parser factory per thread for thread safety.
* See: http://java.sun.com/j2se/1.5.0/docs/api/javax/xml/parsers/SAXParserFactory.html
* @return
*/
public static SAXParserFactory getSAXParserFactory() {
SAXParserFactory threadLocalSAXParserFactory = SAX_FACTORY.get();
if ( null == threadLocalSAXParserFactory )
{
threadLocalSAXParserFactory = SAXParserFactory.newInstance();
SAX_FACTORY.set( threadLocalSAXParserFactory );
}
return threadLocalSAXParserFactory;
}
}
The table below shows all metrics for SolutionRepositoryService.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 57.00 | Number of blocks | |
| BLOCK_COMMENT | 16.00 | Number of block comment lines | |
| COMMENTS | 43.00 | Comment lines | |
| COMMENT_DENSITY | 0.17 | Comment density | |
| COMPARISONS | 33.00 | Number of comparison operators | |
| CYCLOMATIC | 54.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 5.00 | Comments in declarations | |
| DOC_COMMENT | 18.00 | Number of javadoc comment lines | |
| ELOC | 254.00 | Effective lines of code | |
| EXEC_COMMENTS | 7.00 | Comments in executable code | |
| EXITS | 86.00 | Procedure exits | |
| FUNCTIONS | 18.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 72.06 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 90.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 | 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 | 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 | 0.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 | 1.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 1.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 | 1.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 | 3.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 | 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 | 3.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 | 1.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 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 1.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 | 6.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.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 | 1.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 3.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 | 1.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 | 400.00 | Number of lines in the source file | |
| LINE_COMMENT | 9.00 | Number of line comments | |
| LOC | 308.00 | Lines of code | |
| LOGICAL_LINES | 188.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 1023.00 | Number of operands | |
| OPERATORS | 1555.00 | Number of operators | |
| PARAMS | 40.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2578.00 | Halstead program length | |
| PROGRAM_VOCAB | 413.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 50.00 | Number of return points from functions | |
| SIZE | 18235.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 362.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 51.00 | Number of unique operators | |
| WHITESPACE | 49.00 | Number of whitespace lines | |