HostCatcher.java
| Index Score | ||
|---|---|---|
 |
 |
com.limegroup.gnutella |
 |
 |
FrostWire |
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 | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| EXEC_COMMENTS | Comments in executable code | |
| SIZE | Size of the file in bytes | |
| EXITS | Procedure exits | |
| DOC_COMMENT | Number of javadoc comment lines | |
| COMMENTS | Comment lines | |
| JAVA0143 | JAVA0143 Synchronized method | |
| LINES | Number of lines in the source file | |
| CYCLOMATIC | Cyclomatic complexity | |
| OPERATORS | Number of operators | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_LENGTH | Halstead program length | |
| UNIQUE_OPERANDS | Number of unique operands | |
| COMPARISONS | Number of comparison operators | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| OPERANDS | Number of operands | |
| LOC | Lines of code | |
| RETURNS | Number of return points from functions | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| BLOCKS | Number of blocks | |
| FUNCTIONS | Number of function declarations | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| PARAMS | Number of formal parameter declarations | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0161 | JAVA0161 Conditional wait() not in loop | |
| JAVA0076 | JAVA0076 Use of magic number | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0020 | JAVA0020 Field name does not have required form | |
| JAVA0125 | JAVA0125 Continue statement with label | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| LOOPS | Number of loops | |
| JAVA0013 | JAVA0013 Non-blank final field is not static | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
package com.limegroup.gnutella;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.net.UnknownHostException;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Random;
import java.util.Set;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.limewire.collection.BucketQueue;
import org.limewire.collection.Cancellable;
import org.limewire.collection.FixedSizeSortedList;
import org.limewire.collection.IntSet;
import org.limewire.collection.ListPartitioner;
import org.limewire.collection.RandomAccessMap;
import org.limewire.collection.RandomOrderHashMap;
import org.limewire.inspection.Inspectable;
import org.limewire.inspection.InspectableContainer;
import org.limewire.inspection.InspectionPoint;
import org.limewire.io.Connectable;
import org.limewire.io.IpPort;
import org.limewire.io.IpPortSet;
import org.limewire.io.NetworkInstanceUtils;
import org.limewire.io.NetworkUtils;
import org.limewire.util.CommonUtils;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import com.google.inject.name.Named;
import com.limegroup.gnutella.bootstrap.UDPHostCache;
import com.limegroup.gnutella.bootstrap.UDPHostCacheFactory;
import com.limegroup.gnutella.dht.DHTManager;
import com.limegroup.gnutella.dht.DHTManager.DHTMode;
import com.limegroup.gnutella.filters.IPFilter;
import com.limegroup.gnutella.messages.Message;
import com.limegroup.gnutella.messages.PingReply;
import com.limegroup.gnutella.messages.PingRequest;
import com.limegroup.gnutella.messages.PingRequestFactory;
import com.limegroup.gnutella.settings.ApplicationSettings;
import com.limegroup.gnutella.settings.ConnectionSettings;
import com.limegroup.gnutella.util.ClassCNetworks;
/**
* The host catcher. This peeks at pong messages coming on the
* network and snatches IP addresses of other Gnutella peers. IP
* addresses may also be added to it from a file (usually
* "gnutella.net"). The servent may then connect to these addresses
* as necessary to maintain full connectivity.<p>
*
* The HostCatcher currently prioritizes pongs as follows. Note that Ultrapeers
* with a private address is still highest priority; hopefully this may allow
* you to find local Ultrapeers.
* <ol>
* <li> Ultrapeers. Ultrapeers are identified because the number of files they
* are sharing is an exact power of two--a dirty but effective hack.
* <li> Normal pongs.
* <li> Private addresses. This means that the host catcher will still
* work on private networks, although we will normally ignore private
* addresses.
* </ol>
*
* Finally, HostCatcher maintains a list of "permanent" locations, based on
* average daily uptime. These are stored in the gnutella.net file. They
* are NOT bootstrap servers like router.limewire.com; LimeWire doesn't
* use those anymore.
*/
@Singleton
public class HostCatcher {
/**
* Log for logging this class.
*/
private static final Log LOG = LogFactory.getLog(HostCatcher.class);
/**
* The number of ultrapeer pongs to store.
*/
static final int GOOD_SIZE=1000;
/**
* The number of normal pongs to store.
* This must be large enough to store all permanent addresses,
* as permanent addresses when read from disk are stored as
* normal priority.
*/
static final int NORMAL_SIZE=400;
/**
* The number of permanent locations to store in gnutella.net
* This MUST NOT BE GREATER THAN NORMAL_SIZE. This is because when we read
* in endpoints, we add them as NORMAL_PRIORITY. If we have written
* out more than NORMAL_SIZE hosts, then we guarantee that endpoints
* will be ejected from the ENDPOINT_QUEUE upon startup.
* Because we write out best first (and worst last), and thus read in
* best first (and worst last) this means that we will be ejecting
* our best endpoints and using our worst ones when starting.
*
*/
static final int PERMANENT_SIZE = NORMAL_SIZE;
/**
* Constant for the index of good priority hosts (Ultrapeers)
*/
public static final int GOOD_PRIORITY = 1;
/**
* Constant for the index of non-Ultrapeer hosts.
*/
public static final int NORMAL_PRIORITY = 0;
/**
* netmask for pongs that we accept and send.
*/
public static final int PONG_MASK = 0xFFFFFF00;
private static final Comparator<ExtendedEndpoint> DHT_COMPARATOR =
new Comparator<ExtendedEndpoint>() {
public int compare(ExtendedEndpoint e1, ExtendedEndpoint e2) {
DHTMode mode1 = e1.getDHTMode();
DHTMode mode2 = e2.getDHTMode();
if ((mode1.equals(DHTMode.ACTIVE) && !mode2.equals(DHTMode.ACTIVE))
|| (mode1.equals(DHTMode.PASSIVE) && mode2.equals(DHTMode.INACTIVE))) {
return -1;
} else if ((mode2.equals(DHTMode.ACTIVE) && !mode1.equals(DHTMode.ACTIVE))
|| (mode2.equals(DHTMode.PASSIVE) && mode1.equals(DHTMode.INACTIVE))) {
return 1;
} else {
return 0;
}
}
};
// NOTE: ENDPOINT_SET, FREE_ULTRAPEER_SLOTS_SET & FREE_LEAF_SLOTS_SET
// are actually Maps that point to themselves so that we can
// retrieve Endpoints from them based on an ip/port.
/** The list of hosts to try. These are sorted by priority: ultrapeers,
* normal, then private addresses. Within each priority level, recent hosts
* are prioritized over older ones. Our representation consists of a set
* and a queue, both bounded in size. The set lets us quickly check if
* there are duplicates, while the queue provides ordering--a classic
* space/time tradeoff.
*
* INVARIANT: queue contains no duplicates and contains exactly the
* same elements as set.
* LOCKING: obtain this' monitor before modifying either. */
private final BucketQueue<ExtendedEndpoint> ENDPOINT_QUEUE =
new BucketQueue<ExtendedEndpoint>(new int[] {NORMAL_SIZE,GOOD_SIZE});
private final Map<ExtendedEndpoint, ExtendedEndpoint> ENDPOINT_SET = new HashMap<ExtendedEndpoint, ExtendedEndpoint>();
/**
* <tt>Set</tt> of hosts advertising free Ultrapeer connection slots.
*/
private final RandomAccessMap<ExtendedEndpoint, ExtendedEndpoint> FREE_ULTRAPEER_SLOTS_SET =
new RandomOrderHashMap<ExtendedEndpoint, ExtendedEndpoint>(200);
/**
* <tt>Set</tt> of hosts advertising free leaf connection slots.
*/
private final RandomAccessMap<ExtendedEndpoint, ExtendedEndpoint> FREE_LEAF_SLOTS_SET =
new RandomOrderHashMap<ExtendedEndpoint, ExtendedEndpoint>(200);
/**
* map of locale (string) to sets (of endpoints).
*/
private final Map<String, Set<ExtendedEndpoint>> LOCALE_SET_MAP = new HashMap<String, Set<ExtendedEndpoint>>();
/**
* number of endpoints to keep in the locale set
*/
private static final int LOCALE_SET_SIZE = 100;
/** The list of pongs with the highest average daily uptimes. Each host's
* weight is set to the uptime. These are most likely to be reachable
* during the next session, though not necessarily likely to have slots
* available now. In this way, they act more like bootstrap hosts than
* normal pongs. This list is written to gnutella.net and used to
* initialize queue on startup. To prevent duplicates, we also maintain a
* set of all addresses, like with queue/set.
*
* INVARIANT: permanentHosts contains no duplicates and contains exactly
* the same elements and permanentHostsSet
* LOCKING: obtain this' monitor before modifying either */
private final FixedSizeSortedList<ExtendedEndpoint> permanentHosts=
new FixedSizeSortedList<ExtendedEndpoint>(ExtendedEndpoint.priorityComparator(),
PERMANENT_SIZE);
private final Set<ExtendedEndpoint> permanentHostsSet=new HashSet<ExtendedEndpoint>();
/**
* List of the hosts that were restored from disk.
* INVARIANT: a subset of permanentHosts.
* LOCKING: this
*/
private final List<ExtendedEndpoint> restoredHosts=
new FixedSizeSortedList<ExtendedEndpoint>(
ExtendedEndpoint.priorityComparator(),
PERMANENT_SIZE);
/**
* Partition view of the list of restored hosts.
*/
private final ListPartitioner<ExtendedEndpoint> uptimePartitions =
new ListPartitioner<ExtendedEndpoint>(restoredHosts, 3);
/** The UDPHostCache bootstrap system. */
private UDPHostCache udpHostCache;
/**
* Count for the number of hosts that we have not been able to connect to.
* This is used for degenerate cases where we ultimately have to hit the
* bootstrap hosts.
*/
private int _failures;
/**
* <tt>Set</tt> of hosts we were unable to create TCP connections with
* and should therefore not be tried again. Fixed size.
*
* LOCKING: obtain this' monitor before modifying/iterating
*/
private final Set<Endpoint> EXPIRED_HOSTS = new HashSet<Endpoint>();
/**
* <tt>Set</tt> of hosts we were able to create TCP connections with but
* did not accept our Gnutella connection, and are therefore put on
* "probation". Fixed size.
*
* LOCKING: obtain this' monitor before modifying/iterating
*/
private final Set<Endpoint> PROBATION_HOSTS = new HashSet<Endpoint>();
/**
* Constant for the number of milliseconds to wait before periodically
* recovering hosts on probation. Non-final for testing.
*/
private static long PROBATION_RECOVERY_WAIT_TIME = 60*1000;
/**
* Constant for the number of milliseconds to wait between calls to
* recover hosts that have been placed on probation.
* Non-final for testing.
*/
private static long PROBATION_RECOVERY_TIME = 60*1000;
/**
* Constant for the size of the set of hosts put on probation. Public for
* testing.
*/
public static final int PROBATION_HOSTS_SIZE = 500;
/**
* Constant for the size of the set of expired hosts. Public for
* testing.
*/
public static final int EXPIRED_HOSTS_SIZE = 500;
/**
* The scheduled runnable that fetches hosts from bootstrappers if we need them.
*/
public final Bootstrapper FETCHER = new Bootstrapper();
/**
* All EndpointObservers waiting on getting an Endpoint.
*/
private List<EndpointObserver> _catchersWaiting = new LinkedList<EndpointObserver>();
/**
* The last allowed time that we can continue ranking pongs.
*/
private long lastAllowedPongRankTime = 0;
/**
* The amount of time we're allowed to do pong ranking after
* we click connect.
*/
private final long PONG_RANKING_EXPIRE_TIME = 20 * 1000;
/**
* Stop ranking if we have this many connections.
*/
private static final int MAX_CONNECTIONS = 5;
/** A RND to share to find random hosts. */
private final Random RND = new Random();
/**
* Whether or not hosts have been added since we wrote to disk.
*/
private boolean dirty = false;
private final ScheduledExecutorService backgroundExecutor;
private final ConnectionServices connectionServices;
private final Provider<ConnectionManager> connectionManager;
private final Provider<UDPService> udpService;
private final Provider<DHTManager> dhtManager;
private final Provider<QueryUnicaster> queryUnicaster;
private final Provider<IPFilter> ipFilter;
private final Provider<MulticastService> multicastService;
private final UniqueHostPinger uniqueHostPinger;
private final NetworkInstanceUtils networkInstanceUtils;
private final PingRequestFactory pingRequestFactory;
@Inject
public HostCatcher(
@Named("backgroundExecutor") ScheduledExecutorService backgroundExecutor,
ConnectionServices connectionServices,
Provider<ConnectionManager> connectionManager,
Provider<UDPService> udpService, Provider<DHTManager> dhtManager,
Provider<QueryUnicaster> queryUnicaster,
@Named("hostileFilter") Provider<IPFilter> ipFilter, // TODO: check if ipFilter isn't more appropriate
Provider<MulticastService> multicastService,
UniqueHostPinger uniqueHostPinger,
UDPHostCacheFactory udpHostCacheFactory,
PingRequestFactory pingRequestFactory,
NetworkInstanceUtils networkInstanceUtils) {
this.backgroundExecutor = backgroundExecutor;
this.connectionServices = connectionServices;
this.connectionManager = connectionManager;
this.udpService = udpService;
this.dhtManager = dhtManager;
this.queryUnicaster = queryUnicaster;
this.ipFilter = ipFilter;
this.multicastService = multicastService;
this.uniqueHostPinger = uniqueHostPinger;
this.pingRequestFactory = pingRequestFactory;
this.networkInstanceUtils = networkInstanceUtils;
// TODO: this could also be solved with a named injection to get the
// UniqHostPinger and not its super class
this.udpHostCache = udpHostCacheFactory.createUDPHostCache(uniqueHostPinger);
}
UDPHostCache getUdpHostCache() {
return udpHostCache;
}
/**
* Initializes any components required for HostCatcher.
* Currently, this schedules occasional services.
*/
public void initialize() {
LOG.trace("START scheduling");
scheduleServices();
}
protected void scheduleServices() {
Runnable probationRestorer = new Runnable() {
public void run() {
LOG.trace("restoring hosts on probation");
List<Endpoint> toAdd;
synchronized(HostCatcher.this) {
toAdd = new ArrayList<Endpoint>(PROBATION_HOSTS);
PROBATION_HOSTS.clear();
}
for(Endpoint e : toAdd)
add(e, false);
}
};
// Recover hosts on probation every minute.
backgroundExecutor.scheduleWithFixedDelay(probationRestorer,
PROBATION_RECOVERY_WAIT_TIME, PROBATION_RECOVERY_TIME, TimeUnit.MILLISECONDS);
// Try to fetch hosts whenever we need them.
// Start it immediately, so that if we have no hosts
// (because of a fresh installation) we will connect.
backgroundExecutor.scheduleWithFixedDelay(FETCHER, 0, 2*1000, TimeUnit.MILLISECONDS);
LOG.trace("STOP scheduling");
}
/**
* Sends UDP pings to hosts read from disk.
*/
public void sendUDPPings() {
// We need the lock on this so that we can copy the set of endpoints.
List<Endpoint> l;
synchronized(this) {
l = new ArrayList<Endpoint>(ENDPOINT_SET.size() + restoredHosts.size());
l.addAll(ENDPOINT_SET.keySet());
l.addAll(restoredHosts);
}
Collections.shuffle(l);
rank(l);
}
/**
* Rank the collection of hosts.
*/
private void rank(Collection<? extends IpPort> hosts) {
if(needsPongRanking()) {
uniqueHostPinger.rank(
hosts,
// cancel when connected -- don't send out any more pings
new Cancellable() {
public boolean isCancelled() {
return !needsPongRanking();
}
}
);
}
}
public void sendMessageToAllHosts(Message m, MessageListener listener, Cancellable c) {
uniqueHostPinger.rank(getAllHosts(), listener, c, m);
}
private synchronized Collection<ExtendedEndpoint> getAllHosts() {
//keep them ordered -- TODO: Why?
Collection<ExtendedEndpoint> hosts = new LinkedHashSet<ExtendedEndpoint>(getNumHosts());
hosts.addAll(FREE_ULTRAPEER_SLOTS_SET.keySet());
hosts.addAll(FREE_LEAF_SLOTS_SET.keySet());
hosts.addAll(ENDPOINT_SET.keySet());
hosts.addAll(restoredHosts);
return hosts;
}
/**
* Gets a List of hosts that support the DHT. If <tt>this</tt> knows any active nodes,
* return them at the head of the list.
* Note: this method is slow and is not meant to be used often.
*
* @param minVersion The minimum DHT Version. Should be 0 to return all versions
*
* @return A Collection of ExtendedEndpoints that support the DHT.
*/
public synchronized List<ExtendedEndpoint> getDHTSupportEndpoint(int minVersion) {
List<ExtendedEndpoint> hostsList = new ArrayList<ExtendedEndpoint>();
IntSet classC = new IntSet();
for(ExtendedEndpoint host : getAllHosts()) {
if(host.supportsDHT()
&& host.getDHTVersion() >= minVersion &&
(!ConnectionSettings.FILTER_CLASS_C.getValue() ||
classC.add(NetworkUtils.getMaskedIP(host.getInetAddress(), PONG_MASK)))) {
hostsList.add(host);
}
}
Collections.sort(hostsList, DHT_COMPARATOR);
return hostsList;
}
/**
* Determines if UDP Pongs need to be sent out.
*/
private synchronized boolean needsPongRanking() {
if(connectionServices.isFullyConnected())
return false;
int have = connectionManager.get().getInitializedConnections().size();
if(have >= MAX_CONNECTIONS)
return false;
long now = System.currentTimeMillis();
if(now > lastAllowedPongRankTime)
return false;
int size;
if(connectionServices.isSupernode()) {
synchronized(this) {
size = FREE_ULTRAPEER_SLOTS_SET.size();
}
} else {
synchronized(this) {
size = FREE_LEAF_SLOTS_SET.size();
}
}
int preferred = connectionManager.get().getPreferredConnectionCount();
return size < preferred - have;
}
/**
* Reads in endpoints from the given file. This is called by initialize, so
* you don't need to call it manually. It is package access for
* testability.
*
* @modifies this
* @effects read hosts from the given file.
*/
void read(File hostFile) throws FileNotFoundException,
IOException {
LOG.trace("entered HostCatcher.read(File)");
BufferedReader in = null;
try {
in = new BufferedReader(new FileReader(hostFile));
while (true) {
String line=in.readLine();
if(LOG.isTraceEnabled())
LOG.trace("read line: " + line);
if (line==null)
break;
try {
ExtendedEndpoint e = ExtendedEndpoint.read(line);
if(e.isUDPHostCache()) {
addUDPHostCache(e);
} else if(isValidHost(e)) {
synchronized(this) {
addPermanent(e);
restoredHosts.add(e);
}
endpointAdded();
}
} catch (ParseException pe) {
continue;
}
}
} finally {
udpHostCache.hostCachesAdded();
try {
if( in != null )
in.close();
} catch(IOException e) {}
}
LOG.trace("left HostCatcher.read(File)");
}
/**
* Writes the host file to the default location.
*
* @throws <tt>IOException</tt> if the file cannot be written
*/
synchronized void write() throws IOException {
write(getHostsFile());
}
/**
* @modifies the file named filename
* @effects writes this to the given file. The file
* is prioritized by rough probability of being good.
*/
synchronized void write(File hostFile) throws IOException {
repOk();
if(dirty || udpHostCache.isWriteDirty()) {
FileWriter out = new FileWriter(hostFile);
//Write udp hostcache endpoints.
udpHostCache.write(out);
//Write elements of permanent from worst to best. Order matters, as it
//allows read() to put them into queue in the right order without any
//difficulty.
for(ExtendedEndpoint e : permanentHosts)
e.write(out);
out.close();
}
}
///////////////////////////// Add Methods ////////////////////////////
/**
* Attempts to add a pong to this, possibly ejecting other elements from the
* cache. This method used to be called "spy".
*
* @param pr the pong containing the address/port to add
* @param receivingConnection the connection on which we received
* the pong.
* @return true iff pr was actually added
*/
public boolean add(PingReply pr) {
// if over UDP, verify GUIDs
if (pr.isUDP()) {
GUID g = new GUID(pr.getGUID());
if (!g.equals(PingRequest.UDP_GUID) &&
!g.equals(udpService.get().getSolicitedGUID()))
return false;
}
//Convert to endpoint
ExtendedEndpoint endpoint;
if(pr.getDailyUptime() != -1) {
endpoint = new ExtendedEndpoint(pr.getAddress(), pr.getPort(),
pr.getDailyUptime());
} else {
endpoint = new ExtendedEndpoint(pr.getAddress(), pr.getPort());
}
//if the PingReply had locale information then set it in the endpoint
if(!pr.getClientLocale().equals(""))
endpoint.setClientLocale(pr.getClientLocale());
if(pr.isUDPHostCache()) {
endpoint.setHostname(pr.getUDPCacheAddress());
endpoint.setUDPHostCache(true);
}
if(!isValidHost(endpoint)) {
return false;
}
int dhtVersion = pr.getDHTVersion();
if(dhtVersion > -1) {
DHTMode mode = pr.getDHTMode();
endpoint.setDHTVersion(dhtVersion);
endpoint.setDHTMode(mode);
if (dhtManager.get().isRunning()) {
// If active DHT endpoint, immediately send to dht manager
if(mode.equals(DHTMode.ACTIVE)) {
SocketAddress address = new InetSocketAddress(
endpoint.getAddress(), endpoint.getPort());
dhtManager.get().addActiveDHTNode(address);
} else if(mode.equals(DHTMode.PASSIVE)) {
SocketAddress address = new InetSocketAddress(
endpoint.getAddress(), endpoint.getPort());
dhtManager.get().addPassiveDHTNode(address);
}
}
}
if(pr.supportsUnicast()) {
queryUnicaster.get().addUnicastEndpoint(pr.getInetAddress(), pr.getPort());
}
// if the pong carried packed IP/Ports, add those as their own
// endpoints.
Collection<IpPort> packed =
ConnectionSettings.FILTER_CLASS_C.getValue() ?
NetworkUtils.filterOnePerClassC(pr.getPackedIPPorts()) :
pr.getPackedIPPorts();
rank(packed);
for(IpPort ipp : packed) {
ExtendedEndpoint ep;
if(ipp instanceof ExtendedEndpoint) {
ep = (ExtendedEndpoint)ipp;
} else {
ep = new ExtendedEndpoint(ipp.getAddress(), ipp.getPort());
if(ipp instanceof Connectable) {
// When more items other than TLS are added to HostInfo,
// it would make more sense to make this something like:
// ep.addHostInfo(ipp);
ep.setTLSCapable(((Connectable)ipp).isTLSCapable());
}
}
if(isValidHost(ep))
add(ep, GOOD_PRIORITY);
}
// if the pong carried packed UDP host caches, add those as their
// own endpoints.
for(IpPort ipp : pr.getPackedUDPHostCaches()) {
ExtendedEndpoint ep = new ExtendedEndpoint(ipp.getAddress(), ipp.getPort());
ep.setUDPHostCache(true);
addUDPHostCache(ep);
}
// if it was a UDPHostCache pong, just add it as that.
if(endpoint.isUDPHostCache())
return addUDPHostCache(endpoint);
if(pr.isTLSCapable())
endpoint.setTLSCapable(true);
//Add the endpoint, forcing it to be high priority if marked pong from
//an ultrapeer.
if (pr.isUltrapeer()) {
// Add it to our free leaf slots list if it has free leaf slots and
// is an Ultrapeer.
if(pr.hasFreeLeafSlots()) {
addToFreeSlotSet(endpoint, FREE_LEAF_SLOTS_SET);
// Return now if the pong is not also advertising free
// ultrapeer slots.
if(!pr.hasFreeUltrapeerSlots()) {
return true;
}
}
// Add it to our free leaf slots list if it has free leaf slots and
// is an Ultrapeer.
if(pr.hasFreeUltrapeerSlots()
|| //or if the locales match and it has free locale pref. slots
(ApplicationSettings.LANGUAGE.getValue()
.equals(pr.getClientLocale()) && pr.getNumFreeLocaleSlots() > 0)) {
addToFreeSlotSet(endpoint, FREE_ULTRAPEER_SLOTS_SET);
return true;
}
return add(endpoint, GOOD_PRIORITY);
} else
return add(endpoint, NORMAL_PRIORITY);
}
/**
* Adds an endpoint to the udp host cache, returning true
* if it succesfully added.
*/
private boolean addUDPHostCache(ExtendedEndpoint host) {
return udpHostCache.add(host);
}
/**
* Utility method for adding the specified host to the specified
* <tt>Set</tt> of hosts with free slots.
*
* @param host the host to add
* @param hosts the <tt>Set</tt> to add it to
*/
private void addToFreeSlotSet(ExtendedEndpoint host, Map<? super ExtendedEndpoint, ? super ExtendedEndpoint> hosts) {
synchronized(this) {
hosts.put(host, host);
// Also add it to the list of permanent hosts stored on disk.
addPermanent(host);
}
endpointAdded();
}
/**
* add the endpoint to the map which matches locales to a set of
* endpoints
*/
private synchronized void addToLocaleMap(ExtendedEndpoint endpoint) {
String loc = endpoint.getClientLocale();
if(LOCALE_SET_MAP.containsKey(loc)) { //if set exists for ths locale
Set<ExtendedEndpoint> s = LOCALE_SET_MAP.get(loc);
if(s.add(endpoint) && s.size() > LOCALE_SET_SIZE)
s.remove(s.iterator().next());
}
else { //otherwise create new set and add it to the map
Set<ExtendedEndpoint> s = new HashSet<ExtendedEndpoint>();
s.add(endpoint);
LOCALE_SET_MAP.put(loc, s);
}
}
/**
* Adds a collection of addresses to this.
*/
public void add(Collection<? extends Endpoint> endpoints) {
rank(endpoints);
for(Endpoint e: endpoints)
add(e, true);
}
/**
* Adds an address to this, possibly ejecting other elements from the cache.
* This method is used when getting an address from headers instead of the
* normal ping reply.
*
* @param pr the pong containing the address/port to add.
* @param forceHighPriority true if this should always be of high priority
* @return true iff e was actually added
*/
public boolean add(Endpoint e, boolean forceHighPriority) {
if(!isValidHost(e))
return false;
if (forceHighPriority)
return add(e, GOOD_PRIORITY);
else
return add(e, NORMAL_PRIORITY);
}
/**
* Adds an endpoint. Use this method if the locale of endpoint is known
* (used by ConnectionManager.disconnect())
*/
public boolean add(Endpoint e, boolean forceHighPriority, String locale) {
if(!isValidHost(e))
return false;
//need ExtendedEndpoint for the locale
if (forceHighPriority)
return add(new ExtendedEndpoint(e.getAddress(),
e.getPort(),
locale),
GOOD_PRIORITY);
else
return add(new ExtendedEndpoint(e.getAddress(),
e.getPort(),
locale),
NORMAL_PRIORITY);
}
/**
* Adds the specified host to the host catcher with the specified priority.
*
* @param host the endpoint to add
* @param priority the priority of the endpoint
* @return <tt>true</tt> if the endpoint was added, otherwise <tt>false</tt>
*/
public boolean add(Endpoint host, int priority) {
if (LOG.isTraceEnabled())
LOG.trace("adding host "+host);
if(host instanceof ExtendedEndpoint)
return add((ExtendedEndpoint)host, priority);
//need ExtendedEndpoint for the locale
return add(new ExtendedEndpoint(host.getAddress(),
host.getPort()),
priority);
}
/**
* Adds the passed endpoint to the set of hosts maintained, temporary and
* permanent. The endpoint may not get added due to various reasons
* (including it might be our address itself, we might be connected to it
* etc.). Also adding this endpoint may lead to the removal of some other
* endpoint from the cache.
*
* @param e Endpoint to be added
* @param priority the priority to use for e, one of GOOD_PRIORITY
* (ultrapeer) or NORMAL_PRIORITY
* @param uptime the host's uptime (or our best guess)
*
* @return true iff e was actually added
*/
private boolean add(ExtendedEndpoint e, int priority) {
repOk();
if(e.isUDPHostCache())
return addUDPHostCache(e);
boolean ret = false;
synchronized(this) {
//Add to permanent list, regardless of whether it's actually in queue.
//Note that this modifies e.
addPermanent(e);
if (! (ENDPOINT_SET.containsKey(e))) {
ret=true;
//Add to temporary list. Adding e may eject an older point from
//queue, so we have to cleanup the set to maintain
//rep. invariant.
ENDPOINT_SET.put(e, e);
ExtendedEndpoint ejected = ENDPOINT_QUEUE.insert(e, priority);
if (ejected!=null) {
ENDPOINT_SET.remove(ejected);
}
}
}
endpointAdded();
repOk();
return ret;
}
/**
* Adds an address to the permanent list of this without marking it for
* immediate fetching. This method is when connecting to a host and reading
* its Uptime header. If e is already in the permanent list, it is not
* re-added, though its key may be adjusted.
*
* @param e the endpoint to add
* @return true iff e was actually added
*/
private synchronized boolean addPermanent(ExtendedEndpoint e) {
if (networkInstanceUtils.isPrivateAddress(e.getInetAddress()))
return false;
if (permanentHostsSet.contains(e))
//TODO: we could adjust the key
return false;
addToLocaleMap(e); //add e to locale mapping
ExtendedEndpoint removed=permanentHosts.insert(e);
if (removed!=e) {
//Was actually added...
permanentHostsSet.add(e);
if (removed!=null)
//...and something else was removed.
permanentHostsSet.remove(removed);
dirty = true;
return true;
} else {
//Uptime not good enough to add. (Note that this is
//really just an optimization of the above case.)
return false;
}
}
/** Removes e from permanentHostsSet and permanentHosts.
* @return true iff this was modified */
private synchronized boolean removePermanent(ExtendedEndpoint e) {
boolean removed1=permanentHosts.remove(e);
boolean removed2=permanentHostsSet.remove(e);
assert removed1==removed2 : "Queue "+removed1+" but set "+removed2;
if(removed1)
dirty = true;
return removed1;
}
/**
* Utility method for verifying that the given host is a valid host to add
* to the group of hosts to try. This verifies that the host does not have
* a private address, is not banned, is not this node, is not in the
* expired or probated hosts set, etc.
*
* @param host the host to check
* @return <tt>true</tt> if the host is valid and can be added, otherwise
* <tt>false</tt>
*/
private boolean isValidHost(Endpoint host) {
// caches will validate for themselves.
if(host.isUDPHostCache())
return true;
byte[] addr;
try {
addr = host.getHostBytes();
} catch(UnknownHostException uhe) {
return false;
}
if(networkInstanceUtils.isPrivateAddress(addr)) {
return false;
}
//We used to check that we're not connected to e, but now we do that in
//ConnectionFetcher after a call to getAnEndpoint. This is not a big
//deal, since the call to "set.contains(e)" below ensures no duplicates.
//Skip if this would connect us to our listening port. TODO: I think
//this check is too strict sometimes, which makes testing difficult.
if (networkInstanceUtils.isMe(addr, host.getPort()))
return false;
//Skip if this host is banned.
if (!ipFilter.get().allow(addr))
return false;
synchronized(this) {
// Don't add this host if it has previously failed.
if(EXPIRED_HOSTS.contains(host)) {
return false;
}
// Don't add this host if it has previously rejected us.
if(PROBATION_HOSTS.contains(host)) {
return false;
}
}
return true;
}
/** Returns true if the given IpPort is TLS-capable. */
public boolean isHostTLSCapable(IpPort ipp) {
if(ipp instanceof Connectable)
return ((Connectable)ipp).isTLSCapable();
// No need to check if it's an endpoint already, because all Endpoints
// already implement HostInfo.
Endpoint p = new Endpoint(ipp.getAddress(), ipp.getPort());
ExtendedEndpoint ee;
synchronized(this) {
ee = ENDPOINT_SET.get(p);
if(ee == null)
ee = FREE_ULTRAPEER_SLOTS_SET.get(p);
if(ee == null)
ee = FREE_LEAF_SLOTS_SET.get(p);
}
if(ee == null)
return false;
else
return ee.isTLSCapable();
}
///////////////////////////////////////////////////////////////////////
/**
* Notification that endpoints now exist.
* If something was waiting on getting endpoints, this will notify them
* about the new endpoint.
*/
private void endpointAdded() {
// No loop is actually necessary here because this method is called
// each time an endpoint is added. Each new endpoint will trigger its
// own check.
Endpoint p;
EndpointObserver observer;
synchronized (this) {
if(_catchersWaiting.isEmpty())
return; // no one waiting.
p = getAnEndpointInternal();
if (p == null)
return; // no more endpoints to give.
observer = _catchersWaiting.remove(0);
}
// It is important that this is outside the lock. Otherwise HostCatcher's lock
// is exposed to the outside world.
observer.handleEndpoint(p);
}
/** Passes the next available endpoint to the EndpointObserver. */
public void getAnEndpoint(EndpointObserver observer) {
Endpoint p;
// We can only lock around endpoint retrieval & _catchersWaiting,
// we don't want to expose our lock to the observer.
synchronized(this) {
p = getAnEndpointInternal();
if(p == null)
_catchersWaiting.add(observer);
}
if(p != null)
observer.handleEndpoint(p);
}
/**
* Passes the next available endpoint to the EndpointObserver.
* If an Endpoint is immediately available, it is returned immediately
* instead of using the observer's callback. That is, the callback will
* only be used if an endpoint is not immediately available.
* This is useful to prevent stack overflows when many endpoints are
* attempted in response to endpoints not being usable.
*
* If the observer is null and no endpoint is available, this will
* simply return null and schedule no future callback.
*/
public Endpoint getAnEndpointImmediate(EndpointObserver observer) {
Endpoint p;
synchronized(this) {
p = getAnEndpointInternal();
if(p == null && observer != null)
_catchersWaiting.add(observer);
}
return p;
}
/** Removes an oberserver from wanting to get an endpoint. */
public synchronized void removeEndpointObserver(EndpointObserver observer) {
_catchersWaiting.remove(observer);
}
/**
* @modifies this
* @effects atomically removes and returns the highest priority host in
* this. If no host is available, blocks until one is. If the
* calling thread is interrupted during this process, throws
* InterruptedException. The caller should call doneWithConnect and
* doneWithMessageLoop when done with the returned value.
*/
public Endpoint getAnEndpoint() throws InterruptedException {
BlockingObserver observer = new BlockingObserver();
getAnEndpoint(observer);
try {
synchronized (observer) {
if (observer.getEndpoint() == null) {
observer.wait(); // only stops waiting when
// handleEndpoint is called.
}
return observer.getEndpoint();
}
} catch (InterruptedException ie) {
// If we got interrupted, we must remove the waiting observer.
synchronized (this) {
_catchersWaiting.remove(observer);
throw ie;
}
}
}
/**
* Notifies this that the fetcher has finished attempting a connection to
* the given host. This exists primarily to update the permanent host list
* with connection history.
*
* @param e
* the address/port, which should have been returned by
* getAnEndpoint
* @param success
* true if we successfully established a messaging connection to
* e, at least temporarily; false otherwise
*/
public synchronized void doneWithConnect(Endpoint e, boolean success) {
//Normal host: update key. TODO3: adjustKey() operation may be more
//efficient.
if (! (e instanceof ExtendedEndpoint))
//Should never happen, but I don't want to update public
//interface of this to operate on ExtendedEndpoint.
return;
ExtendedEndpoint ee=(ExtendedEndpoint)e;
removePermanent(ee);
if (success) {
ee.recordConnectionSuccess();
} else {
_failures++;
ee.recordConnectionFailure();
}
addPermanent(ee);
}
/**
* @requires this' monitor held
* @modifies this
* @effects returns the highest priority endpoint in queue, regardless
* of quick-connect settings, etc. Returns null if this is empty.
*/
protected ExtendedEndpoint getAnEndpointInternal() {
//LOG.trace("entered getAnEndpointInternal");
// If we're already an ultrapeer and we know about hosts with free
// ultrapeer slots, try them.
if(connectionServices.isSupernode() && !FREE_ULTRAPEER_SLOTS_SET.isEmpty()) {
return preferenceWithLocale(FREE_ULTRAPEER_SLOTS_SET);
}
// Otherwise, if we're already a leaf and we know about ultrapeers with
// free leaf slots, try those.
else if(connectionServices.isShieldedLeaf() &&
!FREE_LEAF_SLOTS_SET.isEmpty()) {
return preferenceWithLocale(FREE_LEAF_SLOTS_SET);
}
// Otherwise, assume we'll be a leaf and we're trying to connect, since
// this is more common than wanting to become an ultrapeer and because
// we want to fill any remaining leaf slots if we can.
else if(!FREE_ULTRAPEER_SLOTS_SET.isEmpty()) {
return preferenceWithLocale(FREE_ULTRAPEER_SLOTS_SET);
}
// Otherwise, might as well use the leaf slots hosts up as well
// since we added them to the size and they can give us other info
else if(!FREE_LEAF_SLOTS_SET.isEmpty()) {
Iterator<ExtendedEndpoint> iter = FREE_LEAF_SLOTS_SET.keySet().iterator();
ExtendedEndpoint ee = iter.next();
FREE_LEAF_SLOTS_SET.remove(ee);
return ee;
}
else if (! ENDPOINT_QUEUE.isEmpty()) {
//pop e from queue and remove from set.
ExtendedEndpoint e= ENDPOINT_QUEUE.extractMax();
ExtendedEndpoint removed=ENDPOINT_SET.remove(e);
//check that e actually was in set.
assert removed == e : "Rep. invariant for HostCatcher broken.";
return e;
}
else if (!restoredHosts.isEmpty()) {
// highest partition has highest uptimes
List<ExtendedEndpoint> best = uptimePartitions.getLastPartition();
ExtendedEndpoint e = best.remove((int)(Math.random() * best.size()));
return e;
}
else {
return null;
}
}
/**
* tries to return an endpoint that matches the locale of this client
* from the passed in set.
*/
private ExtendedEndpoint preferenceWithLocale(RandomAccessMap<ExtendedEndpoint, ExtendedEndpoint> base) {
String loc = ApplicationSettings.LANGUAGE.getValue();
ExtendedEndpoint ret = null;
// preference a locale host if we haven't matched any locales yet
if(!connectionManager.get().isLocaleMatched()) {
if(LOCALE_SET_MAP.containsKey(loc)) {
Set<ExtendedEndpoint> locales = LOCALE_SET_MAP.get(loc);
for(ExtendedEndpoint e : base.keySet()) {
if(locales.contains(e)) {
locales.remove(e);
ret = e;
break;
}
}
}
}
if (ret == null)
ret = base.getKeyAt(RND.nextInt(base.size()));
Object removed = base.remove(ret);
assert ret == removed : "Key: " + ret + ", value: " + removed;
return ret;
}
/**
* Accessor for the total number of hosts stored, including Ultrapeers and
* leaves.
*
* @return the total number of hosts stored
*/
public synchronized int getNumHosts() {
return ENDPOINT_QUEUE.size()+FREE_LEAF_SLOTS_SET.size()+
FREE_ULTRAPEER_SLOTS_SET.size()+restoredHosts.size();
}
/**
* Returns the number of marked ultrapeer hosts.
*/
public synchronized int getNumUltrapeerHosts() {
return ENDPOINT_QUEUE.size(GOOD_PRIORITY)+FREE_LEAF_SLOTS_SET.size()+
FREE_ULTRAPEER_SLOTS_SET.size();
}
/**
* Returns an iterator of this' "permanent" hosts, from worst to best.
* This method exists primarily for testing. THIS MUST NOT BE MODIFIED
* WHILE ITERATOR IS IN USE.
*/
Iterator<ExtendedEndpoint> getPermanentHosts() {
return permanentHosts.iterator();
}
/**
* Accessor for the <tt>Collection</tt> of 10 Ultrapeers that have
* advertised free Ultrapeer slots. The returned <tt>Collection</tt> is a
* new <tt>Collection</tt> and can therefore be modified in any way.
*
* @return a <tt>Collection</tt> containing 10 <tt>IpPort</tt> hosts that
* have advertised they have free ultrapeer slots
*/
public synchronized Collection<IpPort> getUltrapeersWithFreeUltrapeerSlots(int num) {
return getPreferencedCollection(FREE_ULTRAPEER_SLOTS_SET,
ApplicationSettings.LANGUAGE.getValue(),num);
}
public synchronized Collection<IpPort>
getUltrapeersWithFreeUltrapeerSlots(String locale,int num) {
return getPreferencedCollection(FREE_ULTRAPEER_SLOTS_SET,
locale,num);
}
/**
* Accessor for the <tt>Collection</tt> of 10 Ultrapeers that have
* advertised free leaf slots. The returned <tt>Collection</tt> is a
* new <tt>Collection</tt> and can therefore be modified in any way.
*
* @return a <tt>Collection</tt> containing 10 <tt>IpPort</tt> hosts that
* have advertised they have free leaf slots
*/
public synchronized Collection<IpPort> getUltrapeersWithFreeLeafSlots(int num) {
return getPreferencedCollection(FREE_LEAF_SLOTS_SET,
ApplicationSettings.LANGUAGE.getValue(),num);
}
public synchronized Collection<IpPort>
getUltrapeersWithFreeLeafSlots(String locale,int num) {
return getPreferencedCollection(FREE_LEAF_SLOTS_SET,
locale,num);
}
/**
* preference the set so we try to return those endpoints that match
* passed in locale "loc"
*/
private Collection<IpPort> getPreferencedCollection(Map<? extends ExtendedEndpoint, ? extends ExtendedEndpoint> base, String loc, int num) {
if(loc == null || loc.equals(""))
loc = ApplicationSettings.DEFAULT_LOCALE.getValue();
Set<IpPort> hosts = new HashSet<IpPort>(num);
IntSet masked = new IntSet();
Set<ExtendedEndpoint> locales = LOCALE_SET_MAP.get(loc);
boolean filter = ConnectionSettings.FILTER_CLASS_C.getValue();
if(locales != null) {
for(ExtendedEndpoint e : locales) {
if(hosts.size() >= num)
break;
if(base.containsKey(e) &&
(!filter ||
masked.add(NetworkUtils.getMaskedIP(e.getInetAddress(), PONG_MASK))))
hosts.add(e);
}
}
for(IpPort ipp : base.keySet()) {
if(hosts.size() >= num)
break;
if (!filter || masked.add(NetworkUtils.getMaskedIP(ipp.getInetAddress(), PONG_MASK)))
hosts.add(ipp);
}
return hosts;
}
/**
* Notifies this that connect() has been called. This may decide to give
* out bootstrap pongs if necessary.
*/
public void expire() {
synchronized(this) {
long now = System.currentTimeMillis();
lastAllowedPongRankTime = now + PONG_RANKING_EXPIRE_TIME;
}
recoverHosts();
// schedule new runnable to clear the set of endpoints that
// were pinged while trying to connect
backgroundExecutor.schedule(
new Runnable() {
public void run() {
uniqueHostPinger.resetData();
}
},
PONG_RANKING_EXPIRE_TIME, TimeUnit.MILLISECONDS);
}
/**
* @modifies this
* @effects removes all entries from this
*/
public synchronized void clear() {
FREE_LEAF_SLOTS_SET.clear();
FREE_ULTRAPEER_SLOTS_SET.clear();
ENDPOINT_QUEUE.clear();
ENDPOINT_SET.clear();
}
public UDPPinger getPinger() {
return uniqueHostPinger;
}
/** Enable very slow rep checking? Package access for use by
* HostCatcherTest. */
static boolean DEBUG=false;
/** Checks invariants. Very slow; method body should be enabled for testing
* purposes only. */
protected void repOk() {
if (!DEBUG)
return;
synchronized(this) {
//Check ENDPOINT_SET == ENDPOINT_QUEUE
outer:
for (Iterator iter=ENDPOINT_SET.keySet().iterator(); iter.hasNext(); ) {
Object e=iter.next();
for (Iterator iter2=ENDPOINT_QUEUE.iterator();
iter2.hasNext();) {
if (e.equals(iter2.next()))
continue outer;
}
throw new IllegalStateException("Couldn't find "+e+" in queue");
}
for (Iterator iter=ENDPOINT_QUEUE.iterator(); iter.hasNext(); ) {
Object e=iter.next();
assert e instanceof ExtendedEndpoint;
assert ENDPOINT_SET.containsKey(e);
}
//Check permanentHosts === permanentHostsSet
for (Iterator iter=permanentHosts.iterator(); iter.hasNext(); ) {
Object o=iter.next();
assert o instanceof ExtendedEndpoint;
assert permanentHostsSet.contains(o);
}
for (Iterator iter=permanentHostsSet.iterator(); iter.hasNext(); ) {
Object e=iter.next();
assert e instanceof ExtendedEndpoint;
assert permanentHosts.contains(e) :
"Couldn't find "+e+" from "
+permanentHostsSet+" in "+permanentHosts;
}
}
}
/**
* Reads the gnutella.net file.
*/
private void readHostsFile() {
LOG.trace("Reading Hosts File");
// Just gnutella.net
try {
read(getHostsFile());
} catch (IOException e) {
LOG.debug(getHostsFile(), e);
}
}
private File getHostsFile() {
return new File(CommonUtils.getUserSettingsDir(),"gnutella.net");
}
/**
* Recovers any hosts that we have put in the set of hosts "pending"
* removal from our hosts list.
*/
public void recoverHosts() {
LOG.debug("recovering hosts file");
synchronized(this) {
PROBATION_HOSTS.clear();
EXPIRED_HOSTS.clear();
_failures = 0;
FETCHER.resetFetchTime();
udpHostCache.resetData();
restoredHosts.clear();
uniqueHostPinger.resetData();
}
// Read the hosts file again. This will also notify any waiting
// connection fetchers from previous connection attempts.
readHostsFile();
}
/**
* Adds the specified host to the group of hosts currently on "probation."
* These are hosts that are on the network but that have rejected a
* connection attempt. They will periodically be re-activated as needed.
*
* @param host the <tt>Endpoint</tt> to put on probation
*/
public synchronized void putHostOnProbation(Endpoint host) {
PROBATION_HOSTS.add(host);
if(PROBATION_HOSTS.size() > PROBATION_HOSTS_SIZE) {
PROBATION_HOSTS.remove(PROBATION_HOSTS.iterator().next());
}
}
/**
* Adds the specified host to the group of expired hosts. These are hosts
* that we have been unable to create a TCP connection to, let alone a
* Gnutella connection.
*
* @param host the <tt>Endpoint</tt> to expire
*/
public synchronized void expireHost(Endpoint host) {
EXPIRED_HOSTS.add(host);
if(EXPIRED_HOSTS.size() > EXPIRED_HOSTS_SIZE) {
EXPIRED_HOSTS.remove(EXPIRED_HOSTS.iterator().next());
}
}
/**
* Runnable that looks for UDPHostCache or multicast hosts.
* This tries, in order:
* 1) Multicasting a ping.
* 2) Sending UDP pings to UDPHostCaches.
*/
private class Bootstrapper implements Runnable {
/**
* The next allowed multicast time.
*/
private long nextAllowedMulticastTime = 0;
/**
* The next time we're allowed to fetch.
* Incremented after each succesful fetch.
*/
private long nextAllowedFetchTime = 0;
/**
* How long we must wait after contacting UDP before we can contact.
*/
private static final int POST_UDP_DELAY = 30 * 1000;
/**
* How long we must wait after each multicast ping before
* we attempt a newer multicast ping.
*/
private static final int POST_MULTICAST_DELAY = 60 * 1000;
/**
* Determines whether or not it is time to get more hosts,
* and if we need them, gets them.
*/
public synchronized void run() {
if (ConnectionSettings.DO_NOT_BOOTSTRAP.getValue())
return;
// If no one's waiting for an endpoint, don't get any.
if(_catchersWaiting.isEmpty()) {
return;
}
long now = System.currentTimeMillis();
if(udpHostCache.getSize() == 0 &&
now < nextAllowedFetchTime &&
now < nextAllowedMulticastTime)
return;
//if we don't need hosts, exit.
if(!needsHosts(now))
return;
getHosts(now);
}
/**
* Resets the nextAllowedFetchTime, so that after we regain a
* connection to the internet, we can fetch if needed.
*/
void resetFetchTime() {
nextAllowedFetchTime = 0;
}
/**
* Determines whether or not we need more hosts.
*/
private synchronized boolean needsHosts(long now) {
synchronized(HostCatcher.this) {
return getNumHosts() == 0 ||
(!connectionServices.isConnected() && _failures > 100);
}
}
/**
* Fetches more hosts, updating the next allowed time to fetch.
*/
synchronized void getHosts(long now) {
// alway try multicast first.
if(multicastFetch(now))
return;
// then try udp host caches.
if(udpHostCacheFetch(now))
return;
// :-(
}
/**
* Attempts to fetch via multicast, returning true
* if it was able to.
*/
private boolean multicastFetch(long now) {
if(nextAllowedMulticastTime < now &&
!ConnectionSettings.DO_NOT_MULTICAST_BOOTSTRAP.getValue()) {
LOG.trace("Fetching via multicast");
PingRequest pr = pingRequestFactory.createMulticastPing();
multicastService.get().send(pr);
nextAllowedMulticastTime = now + POST_MULTICAST_DELAY;
return true;
}
return false;
}
/**
* Attempts to fetch via udp host caches, returning true
* if it was able to.
*/
private boolean udpHostCacheFetch(long now) {
// if we had udp host caches to fetch from, use them.
if(udpHostCache.fetchHosts()) {
LOG.trace("Fetching via UDP");
nextAllowedFetchTime = now + POST_UDP_DELAY;
return true;
}
return false;
}
}
/** Simple callback for having an endpoint added. */
public static interface EndpointObserver {
public void handleEndpoint(Endpoint p);
}
/** A blocking implementation of EndpointObserver. */
private static class BlockingObserver implements EndpointObserver {
private Endpoint endpoint;
public synchronized void handleEndpoint(Endpoint p) {
endpoint = p;
notify();
}
public Endpoint getEndpoint() {
return endpoint;
}
}
//Unit test: tests/com/.../gnutella/HostCatcherTest.java
// tests/com/.../gnutella/bootstrap/HostCatcherFetchTest.java
//
@SuppressWarnings("unused")
@InspectableContainer
private class HCInspectables {
@InspectionPoint("known hosts by class C")
public final Inspectable top10classC = new Inspectable() {
public Object inspect() {
Map<String, Object> ret = new HashMap<String, Object>();
ret.put("ver",1);
ClassCNetworks permanent = new ClassCNetworks();
ClassCNetworks restored = new ClassCNetworks();
ClassCNetworks freeLeaf = new ClassCNetworks();
ClassCNetworks freeUp = new ClassCNetworks();
ClassCNetworks all = new ClassCNetworks();
synchronized(HostCatcher.this) {
IpPortSet everybody = new IpPortSet();
everybody.addAll(permanentHostsSet);
everybody.addAll(restoredHosts);
everybody.addAll(FREE_LEAF_SLOTS_SET.keySet());
everybody.addAll(FREE_ULTRAPEER_SLOTS_SET.keySet());
everybody.addAll(ENDPOINT_SET.keySet());
for(IpPort ip : permanentHostsSet)
permanent.add(ip.getInetAddress(), 1);
for(IpPort ip : restoredHosts)
restored.add(ip.getInetAddress(), 1);
for(IpPort ip : FREE_LEAF_SLOTS_SET.keySet())
freeLeaf.add(ip.getInetAddress(), 1);
for(IpPort ip : FREE_ULTRAPEER_SLOTS_SET.keySet())
freeUp.add(ip.getInetAddress(), 1);
for(IpPort ip : everybody)
all.add(ip.getInetAddress(), 1);
}
ret.put("perm", permanent.getTopInspectable(10));
ret.put("rest", restored.getTopInspectable(10));
ret.put("fl", freeLeaf.getTopInspectable(10));
ret.put("fu", freeUp.getTopInspectable(10));
ret.put("all", all.getTopInspectable(10));
return ret;
}
};
/** Inspectable with some tls stats */
@InspectionPoint("tls stats of known hosts")
public final Inspectable tlsStats = new Inspectable() {
public Object inspect() {
Map<String, Object> ret = new HashMap<String, Object>();
ret.put("ver",1);
int perm, permtls, rest,resttls,fl, fltls, fu,futls;
synchronized(HostCatcher.this) {
perm = permanentHostsSet.size();
rest = restoredHosts.size();
fl = FREE_LEAF_SLOTS_SET.size();
fu = FREE_ULTRAPEER_SLOTS_SET.size();
permtls = 0;
for (ExtendedEndpoint e : permanentHostsSet)
permtls += e.isTLSCapable() ? 1 : 0;
resttls = 0;
for (ExtendedEndpoint e : restoredHosts)
resttls += e.isTLSCapable() ? 1 : 0;
fltls = 0;
for (ExtendedEndpoint e : FREE_LEAF_SLOTS_SET.keySet())
fltls += e.isTLSCapable() ? 1 : 0;
futls = 0;
for (ExtendedEndpoint e : FREE_ULTRAPEER_SLOTS_SET.keySet())
futls += e.isTLSCapable() ? 1 : 0;
}
ret.put("perm",perm);
ret.put("permtls",permtls);
ret.put("rest",rest);
ret.put("resttls",resttls);
ret.put("fl",fl);
ret.put("fltls",fltls);
ret.put("fu",fu);
ret.put("futls",futls);
return ret;
}
};
/** Inspectable with some dht stats */
@InspectionPoint("dht stats of known hosts")
public final Inspectable dhtStats = new Inspectable() {
public Object inspect() {
Map<String, Object> ret = new HashMap<String, Object>();
ret.put("ver",1);
int perm, permdht, rest,restdht,fl, fldht, fu,fudht;
synchronized(HostCatcher.this) {
perm = permanentHostsSet.size();
rest = restoredHosts.size();
fl = FREE_LEAF_SLOTS_SET.size();
fu = FREE_ULTRAPEER_SLOTS_SET.size();
permdht = 0;
for (ExtendedEndpoint e : permanentHostsSet) {
permdht += e.supportsDHT() ? 1 : 0;
}
restdht = 0;
for (ExtendedEndpoint e : restoredHosts)
restdht += e.supportsDHT() ? 1 : 0;
fldht = 0;
for (ExtendedEndpoint e : FREE_LEAF_SLOTS_SET.keySet())
fldht += e.supportsDHT() ? 1 : 0;
fudht = 0;
for (ExtendedEndpoint e : FREE_ULTRAPEER_SLOTS_SET.keySet())
fudht += e.supportsDHT() ? 1 : 0;
}
ret.put("perm",perm);
ret.put("permdht",permdht);
ret.put("rest",rest);
ret.put("restdht",restdht);
ret.put("fl",fl);
ret.put("fldht",fldht);
ret.put("fu",fu);
ret.put("fudht",fudht);
return ret;
}
};
}
}
The table below shows all metrics for HostCatcher.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 167.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 542.00 | Comment lines | |
| COMMENT_DENSITY | 0.66 | Comment density | |
| COMPARISONS | 141.00 | Number of comparison operators | |
| CYCLOMATIC | 209.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 93.00 | Comments in declarations | |
| DOC_COMMENT | 437.00 | Number of javadoc comment lines | |
| ELOC | 823.00 | Effective lines of code | |
| EXEC_COMMENTS | 61.00 | Comments in executable code | |
| EXITS | 199.00 | Procedure exits | |
| FUNCTIONS | 67.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 104.68 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 185.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 1.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 | 1.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 | 2.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 53.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 1.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 | 1.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 11.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 | 25.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 3.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 14.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 | 5.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 8.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 | 1.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 | 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 | 1.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 1.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 1.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 23.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 1.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 34.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 | 1.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 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 | 27.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 | 5.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 | 1.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 | 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 | 1734.00 | Number of lines in the source file | |
| LINE_COMMENT | 105.00 | Number of line comments | |
| LOC | 979.00 | Lines of code | |
| LOGICAL_LINES | 510.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 2244.00 | Number of operands | |
| OPERATORS | 4410.00 | Number of operators | |
| PARAMS | 63.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 6654.00 | Halstead program length | |
| PROGRAM_VOCAB | 750.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 122.00 | Number of return points from functions | |
| SIZE | 64617.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 686.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 64.00 | Number of unique operators | |
| WHITESPACE | 213.00 | Number of whitespace lines | |