Comment and formatting fixes.

git-svn-id: http://svn.igniterealtime.org/svn/repos/messenger/trunk@42 b35dd754-fafc-0310-a699-88a17e54d16e

src/java/org/jivesoftware/database/SequenceManager.java

@@ -13,13 +13,13 @@ package org.jivesoftware.database;
 
 import org.jivesoftware.util.JiveConstants;
 import org.jivesoftware.util.Log;
-import org.jivesoftware.util.LongHashMap;
-import org.jivesoftware.database.DbConnectionManager;
 
 import java.sql.Connection;
 import java.sql.PreparedStatement;
 import java.sql.ResultSet;
 import java.sql.SQLException;
+import java.util.Map;
+import java.util.HashMap;
 
 /**
  * Manages sequences of unique ID's that get stored in the database. Database support for sequences
@@ -51,10 +51,10 @@ public class SequenceManager {
             "UPDATE jiveID SET id=? WHERE idType=? AND id=?";
 
     // Statically startup a sequence manager for each of the sequence counters.
-    private static LongHashMap managers;
+    private static Map<Integer,Object> managers;
 
     static {
-        managers = new LongHashMap();
+        managers = new HashMap<Integer,Object>();
         new SequenceManager(JiveConstants.USER, 1);
         new SequenceManager(JiveConstants.GROUP, 1);
         new SequenceManager(JiveConstants.ROSTER, 5);

src/java/org/jivesoftware/messenger/spi/PresenceManagerImpl.java

@@ -69,9 +69,9 @@ public class PresenceManagerImpl extends BasicModule implements PresenceManager
 
         // create caches - no size limit and never expire for presence caches
         long HOUR = JiveConstants.HOUR;
-        onlineGuestCache = new DefaultCache("Online Guests", -1, -1);
-        onlineUserCache = new DefaultCache("Online Users", -1, -1);
-        foreignUserCache = new DefaultCache("Foreign Users", foreignCacheSize, HOUR);
+        onlineGuestCache = new Cache("Online Guests", -1, -1);
+        onlineUserCache = new Cache("Online Users", -1, -1);
+        foreignUserCache = new Cache("Foreign Users", foreignCacheSize, HOUR);
     }
 
     public boolean isAvailable(User user) throws UnauthorizedException {

src/java/org/jivesoftware/net/AcceptManager.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net;
 
 import java.net.InetSocketAddress;

src/java/org/jivesoftware/net/AcceptPolicy.java

@@ -3,14 +3,13 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
-package org.jivesoftware.net;
-
 
+package org.jivesoftware.net;
 
 /**
  * <p>Defines the rules that determine whether a connection should be

src/java/org/jivesoftware/net/AcceptPort.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net;
 
 import org.jivesoftware.net.AcceptPolicy;

src/java/org/jivesoftware/net/Connection.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net;
 
 import org.jivesoftware.messenger.auth.UnauthorizedException;

src/java/org/jivesoftware/net/ConnectionCloseListener.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net;
 
 /**

src/java/org/jivesoftware/net/ConnectionManager.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net;
 
 import java.util.Iterator;

src/java/org/jivesoftware/net/ConnectionMonitor.java

@@ -3,14 +3,13 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
-package org.jivesoftware.net;
 
-import org.jivesoftware.net.Connection;
+package org.jivesoftware.net;
 
 /**
  * <p>ConnectionMonitors record the activity of Connections for administration

src/java/org/jivesoftware/net/DataConsumer.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net;
 
 import java.nio.ByteBuffer;
@@ -23,6 +24,7 @@ import java.nio.ByteBuffer;
  * @author Iain Shigeoka
  */
 public interface DataConsumer {
+
     /**
      * <p>Set a data producer as a source of data when using the consumeAll()
      * method.</p>
@@ -52,4 +54,4 @@ public interface DataConsumer {
      * @param data The data to consume
      */
     void consume(ByteBuffer data);
-}
+}
\ No newline at end of file

src/java/org/jivesoftware/net/DataProducer.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net;
 
 import org.jivesoftware.net.DataConsumer;

src/java/org/jivesoftware/net/Monitor.java

