Initial version.

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

src/java/org/jivesoftware/util/cache/DummyExternalizableUtil.java

+/**
+ * $RCSfile$
+ * $Revision: $
+ * $Date: $
+ *
+ * Copyright (C) 2007 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.cache;
+
+import java.io.DataInput;
+import java.io.DataOutput;
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Dummy implementation that does nothing. The open source version of the server uses this
+ * strategy.
+ *
+ * @author Gaston Dombiak
+ */
+public class DummyExternalizableUtil implements ExternalizableUtilStrategy {
+    /**
+     * Writes a Map of String key and value pairs. This method handles the
+     * case when the Map is <tt>null</tt>.
+     *
+     * @param out       the output stream.
+     * @param stringMap the Map of String key/value pairs.
+     * @throws java.io.IOException if an error occurs.
+     */
+    public void writeStringMap(DataOutput out, Map<String, String> stringMap) throws IOException {
+        // Do nothing
+    }
+
+    /**
+     * Reads a Map of String key and value pairs. This method will return
+     * <tt>null</tt> if the Map written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return a Map of String key/value pairs.
+     * @throws IOException if an error occurs.
+     */
+    public Map<String, String> readStringMap(DataInput in) throws IOException {
+        // Do nothing
+        return Collections.emptyMap();
+    }
+
+    /**
+     * Writes a Map of Long key and Integer value pairs. This method handles
+     * the case when the Map is <tt>null</tt>.
+     *
+     * @param out the output stream.
+     * @param map the Map of Long key/Integer value pairs.
+     * @throws IOException if an error occurs.
+     */
+    public void writeLongIntMap(DataOutput out, Map<Long, Integer> map) throws IOException {
+        // Do nothing
+    }
+
+    /**
+     * Reads a Map of Long key and Integer value pairs. This method will return
+     * <tt>null</tt> if the Map written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return a Map of Long key/Integer value pairs.
+     * @throws IOException if an error occurs.
+     */
+    public Map readLongIntMap(DataInput in) throws IOException {
+        // Do nothing
+        return Collections.emptyMap();
+    }
+
+    /**
+     * Writes a List of Strings. This method handles the case when the List is
+     * <tt>null</tt>.
+     *
+     * @param out        the output stream.
+     * @param stringList the List of Strings.
+     * @throws IOException if an error occurs.
+     */
+    public void writeStringList(DataOutput out, List stringList) throws IOException {
+        // Do nothing
+    }
+
+    /**
+     * Reads a List of Strings. This method will return <tt>null</tt> if the List
+     * written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return a List of Strings.
+     * @throws IOException if an error occurs.
+     */
+    public List<String> readStringList(DataInput in) throws IOException {
+        // Do nothing
+        return Collections.emptyList();
+    }
+
+    /**
+     * Writes an array of long values. This method handles the case when the
+     * array is <tt>null</tt>.
+     *
+     * @param out   the output stream.
+     * @param array the array of long values.
+     * @throws IOException if an error occurs.
+     */
+    public void writeLongArray(DataOutput out, long[] array) throws IOException {
+        // Do nothing
+    }
+
+    /**
+     * Reads an array of long values. This method will return <tt>null</tt> if
+     * the array written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return an array of long values.
+     * @throws IOException if an error occurs.
+     */
+    public long[] readLongArray(DataInput in) throws IOException {
+        // Do nothing
+        return new long[]{};
+    }
+
+    public void writeLong(DataOutput out, long value) {
+        // Do nothing
+    }
+
+    public long readLong(DataInput in) {
+        // Do nothing
+        return 0;
+    }
+
+    public void writeBoolean(DataOutput out, boolean value) {
+        // Do nothing
+    }
+
+    public boolean readBoolean(DataInput in) {
+        // Do nothing
+        return false;
+    }
+
+    public void writeSafeUTF(DataOutput out, String value) {
+        // Do nothing
+    }
+
+    public String readSafeUTF(DataInput in) {
+        // Do nothing
+        return "";
+    }
+}

src/java/org/jivesoftware/util/cache/ExternalizableUtil.java

