MessageService.java
| Index Score | ||
|---|---|---|
 |
 |
phex.msghandling |
 |
 |
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 | |
|---|---|---|
| LINE_COMMENT | Number of line comments |  |
| DECL_COMMENTS | Comments in declarations | |
| SIZE | Size of the file in bytes | |
| EXITS | Procedure exits | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0077 | JAVA0077 Private field not used in declaring class | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| COMMENTS | Comment lines | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LINES | Number of lines in the source file | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| LOC | Lines of code | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0170 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| LOGICAL_LINES | Number of statements | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| JAVA0119 | JAVA0119 Control variable changed within body of for loop | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| PROGRAM_VOLUME | Halstead program volume | |
| OPERATORS | Number of operators | |
| ELOC | Effective lines of code | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| CYCLOMATIC | Cyclomatic complexity | |
| FUNCTIONS | Number of function declarations | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| PARAMS | Number of formal parameter declarations | |
| 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$
*/
package phex.msghandling;
import java.util.Iterator;
import java.util.List;
import java.util.TimerTask;
import phex.common.AbstractLifeCycle;
import phex.common.Environment;
import phex.common.PongCache;
import phex.common.QueryRoutingTable;
import phex.common.address.DestAddress;
import phex.common.log.NLogger;
import phex.host.Host;
import phex.msg.GUID;
import phex.msg.Message;
import phex.msg.MsgHeader;
import phex.msg.PingMsg;
import phex.msg.PongFactory;
import phex.msg.PongMsg;
import phex.msg.PushRequestMsg;
import phex.msg.QueryMsg;
import phex.msg.QueryResponseMsg;
import phex.msg.RouteTableUpdateMsg;
import phex.msg.vendor.HopsFlowVMsg;
import phex.msg.vendor.PushProxyRequestVMsg;
import phex.msg.vendor.TCPConnectBackVMsg;
import phex.msg.vendor.VendorMsg;
import phex.query.DynamicQueryConstants;
import phex.query.DynamicQueryEngine;
import phex.servent.Servent;
import phex.share.SharedFilesService;
import phex.udp.UdpMessageEngine;
public class MessageService extends AbstractLifeCycle
{
private final Servent servent;
private final MessageRouting messageRouting;
private final MessageDispatcher messageDispatcher;
private final QueryMsgRoutingHandler queryMsgRoutingHandler;
private final PongFactory pongFactory;
private UdpMessageEngine udpMsgEngine;
// TODO PongCache might also be moved to MessageDispatcher, but there is
// still a dependency to UdpMessageEngine.
private PongCache pongCache;
/**
* Timer responsible to trigger QRT updates.
*/
private QRPUpdateTimer qrpUpdateTimer;
/**
* The last sent query routing table, used for dynamic query
* for a fast check for matches.
*/
private QueryRoutingTable lastSentQueryRoutingTable;
/**
* The number of TCP redirects sent during the last time frame.
*/
private int numberOfTCPRedirectsSent;
public MessageService( Servent servent )
{
if ( servent == null )
{
throw new NullPointerException( "Servent missing." );
}
this.servent = servent;
pongCache = new PongCache( servent );
messageRouting = new MessageRouting();
pongFactory = new PongFactory( );
messageDispatcher = new MessageDispatcher( servent, messageRouting,
pongFactory );
queryMsgRoutingHandler = new QueryMsgRoutingHandler( servent );
messageDispatcher.addMessageSubscriber( QueryMsg.class, queryMsgRoutingHandler );
}
////////////////////////////////////////////////////////////////////////////
// LifeCycle Methods
////////////////////////////////////////////////////////////////////////////
@Override
public void doStart()
{
messageDispatcher.initStats( servent.getStatisticsService() );
udpMsgEngine = new UdpMessageEngine( servent, servent.getHostService(),
pongFactory, servent.getSharedFilesService() );
qrpUpdateTimer = new QRPUpdateTimer( servent.getSharedFilesService() );
Environment.getInstance().scheduleTimerTask(
qrpUpdateTimer, QRPUpdateTimer.TIMER_PERIOD,
QRPUpdateTimer.TIMER_PERIOD );
Environment.getInstance().scheduleTimerTask(
new ResetTCPRedirectCounter(), ResetTCPRedirectCounter.TIMER_PERIOD,
ResetTCPRedirectCounter.TIMER_PERIOD );
Environment.getInstance().scheduleTimerTask(
new HopsFlowTimer(), HopsFlowTimer.TIMER_DELAY,
HopsFlowTimer.TIMER_PERIOD );
}
public void removeRoutings(Host host)
{
messageRouting.removeRoutings( host );
}
////////////////////////////////////////////////////////////////////////////
// Message Dispatching
////////////////////////////////////////////////////////////////////////////
public <T extends Message> void addMessageSubscriber( Class<T> clazz, MessageSubscriber<T> subscriber )
{
messageDispatcher.addMessageSubscriber(clazz, subscriber);
}
public <T extends Message> void removeMessageSubscriber( Class<T> clazz, MessageSubscriber<T> subscriber )
{
messageDispatcher.removeMessageSubscriber(clazz, subscriber);
}
public void dispatchMessage( Message message, Host sourceHost )
{
//Logger.logMessage( Logger.FINEST, Logger.NETWORK,
// "Received Header function: " + header.getPayload() );
MsgHeader header = message.getHeader();
switch ( header.getPayload() )
{
case MsgHeader.PING_PAYLOAD:
messageDispatcher.handlePing((PingMsg)message, sourceHost );
break;
case MsgHeader.PONG_PAYLOAD:
messageDispatcher.handlePong( (PongMsg)message, sourceHost );
break;
case MsgHeader.PUSH_PAYLOAD:
messageDispatcher.handlePushRequest( (PushRequestMsg) message, sourceHost );
break;
case MsgHeader.QUERY_PAYLOAD:
messageDispatcher.handleQuery( (QueryMsg) message, sourceHost );
break;
case MsgHeader.QUERY_HIT_PAYLOAD:
messageDispatcher.handleQueryResponse( (QueryResponseMsg) message, sourceHost );
break;
case MsgHeader.ROUTE_TABLE_UPDATE_PAYLOAD:
messageDispatcher.handleRouteTableUpdate( (RouteTableUpdateMsg) message, sourceHost );
break;
case MsgHeader.VENDOR_MESSAGE_PAYLOAD:
case MsgHeader.STANDARD_VENDOR_MESSAGE_PAYLOAD:
messageDispatcher.handleVendorMessage( (VendorMsg) message, sourceHost );
break;
}
}
public void dropMessage( MsgHeader header, byte[] body, String reason, Host sourceHost )
{
messageDispatcher.dropMessage( header, body, reason, sourceHost );
}
////////////////////////////////////////////////////////////////////////////
// Query Messages
////////////////////////////////////////////////////////////////////////////
/**
* Sends a query for this servent, usually initiated by the user.
* @param queryMsg the query to send.
* @return the possible dynamic query engine used, or null if no
* dynamic query is initiated.
*/
public DynamicQueryEngine sendQuery( QueryMsg queryMsg )
{
// add my own query to seen list.
messageRouting.checkAndAddToQueryRoutingTable( queryMsg.getHeader().getMsgID(),
Host.LOCAL_HOST );
if ( servent.isUltrapeer() )
{
return servent.getQueryService().sendDynamicQuery( queryMsg,
DynamicQueryConstants.DESIRED_ULTRAPEER_RESULTS );
}
else
{
queryMsgRoutingHandler.forwardQueryToUltrapeers( queryMsg, null );
return null;
}
}
public void forwardQueryToLeaves( QueryMsg msg, Host fromHost )
{
queryMsgRoutingHandler.forwardQueryToLeaves( msg, fromHost );
}
////////////////////////////////////////////////////////////////////////////
// Push Messages
////////////////////////////////////////////////////////////////////////////
/**
* Routes the {@link PushRequestMsg} to a host we forwarded a {@link QueryResponseMsg}
* for or is known from a {@link PushProxyRequestVMsg}.
* @param message the message to route.
* @return true if the routing was successful, false otherwise.
*/
public boolean routePushMessage( PushRequestMsg message )
{
GUID clientGUID = message.getClientGUID();
Host host = messageRouting.getPushRouting( clientGUID );
if ( host == null )
{
// no push route...
NLogger.debug( MessageService.class, "No PUSH route for " + clientGUID + "." );
return false;
}
NLogger.debug( MessageService.class, "Push route for " + clientGUID
+ " is " + host );
host.queueMessageToSend( message );
return true;
}
////////////////////////////////////////////////////////////////////////////
// Ping Messages
////////////////////////////////////////////////////////////////////////////
/**
* Ping a host
*/
public void pingHost( Host host )
{
pingHost( host, (byte)1 );
}
/**
* Ping a host
*/
public void pingHost( Host host, byte ttl )
{
// Send ping msg.
PingMsg pingMsg = new PingMsg( ttl );
messageRouting.checkAndAddToPingRoutingTable( pingMsg.getHeader().getMsgID(),
Host.LOCAL_HOST );
if ( NLogger.isDebugEnabled( MessageService.class ) )
NLogger.debug( MessageService.class, "Queueing Ping: "
+ pingMsg.getDebugString() + " - " + pingMsg.getHeader().toString() + " - Host: " + host.toString() );
host.queueMessageToSend( pingMsg );
}
/**
* Sends a ping message with the given TTL to the given hosts.
* @param ttl the TTL to use.
* @param hosts the hosts to ping.
*/
public void pingHosts( byte ttl, Host[] hosts )
{
PingMsg pingMsg = new PingMsg( ttl );
messageRouting.checkAndAddToPingRoutingTable( pingMsg.getHeader().getMsgID(),
Host.LOCAL_HOST );
forwardPing( pingMsg, Host.LOCAL_HOST, hosts);
}
/**
* Forwards a ping to the given hosts but never to the from Host.
* @param msg the ping to forward
* @param fromHost the host the ping came from.
* @param hosts the hosts to forward to.
*/
private void forwardPing( PingMsg msg, Host fromHost, Host[] hosts )
{
for ( int i = 0; i < hosts.length; i++ )
{
if ( hosts[i] == fromHost )
{
continue;
}
hosts[i].queueMessageToSend( msg );
}
}
/**
* <p>Called to forward a Ping to all connected neighbors. This is only
* done under special conditions.<br>
* When we are in Leaf mode we hold connections to Ultrapeers (we are there
* leaf) and usual peers therefore we:<br>
* - Never broadcast a message coming from a Ultrapper.
* - Never broadcast a message to a ultrapeer.<br>
* This strategy is used to separate the broadcast traffic of the peer
* network from the Ultrapeer/Leaf network and is essential for a correct
* Ultrapeer proposal support.</p>
*
* @param msg the MsgPing to forward
* @param fromHost the Host that originated this message
*
* @deprecated only not delete for documentation purposes how pongs are
* handled without PongCache
*/
// only not delete for documentation purposes how pongs are handled without PongCache
// @Deprecated
// public void forwardPing( PingMsg msg, Host fromHost, boolean isShieldedLeaf )
// {
// // Never broadcast a message coming from a ultrapeer when in leaf mode!
// if ( isShieldedLeaf && fromHost != null
// && fromHost.isLeafUltrapeerConnection() )
// {
// return;
// }
//
// Host[] hosts;
//
// if ( !isShieldedLeaf )
// { // only forward to ultrapeers if I'm not a leaf.
// hosts = hostsContainer.getUltrapeerConnections();
// forwardPing(msg, fromHost, hosts);
//
// // only forward to leafs if I'm not a leaf itself.
// hosts = hostsContainer.getLeafConnections();
// forwardPing(msg, fromHost, hosts);
// }
//
// // forward to usual peers.
// hosts = hostsContainer.getPeerConnections();
// forwardPing(msg, fromHost, hosts);
// }
////////////////////////////////////////////////////////////////////////////
// Pong Messages
////////////////////////////////////////////////////////////////////////////
/**
* @param pong
* @see phex.common.PongCache#addPong(phex.msg.PongMsg)
*/
public void addPongToCache(PongMsg pong)
{
pongCache.addPong( pong );
}
/**
* @return
* @see phex.common.PongCache#getPongs()
*/
public List<PongMsg> getCachedPongs()
{
return pongCache.getPongs();
}
////////////////////////////////////////////////////////////////////////////
// TCP Connect Back Messages
////////////////////////////////////////////////////////////////////////////
public boolean requestTCPConnectBack()
{
DestAddress localAddress = servent.getLocalAddress();
VendorMsg tcpConnectBack = new TCPConnectBackVMsg( localAddress.getPort() );
Host[] hosts = servent.getHostService().getUltrapeerConnections();
int sentCount = 0;
for ( int i = 0; sentCount <= 5 && i < hosts.length; i++ )
{
if ( hosts[i].isTCPConnectBackSupported() )
{
hosts[i].queueMessageToSend( tcpConnectBack );
sentCount ++;
}
}
return sentCount > 0;
}
public boolean isTCPRedirectAllowed()
{
return numberOfTCPRedirectsSent <= 3;
}
public void incNumberOfTCPRedirectsSent()
{
numberOfTCPRedirectsSent++;
}
private class ResetTCPRedirectCounter extends TimerTask
{
private static final long TIMER_PERIOD = 1000 * 60 * 15;
@Override
public void run()
{
numberOfTCPRedirectsSent = 0;
}
}
////////////////////////////////////////////////////////////////////////////
// HopsFlow Vendor Messages
////////////////////////////////////////////////////////////////////////////
private class HopsFlowTimer extends TimerTask
{
private static final long TIMER_DELAY = 1000 * 60 * 2;
private static final long TIMER_PERIOD = 1000 * 15;
private boolean lastBusyState = false;
@Override
public void run()
{
try
{
if ( !servent.getHostService().isShieldedLeafNode() )
{
return;
}
Host[] ultrapeers = servent.getHostService().getUltrapeerConnections();
boolean isHostBusy = servent.isUploadLimitReached();
byte hopsFlowLimit;
if ( isHostBusy )
{
hopsFlowLimit = 0;
}
else
{
hopsFlowLimit = 5;
}
HopsFlowVMsg msg = new HopsFlowVMsg( hopsFlowLimit );
long now = System.currentTimeMillis();
for ( int i = 0; i < ultrapeers.length; i++ )
{
if ( ultrapeers[i].isHopsFlowSupported() &&
( isHostBusy != lastBusyState ||
ultrapeers[i].getConnectionUpTime( now ) < TIMER_PERIOD*1.1 ) )
{
ultrapeers[i].queueMessageToSend( msg );
}
}
lastBusyState = isHostBusy;
}
catch ( Throwable th )
{
NLogger.error( HopsFlowTimer.class, th, th);
}
}
}
////////////////////////////////////////////////////////////////////////////
// QRT handling
////////////////////////////////////////////////////////////////////////////
/**
* Returns the last sent query routing table that contains
* my and my leafs entries.
* @return the last sent query routing table.
*/
public QueryRoutingTable getLastSentQueryRoutingTable()
{
return lastSentQueryRoutingTable;
}
public void triggerQueryRoutingTableUpdate()
{
Environment.getInstance().executeOnThreadPool( qrpUpdateTimer, "TriggerQueryRoutingTableUpdate" );
}
private class QRPUpdateTimer extends TimerTask
{
private static final long TIMER_PERIOD = 1000 * 10;
private final SharedFilesService sharedFilesService;
public QRPUpdateTimer( SharedFilesService sharedFilesService )
{
this.sharedFilesService = sharedFilesService;
}
@Override
public void run()
{
try
{
sendQueryRoutingTable();
}
catch ( Throwable th )
{
NLogger.error( QRPUpdateTimer.class, th, th );
}
}
/**
* Sends the query routing table to all network connections that haven't
* been updated for a while.
*/
private void sendQueryRoutingTable()
{
boolean isUltrapeer = servent.isUltrapeer();
// check if we are a shielded leaf node or a Ultrapeer.
// Forwarding QRT is not wanted otherwise.
if ( !( servent.isShieldedLeafNode() || isUltrapeer ) )
{
return;
}
Host[] hosts = servent.getHostService().getUltrapeerConnections();
QueryRoutingTable shareQRT = sharedFilesService.getLocalRoutingTable();
QueryRoutingTable currentTable = null;
QueryRoutingTable lastSentTable;
for (int i = 0; i < hosts.length; i++)
{
// first check if we are a UP or leaf supports QRP
if ( isUltrapeer )
{
if ( !hosts[i].isUPQueryRoutingSupported() )
{
continue;
}
}
else
{
if ( !hosts[i].isQueryRoutingSupported() )
{
continue;
}
}
if ( !hosts[i].isQRTableUpdateRequired() )
{
continue;
}
NLogger.debug( Host.class, "Updating QRTable for: " + hosts[i] );
if ( currentTable == null )
{// lazy initialize
currentTable = new QueryRoutingTable( shareQRT.getTableSize() );
currentTable.aggregateToRouteTable( shareQRT );
QueryRoutingTable.fillQRTWithLeaves( currentTable, servent );
lastSentQueryRoutingTable = currentTable;
}
lastSentTable = hosts[i].getLastSentRoutingTable();
Iterator<RouteTableUpdateMsg> msgIterator = QueryRoutingTable.buildRouteTableUpdateMsgIterator(
currentTable, lastSentTable );
RouteTableUpdateMsg msg;
while ( msgIterator.hasNext() )
{
msg = msgIterator.next();
hosts[i].queueMessageToSend( msg );
}
// when setting the last sent routing table the next routing
// table update time is set.
hosts[i].setLastSentRoutingTable( currentTable );
}
}
}
////////////////////////////////////////////////////////////////////////////
// UDP Messages
////////////////////////////////////////////////////////////////////////////
/**
* This method sends a udp ping to the given host address
*/
public void sendUdpPing( DestAddress address )
{
assert udpMsgEngine != null : "No UdpMessageEngine available.";
PingMsg udpPing = PingMsg.createUdpPingMsg( servent.isUltrapeer() );
udpMsgEngine.addMessageToSend( udpPing, address );
NLogger.debug( MessageService.class,
"Sent Udp Ping to" + address + " : " + udpPing + " with Scp Byte : " +
udpPing.getScpByte()!=null?String.valueOf(udpPing.getScpByte()[0]):"null"
);
}
// dont udp ping hosts too regulary!
public final static int UDP_PING_PERIOD = 1000 * 3 * 10;
// private final class SendUdpPingRunner extends Thread
// {
// public void run()
// {
// while ( true )
// {
// Host[] addresses = HostManager.getInstance().getNetworkHostsContainer().getUltrapeerConnections();
// for ( int i =0 ; i < addresses.length ; i++ )
// {
// try
// {
// sendUdpPing( addresses[i].getHostAddress() );
// }
// catch (IOException e) {
// continue;
// }
// }
// try
// {
// sleep( UDP_PING_PERIOD );
// }
// catch ( InterruptedException e)
// {
// //do nothing
// }
// }
// }
// }
}
The table below shows all metrics for MessageService.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 53.00 | Number of blocks | |
| BLOCK_COMMENT | 21.00 | Number of block comment lines | |
| COMMENTS | 195.00 | Comment lines | |
| COMMENT_DENSITY | 0.79 | Comment density | |
| COMPARISONS | 30.00 | Number of comparison operators | |
| CYCLOMATIC | 62.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 83.00 | Comments in declarations | |
| DOC_COMMENT | 76.00 | Number of javadoc comment lines | |
| ELOC | 247.00 | Effective lines of code | |
| EXEC_COMMENTS | 7.00 | Comments in executable code | |
| EXITS | 69.00 | Procedure exits | |
| FUNCTIONS | 27.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 73.75 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 59.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 | 1.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 | 1.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 | 3.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 | 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 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 12.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 1.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 | 1.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 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 | 2.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 2.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 3.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 1.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 | 4.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 | 3.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 | 634.00 | Number of lines in the source file | |
| LINE_COMMENT | 98.00 | Number of line comments | |
| LOC | 361.00 | Lines of code | |
| LOGICAL_LINES | 162.00 | Number of statements | |
| LOOPS | 5.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 708.00 | Number of operands | |
| OPERATORS | 1300.00 | Number of operators | |
| PARAMS | 27.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2008.00 | Halstead program length | |
| PROGRAM_VOCAB | 319.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 32.00 | Number of return points from functions | |
| SIZE | 22658.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 264.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 55.00 | Number of unique operators | |
| WHITESPACE | 78.00 | Number of whitespace lines | |