ConnectionEngine.java
| Index Score | ||
|---|---|---|
 |
 |
phex.connection |
 |
 |
Phex |
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 |  |
| EXEC_COMMENTS | Comments in executable code | |
| COMPARISONS | Number of comparison operators | |
| SIZE | Size of the file in bytes | |
| LOC | Lines of code | |
| LINE_COMMENT | Number of line comments | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| ELOC | Effective lines of code | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| LOGICAL_LINES | Number of statements | |
| BLOCKS | Number of blocks | |
| LINES | Number of lines in the source file | |
| CYCLOMATIC | Cyclomatic complexity | |
| UNIQUE_OPERATORS | Number of unique operators | |
| RETURNS | Number of return points from functions | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0076 | JAVA0076 Use of magic number | |
| DOC_COMMENT | Number of javadoc 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 | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* PHEX - The pure-java Gnutella-servent.
* Copyright (C) 2001 - 2008 Phex Development Group
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* --- SVN Information ---
* $Id: ConnectionEngine.java 4205 2008-06-18 09:49:16Z gregork $
*/
package phex.connection;
import java.io.IOException;
import java.util.StringTokenizer;
import phex.common.address.AddressUtils;
import phex.common.address.DefaultDestAddress;
import phex.common.address.DestAddress;
import phex.common.address.IpAddress;
import phex.common.address.MalformedDestAddressException;
import phex.common.log.NLogger;
import phex.connection.handshake.HandshakeHandler;
import phex.connection.handshake.HandshakeStatus;
import phex.host.CaughtHostsContainer;
import phex.host.Host;
import phex.host.HostStatus;
import phex.http.GnutellaHeaderNames;
import phex.http.HTTPHeader;
import phex.http.HTTPHeaderGroup;
import phex.http.HTTPHeaderNames;
import phex.http.HTTPProcessor;
import phex.io.buffer.ByteBuffer;
import phex.msg.InvalidMessageException;
import phex.msg.Message;
import phex.msg.MessageProcessor;
import phex.msg.MsgHeader;
import phex.msg.vendor.CapabilitiesVMsg;
import phex.msg.vendor.MessagesSupportedVMsg;
import phex.msghandling.MessageService;
import phex.net.connection.Connection;
import phex.net.repres.PresentationManager;
import phex.prefs.core.MessagePrefs;
import phex.query.DynamicQueryConstants;
import phex.security.AccessType;
import phex.security.PhexSecurityManager;
import phex.servent.Servent;
import phex.utils.HexConverter;
import phex.utils.Localizer;
/**
* <p>A worker that handles the communication between this and another gnutella
* node.</p>
*
* <p>The remote node is represented as a Host object. Depending on whether the
* host is in incoming or outgoing mode, this will perform the relevant
* handshake negotiations. If this was an
* outgoing connection, or during negotiations it becomes clear that the Host
* wishes to partake in a Gnutella network, then enter a message handling loop
* to forward all messages as necessary. This will usualy result in a message
* being read, some bookkeeping to keep track of the message, discarding bad
* messages and finally queuing a request with the Message Manager to pass on any
* messages that must be generated in response.</p>
*/
public class ConnectionEngine implements ConnectionConstants
{
private final Servent servent;
private final MessageService messageService;
private final PhexSecurityManager securityService;
/**
* pre-allocated buffer for repeated uses.
*/
private byte[] headerBuffer;
private final Host connectedHost;
private final Connection connection;
private HTTPHeaderGroup headersRead;
private HTTPHeaderGroup headersSend;
public ConnectionEngine( Servent servent, Host connectedHost )
{
this.servent = servent;
this.messageService = servent.getMessageService();
this.securityService = servent.getSecurityService();
this.connectedHost = connectedHost;
this.connection = connectedHost.getConnection();
}
public void processIncomingData()
throws IOException
{
headerBuffer = new byte[ MsgHeader.DATA_LENGTH ];
try
{
while ( true )
{
MsgHeader header = readHeader();
byte[] body = MessageProcessor.readMessageBody( connection,
header.getDataLength() );
connectedHost.incReceivedCount();
int ttl = header.getTTL();
int hops = header.getHopsTaken();
// verify valid ttl and hops data
if ( ttl < 0 || hops < 0 )
{
messageService.dropMessage( header, body,
"TTL or hops below 0", connectedHost );
continue;
}
// if message traveled too far already... drop it.
if ( hops > MessagePrefs.MaxNetworkTTL.get().intValue() )
{
messageService.dropMessage( header, body,
"Hops larger then maxNetworkTTL", connectedHost );
continue;
}
// limit TTL if too high!
if ( ttl >= MessagePrefs.MaxNetworkTTL.get().intValue() )
{
header.setTTL( (byte)(MessagePrefs.MaxNetworkTTL.get().intValue() - hops) );
}
Message message;
try
{
message = MessageProcessor.createMessageFromBody(
header, body, securityService );
if ( message == null )
{ // unknown message type...
messageService.dropMessage( header, body,
"Unknown message type", connectedHost );
continue;
}
}
catch ( InvalidMessageException exp )
{
messageService.dropMessage( header, body,
"Invalid message: " + exp.getMessage(), connectedHost );
NLogger.warn( ConnectionEngine.class, exp, exp );
continue;
}
// count the hop and decrement TTL...
header.countHop();
messageService.dispatchMessage( message, connectedHost );
}
}
catch ( IOException exp )
{
NLogger.debug( ConnectionEngine.class, exp, exp );
if ( connectedHost.isConnected() )
{
connectedHost.setStatus( HostStatus.ERROR, exp.getMessage());
connectedHost.disconnect();
}
throw exp;
}
catch ( Exception exp )
{
NLogger.warn( ConnectionEngine.class, exp, exp );
if (connectedHost.isConnected() )
{
connectedHost.setStatus( HostStatus.ERROR, exp.getMessage());
connectedHost.disconnect();
}
throw new IOException( "Exception occured: " + exp.getMessage() );
}
}
private MsgHeader readHeader()
throws IOException
{
MsgHeader header = MessageProcessor.parseMessageHeader( connection,
headerBuffer );
if ( header == null )
{
throw new ConnectionClosedException("Connection closed by remote host");
}
int length = header.getDataLength();
if ( length < 0 )
{
throw new IOException( "Negative body size. Disconnecting the remote host." );
}
else if ( length > MessagePrefs.MaxLength.get().intValue() )
{
// Packet looks suspiciously too big. Disconnect them.
if ( NLogger.isWarnEnabled( ConnectionEngine.class ) )
{
// max 256KB when over 64KB max message length
byte[] body = MessageProcessor.readMessageBody(
connection, 262144 );
String hexBody = HexConverter.toHexString( body );
NLogger.warn( ConnectionEngine.class, connectedHost +
" - Body too big. Header: " + header + "\nBody(256KB): " + hexBody );
}
throw new IOException("Packet too big. Disconnecting the remote host.");
}
header.setArrivalTime( System.currentTimeMillis() );
header.setFromHost( connectedHost );
return header;
}
//////////////////// Connection Intialization //////////////////////////////
public void initHostHandshake( )
throws IOException
{
try
{
if ( connectedHost.isIncomming() )
{
initializeIncomingWith06();
}
else
{
initializeOutgoingWith06();
}
configureConnectionType( headersSend, headersRead );
postHandshakeConfiguration( headersSend, headersRead );
}
finally
{
if ( headersRead != null )
{
// use the connection header whether connection was ok or not
handleXTryHeaders( headersRead );
// give free to gc
headersRead = null;
headersSend = null;
}
}
// Connection to remote gnutella host is completed at this point.
connectedHost.setStatus( HostStatus.CONNECTED );
if ( connectedHost.isIncomming() )
{
servent.getHostService().addIncomingHost( connectedHost );
}
else
{
servent.getHostService().addConnectedHost( connectedHost );
}
// send UDP ping as soon as we have recognized host
servent.getMessageService().sendUdpPing( connectedHost.getHostAddress() );
// queue first Ping msg to send.
// add ping routing to local host to track my initial pings...
servent.getMessageService().pingHost( connectedHost,
MessagePrefs.TTL.get().byteValue() );
// after initial handshake ping send message supported VM.
if ( connectedHost.isVendorMessageSupported( ) )
{
MessagesSupportedVMsg vMsg = MessagesSupportedVMsg.getMyMsgSupported();
connectedHost.queueMessageToSend( vMsg );
CapabilitiesVMsg capVMsg = CapabilitiesVMsg.getMyCapabilitiesVMsg();
connectedHost.queueMessageToSend( capVMsg );
}
}
private void initializeIncomingWith06()
throws IOException
{
// read connect headers
headersRead = HTTPProcessor.parseHTTPHeaders( connection );
if ( NLogger.isDebugEnabled( ConnectionEngine.class ) )
{
NLogger.debug( ConnectionEngine.class, connectedHost +
" - Connect headers: " + headersRead.buildHTTPHeaderString() );
}
configureRemoteHost( headersRead );
// create appropriate handshake handler that takes care about headers
// and logic...
HandshakeHandler handshakeHandler = HandshakeHandler.createHandshakeHandler(
servent, connectedHost );
HandshakeStatus myResponse = handshakeHandler.createHandshakeResponse(
new HandshakeStatus( headersRead ), false );
headersSend = myResponse.getResponseHeaders();
// send answer to host...
sendStringToHost( GNUTELLA_06 + " " + myResponse.getStatusCode() + " " +
myResponse.getStatusMessage() + "\r\n" );
String httpHeaderString = myResponse.getResponseHeaders().buildHTTPHeaderString();
sendStringToHost( httpHeaderString );
sendStringToHost( "\r\n" );
if ( myResponse.getStatusCode() != STATUS_CODE_OK )
{
throw new IOException( "Connection not accepted: " +
myResponse.getStatusCode() + " " + myResponse.getStatusMessage() );
}
HandshakeStatus inResponse = HandshakeStatus.parseHandshakeResponse(
connection );
if ( NLogger.isDebugEnabled( ConnectionEngine.class ) )
{
NLogger.debug( ConnectionEngine.class, connectedHost +
" - Response Code: '" + inResponse.getStatusCode() + "'." );
NLogger.debug( ConnectionEngine.class, connectedHost +
" - Response Message: '" + inResponse.getStatusMessage() + "'." );
NLogger.debug( ConnectionEngine.class, connectedHost +
" - Response Headers: "
+ inResponse.getResponseHeaders().buildHTTPHeaderString() );
}
if ( inResponse.getStatusCode() != STATUS_CODE_OK )
{
throw new IOException( "Host rejected connection: " +
inResponse.getStatusCode() + " " +
inResponse.getStatusMessage() );
}
headersRead.replaceHeaders( inResponse.getResponseHeaders() );
}
private void initializeOutgoingWith06()
throws IOException
{
connectedHost.setStatus( HostStatus.CONNECTING,
Localizer.getString( "Negotiate0_6Handshake") );
// Send the first handshake greeting to the remote host.
String greeting = servent.getGnutellaNetwork().getNetworkGreeting();
String requestLine = greeting + '/' + PROTOCOL_06 + "\r\n";
StringBuffer requestBuffer = new StringBuffer( 100 );
requestBuffer.append( requestLine );
// create appropriate handshake handler that takes care about headers
// and logic...
HandshakeHandler handshakeHandler = HandshakeHandler.createHandshakeHandler(
servent, connectedHost );
HTTPHeaderGroup handshakeHeaders =
handshakeHandler.createOutgoingHandshakeHeaders();
requestBuffer.append( handshakeHeaders.buildHTTPHeaderString() );
requestBuffer.append( "\r\n" );
headersSend = handshakeHeaders;
String requestStr = requestBuffer.toString();
sendStringToHost( requestStr );
HandshakeStatus handshakeResponse = HandshakeStatus.parseHandshakeResponse(
connection );
headersRead = handshakeResponse.getResponseHeaders();
if ( NLogger.isDebugEnabled( ConnectionEngine.class ) )
{
NLogger.debug( ConnectionEngine.class, connectedHost +
" - Response Code: '" + handshakeResponse.getStatusCode() + "'." );
NLogger.debug( ConnectionEngine.class, connectedHost +
" - Response Message: '" + handshakeResponse.getStatusMessage() + "'." );
NLogger.debug( ConnectionEngine.class, connectedHost +
" - Response Headers: "
+ headersRead.buildHTTPHeaderString() );
}
if ( handshakeResponse.getStatusCode() != STATUS_CODE_OK )
{
if ( handshakeResponse.getStatusCode() == STATUS_CODE_REJECTED )
{
throw new ConnectionRejectedException(
handshakeResponse.getStatusCode() + " "
+ handshakeResponse.getStatusMessage() );
}
throw new ConnectionRejectedException(
"Gnutella 0.6 connection rejected. Status: " +
handshakeResponse.getStatusCode() + " - " +
handshakeResponse.getStatusMessage() );
}
configureRemoteHost( headersRead );
HandshakeStatus myResponse = handshakeHandler.createHandshakeResponse(
handshakeResponse, true );
HTTPHeaderGroup myResponseHeaders = myResponse.getResponseHeaders();
headersSend.replaceHeaders( myResponseHeaders );
// send answer to host...
sendStringToHost( GNUTELLA_06 + " " + myResponse.getStatusCode() + " " +
myResponse.getStatusMessage() + "\r\n" );
String httpHeaderString = myResponseHeaders.buildHTTPHeaderString();
sendStringToHost( httpHeaderString );
sendStringToHost( "\r\n" );
if ( myResponse.getStatusCode() != STATUS_CODE_OK )
{
throw new ConnectionRejectedException( "Connection not accepted: " +
myResponse.getStatusCode() + " " + myResponse.getStatusMessage() );
}
}
private void configureConnectionType( HTTPHeaderGroup myHeadersSend,
HTTPHeaderGroup theirHeadersRead )
{
HTTPHeader myUPHeader = myHeadersSend.getHeader(
GnutellaHeaderNames.X_ULTRAPEER );
HTTPHeader theirUPHeader = theirHeadersRead.getHeader(
GnutellaHeaderNames.X_ULTRAPEER );
if ( myUPHeader == null || theirUPHeader == null )
{
connectedHost.setConnectionType( Host.CONNECTION_NORMAL );
}
else if ( myUPHeader.booleanValue() )
{
if ( theirUPHeader.booleanValue() )
{
connectedHost.setConnectionType( Host.CONNECTION_UP_UP );
}
else
{
connectedHost.setConnectionType( Host.CONNECTION_UP_LEAF );
}
}
else // !myUPHeader.booleanValue()
{
if ( theirUPHeader.booleanValue() )
{
connectedHost.setConnectionType( Host.CONNECTION_LEAF_UP );
}
else
{
connectedHost.setConnectionType( Host.CONNECTION_NORMAL );
}
}
}
private void handleXTryHeaders( HTTPHeaderGroup headers )
{
// X-Try header is not used by most servents anymore... (2003-02-25)
// we read still read it a while though...
// http://groups.yahoo.com/group/the_gdf/message/14316
HTTPHeader[] hostAddresses = headers.getHeaders(
GnutellaHeaderNames.X_TRY );
if ( hostAddresses != null )
{
handleXTryHosts( hostAddresses, true );
}
// for us ultrapeers have low priority other high.. since we cant connect to UP..
hostAddresses = headers.getHeaders(
GnutellaHeaderNames.X_TRY_ULTRAPEERS );
if ( hostAddresses != null )
{
handleXTryHosts( hostAddresses, false );
}
}
private void handleXTryHosts( HTTPHeader[] xtryHostAdresses, boolean isUltrapeerList )
{
short priority;
if ( isUltrapeerList )
{
priority = CaughtHostsContainer.HIGH_PRIORITY;
}
else
{
priority = CaughtHostsContainer.NORMAL_PRIORITY;
}
CaughtHostsContainer hostContainer = servent.getHostService().getCaughtHostsContainer();
for ( int i = 0; i < xtryHostAdresses.length; i++ )
{
StringTokenizer tokenizer = new StringTokenizer(
xtryHostAdresses[i].getValue(), "," );
while( tokenizer.hasMoreTokens() )
{
String hostAddressStr = tokenizer.nextToken().trim();
try
{
DestAddress address = PresentationManager.getInstance()
.createHostAddress( hostAddressStr, DefaultDestAddress.DEFAULT_PORT );
AccessType access = securityService.controlHostAddressAccess( address );
switch ( access )
{
case ACCESS_DENIED:
case ACCESS_STRONGLY_DENIED:
// skip host address...
continue;
}
IpAddress ipAddress = address.getIpAddress();
if ( !isUltrapeerList && ipAddress != null && ipAddress.isSiteLocalIP() )
{ // private IP have low priority except for ultrapeers.
priority = CaughtHostsContainer.LOW_PRIORITY;
}
hostContainer.addCaughtHost( address, priority );
}
catch ( MalformedDestAddressException exp )
{
}
}
}
}
/**
* This method uses the header fields to set attributes of the remote host
* accordingly.
*/
private void configureRemoteHost( HTTPHeaderGroup headers )
{
HTTPHeader header = headers.getHeader( HTTPHeaderNames.USER_AGENT );
if ( header != null )
{
connectedHost.setVendor( header.getValue() );
}
if ( connectedHost.isIncomming() )
{
header = headers.getHeader( GnutellaHeaderNames.LISTEN_IP );
if ( header == null )
{
header = headers.getHeader( GnutellaHeaderNames.X_MY_ADDRESS );
}
if ( header != null )
{
DestAddress addi = connectedHost.getHostAddress();
// parse port
int port = AddressUtils.parsePort( header.getValue() );
if ( port > 0 )
{
addi.setPort( port );
}
}
}
header = headers.getHeader( GnutellaHeaderNames.REMOTE_IP );
if ( header != null )
{
byte[] remoteIP = AddressUtils.parseIP( header.getValue() );
if ( remoteIP != null )
{
IpAddress ip = new IpAddress( remoteIP );
DestAddress address = PresentationManager.getInstance().createHostAddress(ip, -1);
servent.updateLocalAddress( address );
}
}
header = headers.getHeader( GnutellaHeaderNames.X_QUERY_ROUTING );
if ( header != null )
{
try
{
float version = Float.parseFloat( header.getValue() );
if ( version >= 0.1f )
{
connectedHost.setQueryRoutingSupported( true );
}
}
catch ( NumberFormatException e )
{ // no qr supported... don't care
}
}
header = headers.getHeader( GnutellaHeaderNames.X_UP_QUERY_ROUTING );
if ( header != null )
{
try
{
float version = Float.parseFloat( header.getValue() );
if ( version >= 0.1f )
{
connectedHost.setUPQueryRoutingSupported( true );
}
}
catch ( NumberFormatException e )
{ // no qr supported... don't care
}
}
header = headers.getHeader( GnutellaHeaderNames.X_DYNAMIC_QUERY );
if ( header != null )
{
try
{
float version = header.floatValue();
if ( version >= 0.1f )
{
connectedHost.setDynamicQuerySupported( true );
}
}
catch ( NumberFormatException e)
{// no dynamiy query supported... don't care
}
}
byte maxTTL = headers.getByteHeaderValue( GnutellaHeaderNames.X_MAX_TTL,
DynamicQueryConstants.DEFAULT_MAX_TTL );
connectedHost.setMaxTTL( maxTTL );
int degree = headers.getIntHeaderValue( GnutellaHeaderNames.X_DEGREE,
DynamicQueryConstants.NON_DYNAMIC_QUERY_DEGREE );
connectedHost.setUltrapeerDegree( degree );
}
private void postHandshakeConfiguration( HTTPHeaderGroup myHeadersSend,
HTTPHeaderGroup theirHeadersRead )
throws IOException
{
if ( myHeadersSend.isHeaderValueContaining( HTTPHeaderNames.ACCEPT_ENCODING,
"deflate" ) && theirHeadersRead.isHeaderValueContaining(
HTTPHeaderNames.CONTENT_ENCODING, "deflate" ) )
{
connectedHost.activateInputInflation();
}
if ( theirHeadersRead.isHeaderValueContaining( HTTPHeaderNames.ACCEPT_ENCODING,
"deflate" ) && myHeadersSend.isHeaderValueContaining(
HTTPHeaderNames.CONTENT_ENCODING, "deflate" ) )
{
connectedHost.activateOutputDeflation();
}
HTTPHeader header = theirHeadersRead.getHeader(
GnutellaHeaderNames.VENDOR_MESSAGE );
if ( header != null && !header.getValue().equals("") )
{
connectedHost.setVendorMessageSupported( true );
}
}
private void sendStringToHost( String str )
throws IOException
{
NLogger.debug( ConnectionEngine.class, connectedHost +
" - Send: " + str );
byte[] bytes = str.getBytes( "ISO8859-1" );
connection.write( ByteBuffer.wrap( bytes ) );
connection.flush();
}
}
The table below shows all metrics for ConnectionEngine.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 82.00 | Number of blocks | |
| BLOCK_COMMENT | 21.00 | Number of block comment lines | |
| COMMENTS | 70.00 | Comment lines | |
| COMMENT_DENSITY | 0.20 | Comment density | |
| COMPARISONS | 77.00 | Number of comparison operators | |
| CYCLOMATIC | 77.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 5.00 | Comments in declarations | |
| DOC_COMMENT | 21.00 | Number of javadoc comment lines | |
| ELOC | 357.00 | Effective lines of code | |
| EXEC_COMMENTS | 22.00 | Comments in executable code | |
| EXITS | 106.00 | Procedure exits | |
| FUNCTIONS | 12.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 80.72 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 53.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 1.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 | 1.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 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 3.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.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 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.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 | 1.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 2.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 | 1.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 | 1.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 1.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 648.00 | Number of lines in the source file | |
| LINE_COMMENT | 28.00 | Number of line comments | |
| LOC | 520.00 | Lines of code | |
| LOGICAL_LINES | 207.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 990.00 | Number of operands | |
| OPERATORS | 1818.00 | Number of operators | |
| PARAMS | 11.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2808.00 | Halstead program length | |
| PROGRAM_VOCAB | 378.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 42.00 | Number of return points from functions | |
| SIZE | 24579.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 325.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 53.00 | Number of unique operators | |
| WHITESPACE | 58.00 | Number of whitespace lines | |