+/**
+ * $RCSfile$
+ * $Revision: $
+ * $Date: $
+ *
+ * Copyright (C) 2007 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.cache;
+
+import java.io.DataInput;
+import java.io.DataOutput;
+import java.io.IOException;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Utility methods to assist in working with the Externalizable interfaces. This class
+ * is only used when running inside of a Cluser. When using the open source version
+ * this class will use a dummy implementation. Anyway, this class is not used when
+ * not using the Enterprise edition.<p>
+ *
+ * ExternalizableLite is very similar to the standard Externalizable interface, except that
+ * it uses DataOutput/DataInput instead of the Object stream equivalents.
+ *
+ * @author Gaston Dombiak
+ */
+public class ExternalizableUtil {
+
+    private static ExternalizableUtil instance = new ExternalizableUtil();
+
+    private ExternalizableUtilStrategy strategy = new DummyExternalizableUtil();
+
+    static {
+        instance = new ExternalizableUtil();
+    }
+
+    public static ExternalizableUtil getInstance() {
+        return instance;
+    }
+    
+    /**
+     * Hidding constructor. We only want one single instance.
+     */
+    private ExternalizableUtil() {
+        super();
+    }
+
+    /**
+     * Writes a Map of String key and value pairs. This method handles the
+     * case when the Map is <tt>null</tt>.
+     *
+     * @param out       the output stream.
+     * @param stringMap the Map of String key/value pairs.
+     * @throws java.io.IOException if an error occurs.
+     */
+    public void writeStringMap(DataOutput out, Map<String, String> stringMap) throws IOException {
+        strategy.writeStringMap(out, stringMap);
+    }
+
+    /**
+     * Reads a Map of String key and value pairs. This method will return
+     * <tt>null</tt> if the Map written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return a Map of String key/value pairs.
+     * @throws IOException if an error occurs.
+     */
+    public Map<String, String> readStringMap(DataInput in) throws IOException {
+        return strategy.readStringMap(in);
+    }
+
+    /**
+     * Writes a Map of Long key and Integer value pairs. This method handles
+     * the case when the Map is <tt>null</tt>.
+     *
+     * @param out the output stream.
+     * @param map the Map of Long key/Integer value pairs.
+     * @throws IOException if an error occurs.
+     */
+    public void writeLongIntMap(DataOutput out, Map<Long, Integer> map) throws IOException {
+        strategy.writeLongIntMap(out, map);
+    }
+
+    /**
+     * Reads a Map of Long key and Integer value pairs. This method will return
+     * <tt>null</tt> if the Map written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return a Map of Long key/Integer value pairs.
+     * @throws IOException if an error occurs.
+     */
+    public Map readLongIntMap(DataInput in) throws IOException {
+        return strategy.readLongIntMap(in);
+    }
+
+    /**
+     * Writes a List of Strings. This method handles the case when the List is
+     * <tt>null</tt>.
+     *
+     * @param out        the output stream.
+     * @param stringList the List of Strings.
+     * @throws IOException if an error occurs.
+     */
+    public void writeStringList(DataOutput out, List stringList) throws IOException {
+        strategy.writeStringList(out, stringList);
+    }
+
+    /**
+     * Reads a List of Strings. This method will return <tt>null</tt> if the List
+     * written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return a List of Strings.
+     * @throws IOException if an error occurs.
+     */
+    public List<String> readStringList(DataInput in) throws IOException {
+        return strategy.readStringList(in);
+    }
+
+    /**
+     * Writes an array of long values. This method handles the case when the
+     * array is <tt>null</tt>.
+     *
+     * @param out   the output stream.
+     * @param array the array of long values.
+     * @throws IOException if an error occurs.
+     */
+    public void writeLongArray(DataOutput out, long [] array) throws IOException {
+        strategy.writeLongArray(out, array);
+    }
+
+    /**
+     * Reads an array of long values. This method will return <tt>null</tt> if
+     * the array written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return an array of long values.
+     * @throws IOException if an error occurs.
+     */
+    public long [] readLongArray(DataInput in) throws IOException {
+        return strategy.readLongArray(in);
+    }
+
+    public void writeLong(DataOutput out, long value) {
+        strategy.writeLong(out, value);
+    }
+
+    public long readLong(DataInput in) {
+        return strategy.readLong(in);
+    }
+
+    public void writeBoolean(DataOutput out, boolean value) {
+        strategy.writeBoolean(out, value);
+    }
+
+    public boolean readBoolean(DataInput in) {
+        return strategy.readBoolean(in);
+    }
+
+    public void writeSafeUTF(DataOutput out, String value) {
+        strategy.writeSafeUTF(out, value);
+    }
+
+    public String readSafeUTF(DataInput in) {
+        return strategy.readSafeUTF(in);
+    }
+}

