WebdavUtils.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.slide.webdav.util |
 |
 |
Jakarta Slide |
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 |  |
| EXEC_COMMENTS | Comments in executable code | |
| LINE_COMMENT | Number of line comments | |
| CYCLOMATIC | Cyclomatic complexity | |
| COMPARISONS | Number of comparison operators | |
| SIZE | Size of the file in bytes | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| EXITS | Procedure exits | |
| BLOCKS | Number of blocks | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| RETURNS | Number of return points from functions | |
| OPERANDS | Number of operands | |
| COMMENTS | Comment lines | |
| LINES | Number of lines in the source file | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| PROGRAM_LENGTH | Halstead program length | |
| ELOC | Effective lines of code | |
| OPERATORS | Number of operators | |
| LOGICAL_LINES | Number of statements | |
| JAVA0067 | JAVA0067 Array descriptor on identifier name | |
| PARAMS | Number of formal parameter declarations | |
| LOC | Lines of code | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| JAVA0076 | JAVA0076 Use of magic number | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| JAVA0265 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* $Header$
* $Revision: 208614 $
* $Date: 2005-05-27 13:20:19 -0400 (Fri, 27 May 2005) $
*
* ====================================================================
*
* Copyright 1999-2002 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.slide.webdav.util;
import java.net.SocketException;
import java.security.Principal;
import java.util.Enumeration;
import java.io.UnsupportedEncodingException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import org.apache.slide.authenticate.CredentialsToken;
import org.apache.slide.common.Domain;
import org.apache.slide.common.NamespaceAccessToken;
import org.apache.slide.common.ServiceAccessException;
import org.apache.slide.common.SlideException;
import org.apache.slide.common.SlideToken;
import org.apache.slide.common.SlideTokenImpl;
import org.apache.slide.content.Content;
import org.apache.slide.content.InsufficientStorageException;
import org.apache.slide.content.NodeRevisionDescriptor;
import org.apache.slide.content.NodeRevisionDescriptors;
import org.apache.slide.event.VetoException;
import org.apache.slide.lock.ObjectLockedException;
import org.apache.slide.macro.ConflictException;
import org.apache.slide.macro.ForbiddenException;
import org.apache.slide.security.AccessDeniedException;
import org.apache.slide.security.UnauthenticatedException;
import org.apache.slide.structure.ObjectAlreadyExistsException;
import org.apache.slide.structure.ObjectNotFoundException;
import org.apache.slide.util.Configuration;
import org.apache.slide.util.logger.Logger;
import org.apache.slide.webdav.WebdavException;
import org.apache.slide.webdav.WebdavServletConfig;
import org.apache.slide.webdav.method.MethodNotAllowedException;
/**
* A collection of various utility and convenience methods.
*
*
* @version $Revision: 208614 $
**/
public class WebdavUtils {
private static final String CREDENTIALS_ATTRIBUTE =
"org.apache.slide.webdav.method.credentials";
private static final String LOG_CHANNEL =
WebdavUtils.class.getName();
/**
* Constructs a new String based on bytes sequence contained
* in the
* Non-ASCII parts of the sequence will be decoded with UTF-8
* if possible, or with the specified encoding.
*
* @param string A "String" returned by tomcat getPathInfo()
* @param enc Encoding to use if non UTF-8
* @return A properly encoded String object
*/
public static String decodeString(String string, String enc)
throws UnsupportedEncodingException {
if(string == null)
return null;
StringBuffer sb = null;
int j = 0;
int sf = 0;
sb = new StringBuffer();
byte utf8buffer[] = new byte[5];
// Get bytes without any decoding
byte bytes[] = string.getBytes("ISO-8859-1");
for (int i = 0; i < bytes.length; i+=1) {
byte b = bytes[i];
int bb = (b >= 0) ? b : b+256;
utf8buffer[j++] = b;
boolean ok = false;
// First test if non-ascii
if (bb >= 128) {
// No ongoing UTF-8 decoding ?
if (sf==0) {
// Now test if this can be a UTF-8 first byte
if (bb >= 192 && i < 252) {
ok = true;
// Determine UTF-8 size
if (bb >= 224)
if (bb >= 240)
if (bb >= 248)
sf = 4;
else
sf = 3;
else
sf = 2;
else
sf = 1;
}
} else if (bb >= 128 && bb < 192) {
// This is a UTF-8 part
sf--;
if (sf == 0) {
sb.append(new String(utf8buffer,0,j,"UTF-8"));
j = 0;
}
ok = true;
}
}
// If there was an error during UTF-8 decoding, decode all remaining chars with default encoding
if (!ok) {
sb.append(new String(utf8buffer,0,j, enc));
j = 0;
sf = 0;
}
}
// Remaining chars
if (j > 0) {
sb.append(new String(utf8buffer,0,j, enc));
}
return sb.toString();
}
/**
* Return a context-relative path, beginning with a "/", that represents
* the canonical version of the specified path after ".." and "." elements
* are resolved out. If the specified path attempts to go outside the
* boundaries of the current context (i.e. too many ".." path elements
* are present), return <code>null</code> instead.
*
* @param path the path to be normalized
**/
public static String normalizeURL(String path) {
if (path == null)
return null;
String normalized = path;
if (normalized == null)
return (null);
// Normalize the slashes and add leading slash if necessary
if (normalized.indexOf('\\') >= 0)
normalized = normalized.replace('\\', '/');
if (!normalized.startsWith("/"))
normalized = "/" + normalized;
// Resolve occurrences of "//" in the normalized path
while (true) {
int index = normalized.indexOf("//");
if (index < 0)
break;
normalized = normalized.substring(0, index) +
normalized.substring(index + 1);
}
// Resolve occurrences of "/./" in the normalized path
while (true) {
int index = normalized.indexOf("/./");
if (index < 0)
break;
normalized = normalized.substring(0, index) +
normalized.substring(index + 2);
}
// Resolve occurrences of "/../" in the normalized path
while (true) {
int index = normalized.indexOf("/../");
if (index < 0)
break;
if (index == 0)
return (null); // Trying to go outside our context
int index2 = normalized.lastIndexOf('/', index - 1);
normalized = normalized.substring(0, index2) +
normalized.substring(index + 3);
}
normalized = normalized.replace('?','_');
// Return the normalized path that we have completed
return (normalized);
}
/**
* URL rewriter.
*
* @param path the path to be rewritten
**/
public static String encodeURL(String path) {
return URLUtil.URLEncode(path, Configuration.realUrlEncoding());
}
/**
* URL rewriter.
*
* @param path the path to be rewritten
* @param enc the encoding
**/
public static String encodeURL(String path, String enc) {
return URLUtil.URLEncode(path, enc);
}
/**
* Maps the URI of a node in the Slide namespace to an external URI as seen
* by clients. This involves adding the context and servlet path to the
* URI.
*
* @param uri the node's URI
* @param config configuration of the WebdavServlet
*
* @return the node's URI as absolute path
**/
public static String getAbsolutePath
(String uri, HttpServletRequest req, WebdavServletConfig config)
{
return getAbsolutePath (uri, req.getContextPath(), req.getServletPath(), config);
}
/**
* Maps the URI of a node in the Slide namespace to an external URI as seen
* by clients. This involves adding the context and servlet path to the
* URI.
*
* @param uri the node's URI
* @param servletPath a String, the result of HttpRequest.getServletPath()
* @param contextPath a String , the result of HttpRequest.getContextPath()
* @param config configuration of the WebdavServlet
*
* @return a String
*
*/
public static String getAbsolutePath (String uri, String contextPath,
String servletPath,
WebdavServletConfig config)
{
String result = uri;
String scope = config.getScope();
int scopeLength = scope.length();
if (scopeLength > 0 && uri.startsWith(scope)) {
result = uri.substring(scopeLength);
}
if (!config.isDefaultServlet()) {
contextPath += servletPath;
}
result = contextPath + result;
return encodeURL(result);
}
public static String getAbsolutePath (String uri, String slideContextPath,
WebdavServletConfig config)
{
String result = uri;
String scope = config.getScope();
int scopeLength = scope.length();
if (scopeLength > 0 && uri.startsWith(scope)) {
result = uri.substring(scopeLength);
}
result = slideContextPath + result;
return encodeURL(result);
}
public static String getAbsolutePath (String uri, WebdavContext context)
{
String result = uri;
String scope = context.getServletConfig().getScope();
int scopeLength = scope.length();
if (scopeLength > 0 && uri.startsWith(scope)) {
result = uri.substring(scopeLength);
}
result = context.getContextPath() + result;
return encodeURL(result);
}
/**
* Maps the request URI of a HTTP request to a URI in the Slide namespace
* (this does not necessarily mean that a node exists at that URI).
*
* @param req the request object
* @param config configuration of the WebdavServlet
*
* @return the request URI mapped into the Slide namespace
**/
public static String getRelativePath
(HttpServletRequest req, WebdavServletConfig config) {
// get the requested path, depending on whether the servlet is mapped
// as default servlet.
String result = null;
String pathMapperClassName = config.getInitParameter("path-mapper-hook");
if (pathMapperClassName != null) {
try {
Class storeClass = Class.forName(pathMapperClassName);
PathMapper mapper = (PathMapper) storeClass.newInstance();
result = mapper.map(req, config);
} catch (Exception e) {
Domain.log(e, LOG_CHANNEL, Logger.WARNING);
}
}
if (result == null) {
PathMapper mapper = (PathMapper) config.getServletContext().getAttribute(
"org.apache.slide.webdav.util.PathMapper");
if (mapper != null) {
result = mapper.map(req, config);
}
}
if (result == null) {
if (config.isDefaultServlet()) {
result = req.getServletPath();
} else {
result = req.getRequestURI();
result = result.substring(req.getContextPath().length()+ req.getServletPath().length());
}
}
// default to the namespace root if no path-info is specified
if ((result == null) || (result.length() == 0)) {
result = "/";
}
// prefix the URI with the configured scope
result = config.getScope() + result;
result = normalizeURL(fixTomcatURL(result)); // the request URL is utf-8 encoded
return result;
}
/**
* Returns an URL based on input. The input URL is encoded with "fromEncoding".
* The resulting URL is encoded as specified in Configuration.urlEncoding()
*
* @param input the input URL
*
* @return a new URL encoded in Configuration.urlEncoding()
**/
public static String fixTomcatURL(String input) {
return fixTomcatHeader(input, "UTF-8");
}
/**
* Returns an decoded header value. The input header is encoded with "ISO-8859-1".
* The resulting header is encoded as specified in toEncoding
*
* @param header the input header
* @param toEncoding the target encoding of the header
*
* @return a new header value encoded in toEncoding
**/
public static String fixTomcatHeader(String header, String toEncoding) {
// todo: toEncoding parameter not used anymore
if (header == null) return null;
String result = null;
try {
result = URLUtil.URLDecode(header.getBytes("ISO-8859-1"),"ISO-8859-1");
result = decodeString(result,Configuration.urlEncoding());
if (!Configuration.useUTF8()) {
// Remove unsupported characters
result = new String(result.getBytes(Configuration.urlEncoding()),Configuration.urlEncoding());
}
} catch (Exception e) { e.printStackTrace(); }
return result;
}
/**
* Returns a SlideToken using the authentication information of an HTTP
* request.
*
* @param req the HTTP request
*
* @return a new SlideToken instance
**/
public static SlideToken getSlideToken(HttpServletRequest req) {
CredentialsToken credentialsToken;
Principal principal = req.getUserPrincipal();
HttpSession session = req.getSession();
// store the current principal in the session, to get around a bug in
// IE 5 where the authentication info is not submitted by IE when
// doing a HEAD request.
if (principal == null) {
final String credentials = (String) session.getAttribute(CREDENTIALS_ATTRIBUTE);
credentialsToken = new CredentialsToken(credentials == null ? "" : credentials);
} else {
// because the principal is not guaranteed to be serializable
// and could thus create problems in a distributed deployment
// we store the principal name instead of the principal itself
session.setAttribute(CREDENTIALS_ATTRIBUTE, principal.getName());
credentialsToken = new CredentialsToken(principal);
}
SlideToken token = new SlideTokenImpl(credentialsToken);
token.setEnforceLockTokens(true);
// store session attributes in token parameters to pass them through
// to the stores
for(Enumeration e = session.getAttributeNames(); e.hasMoreElements();) {
String name = (String)e.nextElement();
token.addParameter(name, session.getAttribute(name));
}
return token;
}
/**
* Tests whether a given path maps to a URI in the Slide namespace that
* identifies a collection resource.
*
* @param token the namespace access token
* @param slideToken the slide token
* @param path relative path of the resource
*
* @return true if the requested resource is a collection, false otherwise
**/
public static boolean isCollection
(NamespaceAccessToken token, SlideToken slideToken,
String path) {
// Added for DeltaV --start--
if( Configuration.useVersionControl() ) {
UriHandler uh = UriHandler.getUriHandler( path );
if( uh.isWorkspaceUri() )
return true;
if( uh.isHistoryUri() )
return true;
if( uh.isVersionUri() )
return false;
}
// Added for DeltaV --end--
try {
Content content = token.getContentHelper();
NodeRevisionDescriptors revisionDescriptors =
content.retrieve(slideToken, path);
if (revisionDescriptors.hasRevisions()) {
NodeRevisionDescriptor revisionDescriptor =
content.retrieve(slideToken, revisionDescriptors);
return isCollection(revisionDescriptor);
} else {
return true;
}
} catch(ObjectNotFoundException e) {
// if the Object is not found return false for no 207 is generated
return false;
} catch(SlideException e) {
// this is the default
return true;
}
}
/**
* Tests whether a resource is a collection resource.
*
* @param revisionDescriptor revision descriptor of the resource
*
* @return true if the descriptor represents a collection, false otherwise
**/
public static boolean isCollection
(NodeRevisionDescriptor revisionDescriptor) {
boolean result = false;
if (revisionDescriptor == null)
return true;
if (revisionDescriptor.propertyValueContains(
NodeRevisionDescriptor.RESOURCE_TYPE ,"collection")) {
result = true;
}
return result;
}
/**
* Tests whether a resource is a redirect reference.
*
* @param revisionDescriptor revision descriptor of the resource
*
* @return <code>true</code> if the descriptor represents a redirect
* reference, <code>false</code> otherwise.
*/
public static boolean isRedirectref
(NodeRevisionDescriptor revisionDescriptor) {
if (revisionDescriptor == null)
return false;
return revisionDescriptor.propertyValueContains(
NodeRevisionDescriptor.RESOURCE_TYPE, "redirectref");
}
public static String getSlidePath(String fullpath, String slideContextPath) {
// strip off the protocol://host:port part
if (fullpath.indexOf("://") >= 0) {
fullpath=fullpath.substring(fullpath.indexOf("://")+3);
fullpath=fullpath.substring(fullpath.indexOf("/"));
}
// strip off the servlet context path
if (fullpath.startsWith(slideContextPath)) {
fullpath=fullpath.substring(slideContextPath.length());
}
return fullpath;
}
/**
* Get return status based on exception type.
*/
public static int getErrorCode(Throwable ex) {
if ( !(ex instanceof SlideException) ) {
// if( ex != null ) ex.printStackTrace();
return WebdavStatus.SC_INTERNAL_SERVER_ERROR;
} else {
return getErrorCode((SlideException)ex);
}
}
/**
* Get return status based on exception type.
*/
public static int getErrorCode(SlideException ex) {
try {
throw ex;
} catch(ObjectNotFoundException e) {
return WebdavStatus.SC_NOT_FOUND;
} catch(ConflictException e) {
return WebdavStatus.SC_CONFLICT;
} catch(ForbiddenException e) {
return WebdavStatus.SC_FORBIDDEN;
} catch(AccessDeniedException e) {
return WebdavStatus.SC_FORBIDDEN;
} catch(UnauthenticatedException e) {
return WebdavStatus.SC_UNAUTHORIZED;
} catch(ObjectAlreadyExistsException e) {
return WebdavStatus.SC_PRECONDITION_FAILED;
} catch(ServiceAccessException e) {
return getErrorCode((ServiceAccessException)ex);
} catch(ObjectLockedException e) {
return WebdavStatus.SC_LOCKED;
} catch(WebdavException e) {
return e.getStatusCode();
} catch(MethodNotAllowedException e) {
return WebdavStatus.SC_METHOD_NOT_ALLOWED;
} catch(InsufficientStorageException e) {
return WebdavStatus.SC_INSUFFICIENT_STORAGE;
} catch(VetoException e) {
if (e != e.getCause()) {
return getErrorCode(e.getCause());
}
return WebdavStatus.SC_NOT_ACCEPTABLE;
} catch(SlideException e) {
return WebdavStatus.SC_INTERNAL_SERVER_ERROR;
}
}
/**
* Get return status based on exception type.
*/
public static int getErrorCode(ServiceAccessException ex) {
Throwable cause = ex.getCauseException();
// XXX SocketException pops up when the client closes the connection in the middle of transferring
// the HTTP body, so this is no internal error, really!
if (cause != null && cause instanceof SocketException) {
// XXX is this a reasonable code?
return WebdavStatus.SC_PRECONDITION_FAILED;
} else if (cause == null || !(cause instanceof SlideException)) {
// ex.printStackTrace();
if( cause != null ) cause.printStackTrace();
return WebdavStatus.SC_INTERNAL_SERVER_ERROR; // this is the default}
} else {
return getErrorCode((SlideException)cause);
}
}
}
The table below shows all metrics for WebdavUtils.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 78.00 | Number of blocks | |
| BLOCK_COMMENT | 22.00 | Number of block comment lines | |
| COMMENTS | 187.00 | Comment lines | |
| COMMENT_DENSITY | 0.64 | Comment density | |
| COMPARISONS | 66.00 | Number of comparison operators | |
| CYCLOMATIC | 98.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 18.00 | Comments in declarations | |
| DOC_COMMENT | 127.00 | Number of javadoc comment lines | |
| ELOC | 294.00 | Effective lines of code | |
| EXEC_COMMENTS | 31.00 | Comments in executable code | |
| EXITS | 65.00 | Procedure exits | |
| FUNCTIONS | 19.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 78.19 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 83.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 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 1.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 22.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 2.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 | 4.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 | 4.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 6.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 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 1.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 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 1.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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1.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 | 2.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 | 1.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 | 1.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 | 615.00 | Number of lines in the source file | |
| LINE_COMMENT | 38.00 | Number of line comments | |
| LOC | 352.00 | Lines of code | |
| LOGICAL_LINES | 180.00 | Number of statements | |
| LOOPS | 5.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 857.00 | Number of operands | |
| OPERATORS | 1534.00 | Number of operators | |
| PARAMS | 34.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2391.00 | Halstead program length | |
| PROGRAM_VOCAB | 324.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 49.00 | Number of return points from functions | |
| SIZE | 21788.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 274.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 50.00 | Number of unique operators | |
| WHITESPACE | 76.00 | Number of whitespace lines | |