@@ -3,37 +3,36 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net;
 
 import java.util.Date;
 
 /**
- * <p>Monitors a network usage.</p>
- *
- * <p>Monitors measure sample totals, and sample rate (samples per second).
- * Monitor information is used at runtime to adjust server behavior as well
- * as to generate reports on server history.</p>
+ * Monitors a network usage. Monitors measure sample totals, and sample rate
+ * (samples per second). Monitor information is used at runtime to adjust
+ * server behavior as well as to generate reports on server history.<p>
  *
- * <p>Based in part on the DataMonitor from Java Distributed Computing, Jim Farley,
- * O'Reilly.</p>
+ * Based in part on the DataMonitor from Java Distributed Computing, Jim Farley,
+ * O'Reilly.
  *
  * @author Iain Shigeoka
  */
 public interface Monitor {
 
     /**
-     * <p>Add the number of samples that occured between the given start and
-     * end times.</p>
+     * Add the number of samples that occured between the given start and
+     * end times.<p>
      *
-     * <p>The monitor does not check for overlapping sample times. It is
+     * The monitor does not check for overlapping sample times. It is
      * the caller's responsibility to ensure samples don't overlap. Failure
      * to prevent overlapping sample times may result in elapsed time
-     * being falsely counted and reported.</p>
+     * being falsely counted and reported.
      *
      * @param quantity The number of samples that occurred during the sample period
      * @param startTime The beginning of the sample period

src/java/org/jivesoftware/net/policies/AndPolicy.java

@@ -3,25 +3,25 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.policies;
 
 import org.jivesoftware.net.AcceptPolicy;
 import org.jivesoftware.net.Connection;
-import org.jivesoftware.net.Connection;
 
 /**
- * <p>Performs a basic logical AND evaluation on child policies (e.g. both must
- * evaluate to true in order for this policy to evaluate true).</p>
+ * Performs a basic logical AND evaluation on child policies (e.g. both must
+ * evaluate to true in order for this policy to evaluate true).<p>
  *
- * <p>This policy is useful for combining simpler policies to create
+ * This policy is useful for combining simpler policies to create
  * complex policy decisions. The comparison is done using the logical
  * AND operation so if the first policy evaluates to false, the second
- * policy is not evaluated.</p>
+ * policy is not evaluated.
  *
  * @author Iain Shigeoka
  */

src/java/org/jivesoftware/net/policies/BasicAcceptPolicy.java

@@ -3,21 +3,20 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.policies;
 
-import org.jivesoftware.net.AcceptPolicy;
-import org.jivesoftware.net.Connection;
 import org.jivesoftware.net.AcceptPolicy;
 import org.jivesoftware.net.Connection;
 
 /**
- * <p>The simplest possible accept policy that either accepts or rejects
- * all connections.</p>
+ * The simplest possible accept policy that either accepts or rejects
+ * all connections.
  *
  * @author Iain Shigeoka
  */
@@ -26,8 +25,8 @@ public class BasicAcceptPolicy implements AcceptPolicy {
     private boolean accept;
 
     /**
-     * <p>Create a basic accept policy that either accepts or denies all
-     * incoming connections.</p>
+     * Create a basic accept policy that either accepts or denies all
+     * incoming connections.
      *
      * @param alwaysAccept True if the policy should accept all connections
      */

src/java/org/jivesoftware/net/policies/NotPolicy.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.policies;
 
 import org.jivesoftware.net.AcceptPolicy;
@@ -15,11 +16,11 @@ import org.jivesoftware.net.Connection;
 import org.jivesoftware.net.AcceptPolicy;
 
 /**
- * <p>Performs a basic logical NOT evaluation on a child policy (e.g.
- * turns true to false and false to true).</p>
+ * Performs a basic logical NOT evaluation on a child policy (e.g.
+ * turns true to false and false to true).<p>
  *
- * <p>This policy is useful for combining simpler policies to create
- * complex policy decisions.</p>
+ * This policy is useful for combining simpler policies to create
+ * complex policy decisions.
  *
  * @author Iain Shigeoka
  */
@@ -28,7 +29,7 @@ public class NotPolicy implements AcceptPolicy {
     private AcceptPolicy pol;
 
     /**
-     * <p>Create an NOT policy for the given policy.</p>
+     * Create an NOT policy for the given policy.
      *
      * @param policy The policy that will be NOT'd
      */

src/java/org/jivesoftware/net/policies/OrPolicy.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.policies;
 
 import org.jivesoftware.net.AcceptPolicy;
@@ -15,13 +16,13 @@ import org.jivesoftware.net.Connection;
 import org.jivesoftware.net.AcceptPolicy;
 
 /**
- * <p>Performs a basic logical OR evaluation on child policies (e.g. if either
- * evaluate to true this policy will evaluate true).</p>
+ * Performs a basic logical OR evaluation on child policies (e.g. if either
+ * evaluate to true this policy will evaluate true).<p>
  *
- * <p>This policy is useful for combining simpler policies to create
+ * This policy is useful for combining simpler policies to create
  * complex policy decisions. The comparison is done using the logical
  * OR operation so if the first policy evaluates to true, the second
- * policy is not evaluated.</p>
+ * policy is not evaluated.
  *
  * @author Iain Shigeoka
  */

src/java/org/jivesoftware/net/policies/XorPolicy.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.policies;
 
 import org.jivesoftware.net.AcceptPolicy;
@@ -15,13 +16,13 @@ import org.jivesoftware.net.Connection;
 import org.jivesoftware.net.AcceptPolicy;
 
 /**
- * <p>Performs a bitwise logical XOR (exclusive OR) evaluation on
+ * Performs a bitwise logical XOR (exclusive OR) evaluation on
  * child policies (e.g. if both policies evaluate to true or false
- * the XOR result is false).</p>
+ * the XOR result is false).<p>
  *
- * <p>This policy is useful for combining simpler policies to create
+ * This policy is useful for combining simpler policies to create
  * complex policy decisions. The comparison is done using the bitwise
- * XOR operation so both policies will always be evaluated.</p>
+ * XOR operation so both policies will always be evaluated.
  *
  * @author Iain Shigeoka
  */
@@ -31,7 +32,7 @@ public class XorPolicy implements AcceptPolicy {
     private AcceptPolicy policy2;
 
     /**
-     * <p>Create an AND policy with the given two child policies.</p>
+     * Create an AND policy with the given two child policies.
      *
      * @param firstPolicy The first policy that will be evaluated
      * @param secondPolicy The first policy that will be evaluated
@@ -44,4 +45,4 @@ public class XorPolicy implements AcceptPolicy {
     public boolean evaluate(Connection connection) {
         return policy1.evaluate(connection) ^ policy2.evaluate(connection);
     }
-}
+}
\ No newline at end of file

src/java/org/jivesoftware/net/spi/AcceptManagerImpl.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.spi;
 
 import org.jivesoftware.net.ConnectionManager;

src/java/org/jivesoftware/net/spi/AcceptPortImpl.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.spi;
 
 import org.jivesoftware.net.policies.BasicAcceptPolicy;

src/java/org/jivesoftware/net/spi/BasicDataConsumer.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.spi;
 
 import org.jivesoftware.net.DataConsumer;

src/java/org/jivesoftware/net/spi/BasicDataProducer.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.spi;
 
 import org.jivesoftware.net.DataConsumer;
@@ -21,8 +22,8 @@ import org.jivesoftware.net.DataConsumer;
 import org.jivesoftware.net.DataProducer;
 
 /**
- * <p>A basic data producer that produces data from it's
- * source and adds samples to the monitor.</p>
+ * A basic data producer that produces data from it's
+ * source and adds samples to the monitor.
  *
  * @author Iain Shigeoka
  */

src/java/org/jivesoftware/net/spi/BasicTransientMonitor.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.spi;
 
 import org.jivesoftware.net.Monitor;
@@ -18,29 +19,21 @@ import java.util.concurrent.locks.ReadWriteLock;
 import java.util.concurrent.locks.ReentrantReadWriteLock;
 
 /**
- * <p>Implements a transient (in-memory) generic monitor.</p>
+ * Implements a transient (in-memory) generic monitor.
  *
  * @author Iain Shigeoka
  */
 public class BasicTransientMonitor implements Monitor {
 
-    /** <p>Total sample quantity.</p> */
+    private static final int DEFAULT_FRAME_SIZE = 20;
+
     private long totalSamples;
-    /** <p>The total sampling time</p> */
     private long totalTime;
-    /** <p>The time of the last sample end time.</p> */
     private long lastSampleTime = -1;
-    /** <p>The time of the first sample taken.</p> */
     private long firstSampleTime = -1;
-    /** <p>The time the monitor was created.</p> */
     private Date startUpTime;
-    /** <p>The size of a sample frame in sample events.</p> */
     private int frameSize;
-    /** <p>The default size of a sample frame (20 events). </p> */
-    private static final int DEFAULT_FRAME_SIZE = 20;
-    /** <p>Frame data stored in a circular list.</p> */
     private CircularLinkedList frameList = new CircularLinkedList();
-    /** <p>lock on the frame list</p> */
     private ReadWriteLock frameLock = new ReentrantReadWriteLock();
 
     public BasicTransientMonitor(){

src/java/org/jivesoftware/net/spi/ConnectionManagerImpl.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.spi;
 
 import org.jivesoftware.net.ConnectionManager;

src/java/org/jivesoftware/net/spi/SocketChannelConnection.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.spi;
 
 import java.util.Date;

src/java/org/jivesoftware/net/spi/SocketDataConsumer.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.spi;
 
 import org.jivesoftware.net.Connection;
@@ -18,10 +19,9 @@ import java.nio.ByteBuffer;
 
 import org.jivesoftware.net.spi.BasicDataConsumer;
 
-
 /**
- * <p>Socket data consumer implementation designed to work intimately with
- * the SocketConnection class.</p>
+ * Socket data consumer implementation designed to work intimately with
+ * the SocketConnection class.
  *
  * @author Iain Shigeoka
  */

src/java/org/jivesoftware/net/spi/SocketDataProducer.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.spi;
 
 import org.jivesoftware.net.Connection;
@@ -19,7 +20,7 @@ import org.jivesoftware.net.spi.BasicDataProducer;
 import org.jivesoftware.net.Connection;
 
 /**
- * <p>Produces data from the input stream of a socket connection.</p>
+ * Produces data from the input stream of a socket connection.
  *
  * @author Iain Shigeoka
  */

src/java/org/jivesoftware/net/spi/TransientConnectionMonitor.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.net.spi;
 
 import org.jivesoftware.net.Connection;
@@ -16,7 +17,7 @@ import org.jivesoftware.net.spi.BasicTransientMonitor;
 import org.jivesoftware.net.Connection;
 
 /**
- * <p>Transient (in-memory) implementation of a connection monitor.</p>
+ * Transient (in-memory) implementation of a connection monitor.
  *
  * @author Iain Shigeoka
  */

src/java/org/jivesoftware/util/AlreadyExistsException.java

-/*
+/**
  * $RCSfile$
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 /**

src/java/org/jivesoftware/util/BasicResultFilter.java

-/*
+/**
  * $RCSfile$
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 import java.util.Iterator;

src/java/org/jivesoftware/util/BeanUtils.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2001 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;

src/java/org/jivesoftware/util/ByteFormat.java

@@ -3,10 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2002 Jive Software. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of Jive Software. Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 import java.text.DecimalFormat;
@@ -22,25 +24,6 @@ import java.text.ParsePosition;
  */
 public class ByteFormat extends Format {
 
-//    private long numBytes = 0;
-
-    public ByteFormat() {
-    }
-
-//    public ByteFormat(int numBytes) {
-//        this.numBytes = numBytes;
-//    }
-//
-//    public long getNumBytes() {
-//        return numBytes;
-//    }
-//
-//    public void setNumBytes(long numBytes) {
-//        this.numBytes = numBytes;
-//    }
-
-    // Implemented from the Format class
-
     /**
      * Formats a long which represent a number of bytes.
      */
@@ -88,4 +71,4 @@ public class ByteFormat extends Format {
     public Object parseObject(String source, ParsePosition pos) {
         return null;
     }
-}
+}
\ No newline at end of file

src/java/org/jivesoftware/util/Cache.java

-/*
+/**
  * $RCSfile$
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;
 
+import java.io.IOException;
+import java.io.ObjectOutputStream;
+import java.io.OutputStream;
+import java.util.*;
+
 /**
- * General purpose cache. It stores objects associated with unique keys in
- * memory for fast access. All keys and values added to the cache must
- * implement the Serializable interface. Values may implement the Cacheable
- * interface, which allows the cache to determine object size much more quickly.
- * These restrictions allow a cache to never grow larger than a specified number
- * of bytes and to optionally be distributed over a cluster of servers.<p>
- * <p/>
- * If the cache does grow too large, objects will be removed such that those
- * that are accessed least frequently are removed first. Because expiration
- * happens automatically, the cache makes <b>no</b> gaurantee as to how long
- * an object will remain in cache after it is put in.<p>
- * <p/>
- * Optionally, a maximum lifetime for all objects can be specified. In that
- * case, objects will be deleted from cache after that amount of time, even
- * if they are frequently accessed. This feature is useful if objects put in
- * cache represent data that should be periodically refreshed; for example,
- * information from a database.<p>
- * <p/>
- * All cache operations are thread safe.<p>
+ * Default, non-distributed implementation of the Cache interface.
+ * The algorithm for cache is as follows: a HashMap is maintained for fast
+ * object lookup. Two linked lists are maintained: one keeps objects in the
+ * order they are accessed from cache, the other keeps objects in the order
+ * they were originally added to cache. When objects are added to cache, they
+ * are first wrapped by a CacheObject which maintains the following pieces
+ * of information:<ul>
+ *
+ * <li> The size of the object (in bytes).
+ * <li> A pointer to the node in the linked list that maintains accessed
+ * order for the object. Keeping a reference to the node lets us avoid
+ * linear scans of the linked list.
+ * <li> A pointer to the node in the linked list that maintains the age
+ * of the object in cache. Keeping a reference to the node lets us avoid
+ * linear scans of the linked list.</ul><p>
+ *
+ * To get an object from cache, a hash lookup is performed to get a reference
+ * to the CacheObject that wraps the real object we are looking for.
+ * The object is subsequently moved to the front of the accessed linked list
+ * and any necessary cache cleanups are performed. Cache deletion and expiration
+ * is performed as needed.
  *
  * @author Matt Tucker
- * @see Cacheable
  */
-public interface Cache extends java.util.Map, CacheInfo {
-}
+public class Cache {
+
+    /**
+     * The map the keys and values are stored in.
+     */
+    protected Map map;
+
+    /**
+     * Linked list to maintain order that cache objects are accessed
+     * in, most used to least used.
+     */
+    protected org.jivesoftware.util.LinkedList lastAccessedList;
+
+    /**
+     * Linked list to maintain time that cache objects were initially added
+     * to the cache, most recently added to oldest added.
+     */
+    protected LinkedList ageList;
+
+    /**
+     * Maximum size in bytes that the cache can grow to.
+     */
+    private int maxCacheSize;
+
+    /**
+     * Maintains the current size of the cache in bytes.
+     */
+    private int cacheSize = 0;
+
+    /**
+     * Maximum length of time objects can exist in cache before expiring.
+     */
+    protected long maxLifetime;
+
+    /**
+     * Maintain the number of cache hits and misses. A cache hit occurs every
+     * time the get method is called and the cache contains the requested
+     * object. A cache miss represents the opposite occurence.<p>
+     *
+     * Keeping track of cache hits and misses lets one measure how efficient
+     * the cache is; the higher the percentage of hits, the more efficient.
+     */
+    protected long cacheHits, cacheMisses = 0L;
+
+    /**
+     * The name of the cache.
+     */
+    private String name;
+
+    /**
+     * Create a new cache and specify the maximum size of for the cache in
+     * bytes, and the maximum lifetime of objects.
+     *
+     * @param name a name for the cache.
+     * @param maxSize the maximum size of the cache in bytes. -1 means the cache
+     *      has no max size.
+     * @param maxLifetime the maximum amount of time objects can exist in
+     *      cache before being deleted. -1 means objects never expire.
+     */
+    public Cache(String name, int maxSize, long maxLifetime) {
+        this.name = name;
+        this.maxCacheSize = maxSize;
+        this.maxLifetime = maxLifetime;
+
+        // Our primary data structure is a HashMap. The default capacity of 11
+        // is too small in almost all cases, so we set it bigger.
+        map = new HashMap(103);
+
+        lastAccessedList = new LinkedList();
+        ageList = new LinkedList();
+    }
+
+    public synchronized Object put(Object key, Object value) {
+        // Delete an old entry if it exists.
+        remove(key);
+
+        int objectSize = calculateSize(value);
+
+        // If the object is bigger than the entire cache, simply don't add it.
+        if (maxCacheSize > 0 && objectSize > maxCacheSize * .90) {
+            Log.warn("Cache: " + name + " -- object with key " + key +
+                    " is too large to fit in cache. Size is " + objectSize);
+            return value;
+        }
+        cacheSize += objectSize;
+        CacheObject cacheObject = new CacheObject(value, objectSize);
+        map.put(key, cacheObject);
+        // Make an entry into the cache order list.
+        LinkedListNode lastAccessedNode = lastAccessedList.addFirst(key);
+        // Store the cache order list entry so that we can get back to it
+        // during later lookups.
+        cacheObject.lastAccessedListNode = lastAccessedNode;
+        // Add the object to the age list
+        LinkedListNode ageNode = ageList.addFirst(key);
+        // We make an explicit call to currentTimeMillis() so that total accuracy
+        // of lifetime calculations is better than one second.
+        ageNode.timestamp = System.currentTimeMillis();
+        cacheObject.ageListNode = ageNode;
+
+        // If cache is too full, remove least used cache entries until it is
+        // not too full.
+        cullCache();
+
+        return value;
+    }
+
+    public synchronized Object get(Object key) {
+        // First, clear all entries that have been in cache longer than the
+        // maximum defined age.
+        deleteExpiredEntries();
+
+        CacheObject cacheObject = (CacheObject)map.get(key);
+        if (cacheObject == null) {
+            // The object didn't exist in cache, so increment cache misses.
+            cacheMisses++;
+            return null;
+        }
+
+        // The object exists in cache, so increment cache hits. Also, increment
+        // the object's read count.
+        cacheHits++;
+        cacheObject.readCount++;
+
+        // Remove the object from it's current place in the cache order list,
+        // and re-insert it at the front of the list.
+        cacheObject.lastAccessedListNode.remove();
+        lastAccessedList.addFirst(cacheObject.lastAccessedListNode);
+
+        return cacheObject.object;
+    }
+
+    public synchronized Object remove(Object key) {
+        CacheObject cacheObject = (CacheObject)map.get(key);
+        // If the object is not in cache, stop trying to remove it.
+        if (cacheObject == null) {
+            return null;
+        }
+        // remove from the hash map
+        map.remove(key);
+        // remove from the cache order list
+        cacheObject.lastAccessedListNode.remove();
+        cacheObject.ageListNode.remove();
+        // remove references to linked list nodes
+        cacheObject.ageListNode = null;
+        cacheObject.lastAccessedListNode = null;
+        // removed the object, so subtract its size from the total.
+        cacheSize -= cacheObject.size;
+        return cacheObject.object;
+    }
+
+    public synchronized void clear() {
+        Object[] keys = map.keySet().toArray();
+        for (int i = 0; i < keys.length; i++) {
+            remove(keys[i]);
+        }
+
+        // Now, reset all containers.
+        map.clear();
+        lastAccessedList.clear();
+        lastAccessedList = new LinkedList();
+        ageList.clear();
+        ageList = new LinkedList();
+
+        cacheSize = 0;
+        cacheHits = 0;
+        cacheMisses = 0;
+    }
+
+    public int size() {
+        // First, clear all entries that have been in cache longer than the
+        // maximum defined age.
+        deleteExpiredEntries();
+
+        return map.size();
+    }
+
+    public boolean isEmpty() {
+        // First, clear all entries that have been in cache longer than the
+        // maximum defined age.
+        deleteExpiredEntries();
+
+        return map.isEmpty();
+    }
+
+    public Collection values() {
+        // First, clear all entries that have been in cache longer than the
+        // maximum defined age.
+        deleteExpiredEntries();
+
+        Object[] cacheObjects = map.values().toArray();
+        Object[] values = new Object[cacheObjects.length];
+        for (int i = 0; i < cacheObjects.length; i++) {
+            values[i] = ((CacheObject)cacheObjects[i]).object;
+        }
+        return Collections.unmodifiableList(Arrays.asList(values));
+    }
+
+    public boolean containsKey(Object key) {
+        // First, clear all entries that have been in cache longer than the
+        // maximum defined age.
+        deleteExpiredEntries();
+
+        return map.containsKey(key);
+    }
+
+    public void putAll(Map map) {
+        for (Iterator i = map.keySet().iterator(); i.hasNext();) {
+            Object key = i.next();
+            Object value = map.get(key);
+            put(key, value);
+        }
+    }
+
+    public boolean containsValue(Object value) {
+        // First, clear all entries that have been in cache longer than the
+        // maximum defined age.
+        deleteExpiredEntries();
+
+        int objectSize = calculateSize(value);
+        CacheObject cacheObject = new CacheObject(value, objectSize);
+        return map.containsValue(cacheObject);
+    }
+
+    public Set entrySet() {
+        // First, clear all entries that have been in cache longer than the
+        // maximum defined age.
+        deleteExpiredEntries();
+
+        return Collections.unmodifiableSet(map.entrySet());
+    }
+
+    public Set keySet() {
+        // First, clear all entries that have been in cache longer than the
+        // maximum defined age.
+        deleteExpiredEntries();
+
+        return Collections.unmodifiableSet(map.keySet());
+    }
+
+    /**
+     * Returns the name of this cache. The name is completely arbitrary
+     * and used only for display to administrators.
+     *
+     * @return the name of this cache.
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Returns the number of cache hits. A cache hit occurs every
+     * time the get method is called and the cache contains the requested
+     * object.<p>
+     *
+     * Keeping track of cache hits and misses lets one measure how efficient
+     * the cache is; the higher the percentage of hits, the more efficient.
+     *
+     * @return the number of cache hits.
+     */
+    public long getCacheHits() {
+        return cacheHits;
+    }
+
+    /**
+     * Returns the number of cache misses. A cache miss occurs every
+     * time the get method is called and the cache does not contain the
+     * requested object.<p>
+     *
+     * Keeping track of cache hits and misses lets one measure how efficient
+     * the cache is; the higher the percentage of hits, the more efficient.
+     *
+     * @return the number of cache hits.
+     */
+    public long getCacheMisses() {
+        return cacheMisses;
+    }
+
+    /**
+     * Returns the size of the cache contents in bytes. This value is only a
+     * rough approximation, so cache users should expect that actual VM
+     * memory used by the cache could be significantly higher than the value
+     * reported by this method.
+     *
+     * @return the size of the cache contents in bytes.
+     */
+    public int getCacheSize() {
+        return cacheSize;
+    }
+
+    /**
+     * Returns the maximum size of the cache (in bytes). If the cache grows larger
+     * than the max size, the least frequently used items will be removed. If
+     * the max cache size is set to -1, there is no size limit.
+     *
+     * @return the maximum size of the cache (-1 indicates unlimited max size).
+     */
+    public int getMaxCacheSize() {
+        return maxCacheSize;
+    }
+
+    /**
+     * Sets the maximum size of the cache. If the cache grows larger
+     * than the max size, the least frequently used items will be removed. If
+     * the max cache size is set to -1, there is no size limit.
+     *
+     * @param maxCacheSize the maximum size of this cache (-1 indicates unlimited max size).
+     */
+    public void setMaxCacheSize(int maxCacheSize) {
+        this.maxCacheSize = maxCacheSize;
+        // It's possible that the new max size is smaller than our current cache
+        // size. If so, we need to delete infrequently used items.
+        cullCache();
+    }
+
+    /**
+     * Returns the maximum number of milleseconds that any object can live
+     * in cache. Once the specified number of milleseconds passes, the object
+     * will be automatically expried from cache. If the max lifetime is set
+     * to -1, then objects never expire.
+     *
+     * @return the maximum number of milleseconds before objects are expired.
+     */
+    public long getMaxLifetime() {
+        return maxLifetime;
+    }
+
+    /**
+     * Sets the maximum number of milleseconds that any object can live
+     * in cache. Once the specified number of milleseconds passes, the object
+     * will be automatically expried from cache. If the max lifetime is set
+     * to -1, then objects never expire.
+     *
+     * @param maxLifetime the maximum number of milleseconds before objects are expired.
+     */
+    public void setMaxLifetime(long maxLifetime) {
+        this.maxLifetime = maxLifetime;
+    }
+
+    /**
+     * Returns the size of an object in bytes. Determining size by serialization
+     * is only used as a last resort.
+     *
+     * @return the size of an object in bytes.
+     */
+    private int calculateSize(Object object) {
+        // If the object is Cacheable, ask it its size.
+        if (object instanceof Cacheable) {
+            return ((Cacheable)object).getCachedSize();
+        }
+        // Check for other common types of objects put into cache.
+        else if (object instanceof Long) {
+            return CacheSizes.sizeOfLong();
+        }
+        else if (object instanceof Integer) {
+            return CacheSizes.sizeOfObject() + CacheSizes.sizeOfInt();
+        }
+        else if (object instanceof Boolean) {
+            return CacheSizes.sizeOfObject() + CacheSizes.sizeOfBoolean();
+        }
+        else if (object instanceof long[]) {
+            long[] array = (long[])object;
+            return CacheSizes.sizeOfObject() + array.length * CacheSizes.sizeOfLong();
+        }
+        // Default behavior -- serialize the object to determine its size.
+        else {
+            int size = 1;
+            try {
+                // Default to serializing the object out to determine size.
+                NullOutputStream out = new NullOutputStream();
+                ObjectOutputStream outObj = new ObjectOutputStream(out);
+                outObj.writeObject(object);
+                size = out.size();
+            }
+            catch (IOException ioe) {
+                Log.error(ioe);
+            }
+            return size;
+        }
+    }
+
+    /**
+     * Clears all entries out of cache where the entries are older than the
+     * maximum defined age.
+     */
+    protected void deleteExpiredEntries() {
+        // Check if expiration is turned on.
+        if (maxLifetime <= 0) {
+            return;
+        }
+
+        // Remove all old entries. To do this, we remove objects from the end
+        // of the linked list until they are no longer too old. We get to avoid
+        // any hash lookups or looking at any more objects than is strictly
+        // neccessary.
+        LinkedListNode node = ageList.getLast();
+        // If there are no entries in the age list, return.
+        if (node == null) {
+            return;
+        }
+
+        // Determine the expireTime, which is the moment in time that elements
+        // should expire from cache. Then, we can do an easy to check to see
+        // if the expire time is greater than the expire time.
+        long expireTime = System.currentTimeMillis() - maxLifetime;
+
+        while (expireTime > node.timestamp) {
+            // Remove the object
+            remove(node.object);
+
+            // Get the next node.
+            node = ageList.getLast();
+            // If there are no more entries in the age list, return.
+            if (node == null) {
+                return;
+            }
+        }
+    }
+
+    /**
+     * Removes objects from cache if the cache is too full. "Too full" is
+     * defined as within 3% of the maximum cache size. Whenever the cache is
+     * is too big, the least frequently used elements are deleted until the
+     * cache is at least 10% empty.
+     */
+    protected final void cullCache() {
+        // Check if a max cache size is defined.
+        if (maxCacheSize < 0) {
+            return;
+        }
+
+        // See if the cache size is within 3% of being too big. If so, clean out
+        // cache until it's 10% free.
+        if (cacheSize >= maxCacheSize * .97) {
+            // First, delete any old entries to see how much memory that frees.
+            deleteExpiredEntries();
+            int desiredSize = (int)(maxCacheSize * .90);
+            while (cacheSize > desiredSize) {
+                // Get the key and invoke the remove method on it.
+                remove(lastAccessedList.getLast().object);
+            }
+        }
+    }
+
+    /**
+     * Wrapper for all objects put into cache. It's primary purpose is to maintain
+     * references to the linked lists that maintain the creation time of the object
+     * and the ordering of the most used objects.
+     */
+    private static class CacheObject {
+
+        /**
+         * Underlying object wrapped by the CacheObject.
+         */
+        public Object object;
+
+        /**
+         * The size of the Cacheable object. The size of the Cacheable
+         * object is only computed once when it is added to the cache. This makes
+         * the assumption that once objects are added to cache, they are mostly
+         * read-only and that their size does not change significantly over time.
+         */
+        public int size;
+
+        /**
+         * A reference to the node in the cache order list. We keep the reference
+         * here to avoid linear scans of the list. Every time the object is
+         * accessed, the node is removed from its current spot in the list and
+         * moved to the front.
+         */
+        public LinkedListNode lastAccessedListNode;
+
+        /**
+         * A reference to the node in the age order list. We keep the reference
+         * here to avoid linear scans of the list. The reference is used if the
+         * object has to be deleted from the list.
+         */
+        public LinkedListNode ageListNode;
+
+        /**
+         * A count of the number of times the object has been read from cache.
+         */
+        public int readCount = 0;
+
+        /**
+         * Creates a new cache object wrapper. The size of the Cacheable object
+         * must be passed in in order to prevent another possibly expensive
+         * lookup by querying the object itself for its size.<p>
+         *
+         * @param object the underlying Object to wrap.
+         * @param size   the size of the Cachable object in bytes.
+         */
+        public CacheObject(Object object, int size) {
+            this.object = object;
+            this.size = size;
+        }
+    }
+
+    /**
+     * An extension of OutputStream that does nothing but calculate the number
+     * of bytes written through it.
+     */
+    private static class NullOutputStream extends OutputStream {
+
+        int size = 0;
+
+        public void write(int b) throws IOException {
+            size++;
+        }
+
+        public void write(byte[] b) throws IOException {
+            size += b.length;
+        }
+
+        public void write(byte[] b, int off, int len) {
+            size += len;
+        }
+
+        /**
+         * Returns the number of bytes written out through the stream.
+         *
+         * @return the number of bytes written to the stream.
+         */
+        public int size() {
+            return size;
+        }
+    }
+}
\ No newline at end of file

src/java/org/jivesoftware/util/CacheManager.java

@@ -11,31 +11,18 @@
 package org.jivesoftware.util;
 
 import org.jivesoftware.messenger.container.ModuleContext;
-import org.jivesoftware.util.JiveConstants;
-import org.jivesoftware.util.Cache;
-import org.jivesoftware.util.CacheFactory;
 
 import java.util.Hashtable;
 
 /**
- * <p>A centralized, JVM static manager of Jive caches.</p>
- * <p/>
- * <p>Caches are essential for scalability of Jive software. Only Jive objects should access the cache!
- * 3rd parties are discouraged from modifying or using the Jive caches without consulting with Jive
- * engineers on consequences.</p>
+ * A centralized, JVM static manager of Jive caches. Caches are essential for
+ * scalability.
  *
  * @author Iain Shigeoka
- *         <p/>
  */
 public class CacheManager {
 
-    /**
-     * <p>The map for accessing the caches.</p>
-     */
     private static Hashtable caches = new Hashtable();
-    /**
-     * <p>The max lifetime of items in any cache.</p>
-     */
     private static long maxLifetime = JiveConstants.HOUR * 6;
 
     /**
@@ -63,15 +50,15 @@ public class CacheManager {
                 catch (NumberFormatException e) { /* ignore */
                 }
             }
-            caches.put(name, CacheFactory.createCache(name, maxCacheSize, maxLifetime));
+            caches.put(name, new Cache(name, maxCacheSize, maxLifetime));
         }
     }
 
     /**
-     * <p>Obtain a cache by name.</p>
+     * Returns the cache specified by name.
      *
-     * @param name The name of the cache to retrieve
-     * @return The cache found, or null if no cache by that name has been initialized
+     * @param name the name of the cache to return.
+     * @return the cache found, or null if no cache by that name has been initialized.
      */
     public static Cache getCache(String name) {
         return (Cache)caches.get(name);

src/java/org/jivesoftware/util/CacheSizes.java

-/*
+/**
  * $RCSfile$
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;

src/java/org/jivesoftware/util/Cacheable.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;
@@ -16,7 +16,7 @@ package org.jivesoftware.util;
  * Objects only need to know how big they are (in bytes). That size
  * should be considered to be a best estimate of how much memory the Object
  * occupies and may be based on empirical trials or dynamic calculations.<p>
- * <p/>
+ *
  * While the accuracy of the size calculation is important, care should be
  * taken to minimize the computation time so that cache operations are
  * speedy.

src/java/org/jivesoftware/util/CircularLinkedList.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2001 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;
@@ -14,7 +14,6 @@ package org.jivesoftware.util;
 import java.util.concurrent.locks.ReadWriteLock;
 import java.util.concurrent.locks.ReentrantReadWriteLock;
 
-
 /**
  * <p>Simple circular LinkedList allowing the marking of a position, reset of position, and pass count.</p>
  * <p>The circular list provides several tools for 'spinning' the circular list.

src/java/org/jivesoftware/util/ClassUtils.java

@@ -3,12 +3,11 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
-
 package org.jivesoftware.util;
 
 /**

src/java/org/jivesoftware/util/ConcurrentHashSet.java

+/**
+ * $RCSfile$
+ * $Revision$
+ * $Date$
+ *
+ * Copyright (C) 2004 Jive Software. All rights reserved.
+ *
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
+ */
+
 package org.jivesoftware.util;
 
 import java.util.*;

src/java/org/jivesoftware/util/Enum.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 /**

src/java/org/jivesoftware/util/FileCopier.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 import java.io.File;

src/java/org/jivesoftware/util/IDFactory.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 /**

src/java/org/jivesoftware/util/IntEnum.java

@@ -3,14 +3,15 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
-import java.util.Hashtable;
+import java.util.*;
 
 /**
  * <p>A type safe enumeration object that is keyed by an Int
@@ -25,7 +26,9 @@ import java.util.Hashtable;
  * @author Iain Shigeoka
  */
 public class IntEnum extends Enum {
+
     private int value;
+    protected static Hashtable enumTypes = new Hashtable();
 
     protected IntEnum(String name, int val) {
         super(name);
@@ -53,17 +56,15 @@ public class IntEnum extends Enum {
         }
     }
 
-    protected static Hashtable enumTypes = new Hashtable();
-
     /**
      * <p>Checks in an enum for use in the getEnumFromInt() method.</p>
      *
      * @param enumeration The enum to be registered
      */
     protected static void register(IntEnum enumeration) {
-        LongHashMap enums = (LongHashMap)enumTypes.get(enumeration.getClass());
+        Map enums = (Map)enumTypes.get(enumeration.getClass());
         if (enums == null) {
-            enums = new LongHashMap();
+            enums = new HashMap<Integer,Object>();
             enumTypes.put(enumeration.getClass(), enums);
         }
         enums.put(enumeration.getValue(), enumeration);
@@ -77,7 +78,7 @@ public class IntEnum extends Enum {
      * @return The associated enum or null if no matching enum exists
      */
     protected static IntEnum getEnumFromInt(Class enumClass, int value) {
-        LongHashMap enums = (LongHashMap)enumTypes.get(enumClass);
+        Map enums = (Map)enumTypes.get(enumClass);
         if (enums != null) {
             return (IntEnum)enums.get(value);
         }
@@ -91,4 +92,4 @@ public class IntEnum extends Enum {
     public String toString() {
         return Integer.toString(value) + " " + super.toString();
     }
-}
+}
\ No newline at end of file

src/java/org/jivesoftware/util/JiveBeanInfo.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2001 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;

src/java/org/jivesoftware/util/JiveConstants.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 2002 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 /**

src/java/org/jivesoftware/util/LinkedList.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2001 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;

src/java/org/jivesoftware/util/LinkedListNode.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2001 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;

src/java/org/jivesoftware/util/LocaleUtils.java

@@ -3,9 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 Jive Software. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of Jive Software. Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;

src/java/org/jivesoftware/util/Log.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 2002 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 import org.jivesoftware.util.log.Hierarchy;

src/java/org/jivesoftware/util/LongList.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2001 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;

src/java/org/jivesoftware/util/LongTree.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2001 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;

src/java/org/jivesoftware/util/NotFoundException.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 /**

src/java/org/jivesoftware/util/ParamUtils.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2001 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;

src/java/org/jivesoftware/util/ProxyFactory.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 2002 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 import org.jivesoftware.messenger.auth.AuthToken;

src/java/org/jivesoftware/util/StreamCopier.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 import java.io.IOException;

src/java/org/jivesoftware/util/StringUtils.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2001 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;
@@ -23,8 +23,6 @@ import java.util.Random;
 
 /**
  * Utility class to peform common String manipulation algorithms.
- *
- * @author Iain Shigeoka
  */
 public class StringUtils {
 

src/java/org/jivesoftware/util/StringXMLStreamWriter.java

@@ -3,11 +3,12 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 import java.io.StringWriter;

src/java/org/jivesoftware/util/Version.java

@@ -3,12 +3,11 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
-
 package org.jivesoftware.util;
 
 /**

src/java/org/jivesoftware/util/WebBean.java

+/**
+ * $RCSfile$
+ * $Revision$
+ * $Date$
+ *
+ * Copyright (C) 2004 Jive Software. All rights reserved.
+ *
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
+ */
+
 package org.jivesoftware.util;
 
 import javax.servlet.ServletContext;

src/java/org/jivesoftware/util/WebManager.java

+/**
+ * $RCSfile$
+ * $Revision$
+ * $Date$
+ *
+ * Copyright (C) 2004 Jive Software. All rights reserved.
+ *
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
+ */
+
 package org.jivesoftware.util;
 
 import org.jivesoftware.messenger.chat.ChatServer;

src/java/org/jivesoftware/util/XMLProperties.java

@@ -3,10 +3,10 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2001 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
 
 package org.jivesoftware.util;

src/java/org/jivesoftware/util/XPPReader.java

@@ -3,12 +3,11 @@
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
-
 package org.jivesoftware.util;
 
 import java.io.Reader;

src/java/org/jivesoftware/util/XPPWriter.java

-/*
+/**
  * $RCSfile$
  * $Revision$
  * $Date$
  *
- * Copyright (C) 1999-2003 CoolServlets, Inc. All rights reserved.
+ * Copyright (C) 2004 Jive Software. All rights reserved.
  *
- * This software is the proprietary information of CoolServlets, Inc.
- * Use is subject to license terms.
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
  */
+
 package org.jivesoftware.util;
 
 import org.jivesoftware.messenger.XMPPFragment;