src/java/org/jivesoftware/util/cache/ExternalizableUtilStrategy.java

+/**
+ * $RCSfile$
+ * $Revision: $
+ * $Date: $
+ *
+ * Copyright (C) 2007 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.cache;
+
+import java.io.DataInput;
+import java.io.DataOutput;
+import java.io.IOException;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Interface that allows to provide different ways for implementing serialization of objects.
+ * The open source version of the server will just provide a dummy implementation that does
+ * nothing. The enterprise version will use Coherence as its underlying mechanism.
+ *
+ * @author Gaston Dombiak
+ */
+public interface ExternalizableUtilStrategy {
+    
+    /**
+     * Writes a Map of String key and value pairs. This method handles the
+     * case when the Map is <tt>null</tt>.
+     *
+     * @param out       the output stream.
+     * @param stringMap the Map of String key/value pairs.
+     * @throws java.io.IOException if an error occurs.
+     */
+    public void writeStringMap(DataOutput out, Map<String, String> stringMap) throws IOException;
+
+    /**
+     * Reads a Map of String key and value pairs. This method will return
+     * <tt>null</tt> if the Map written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return a Map of String key/value pairs.
+     * @throws IOException if an error occurs.
+     */
+    public Map<String, String> readStringMap(DataInput in) throws IOException;
+
+    /**
+     * Writes a Map of Long key and Integer value pairs. This method handles
+     * the case when the Map is <tt>null</tt>.
+     *
+     * @param out the output stream.
+     * @param map the Map of Long key/Integer value pairs.
+     * @throws IOException if an error occurs.
+     */
+    public void writeLongIntMap(DataOutput out, Map<Long, Integer> map) throws IOException;
+
+    /**
+     * Reads a Map of Long key and Integer value pairs. This method will return
+     * <tt>null</tt> if the Map written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return a Map of Long key/Integer value pairs.
+     * @throws IOException if an error occurs.
+     */
+    public Map readLongIntMap(DataInput in) throws IOException;
+
+    /**
+     * Writes a List of Strings. This method handles the case when the List is
+     * <tt>null</tt>.
+     *
+     * @param out        the output stream.
+     * @param stringList the List of Strings.
+     * @throws IOException if an error occurs.
+     */
+    public void writeStringList(DataOutput out, List stringList) throws IOException;
+
+    /**
+     * Reads a List of Strings. This method will return <tt>null</tt> if the List
+     * written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return a List of Strings.
+     * @throws IOException if an error occurs.
+     */
+    public List<String> readStringList(DataInput in) throws IOException;
+
+    /**
+     * Writes an array of long values. This method handles the case when the
+     * array is <tt>null</tt>.
+     *
+     * @param out   the output stream.
+     * @param array the array of long values.
+     * @throws IOException if an error occurs.
+     */
+    public void writeLongArray(DataOutput out, long [] array) throws IOException;
+
+    /**
+     * Reads an array of long values. This method will return <tt>null</tt> if
+     * the array written to the stream was <tt>null</tt>.
+     *
+     * @param in the input stream.
+     * @return an array of long values.
+     * @throws IOException if an error occurs.
+     */
+    public long [] readLongArray(DataInput in) throws IOException;
+
+    public void writeLong(DataOutput out, long value);
+
+    public long readLong(DataInput in);
+
+    public void writeBoolean(DataOutput out, boolean value);
+
+    public boolean readBoolean(DataInput in);
+
+    public void writeSafeUTF(DataOutput out, String value);
+
+    public String readSafeUTF(DataInput in);
+}
\ No newline at end of file