You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by ad...@apache.org on 2011/07/13 07:06:00 UTC

svn commit: r1145862 - in /mina/branches/3.0/core/src: main/java/org/apache/mina/api/ main/java/org/apache/mina/filterchain/ test/java/filterchain/

Author: adc
Date: Wed Jul 13 05:06:00 2011
New Revision: 1145862

URL: http://svn.apache.org/viewvc?rev=1145862&view=rev
Log:
Cleaned up chain as discussed on the mailing list

Modified:
    mina/branches/3.0/core/src/main/java/org/apache/mina/api/IoFilter.java
    mina/branches/3.0/core/src/main/java/org/apache/mina/api/IoFilterChain.java
    mina/branches/3.0/core/src/main/java/org/apache/mina/filterchain/DefaultIoFilterChain.java
    mina/branches/3.0/core/src/test/java/filterchain/DefaultIoFilterChainTest.java

Modified: mina/branches/3.0/core/src/main/java/org/apache/mina/api/IoFilter.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/api/IoFilter.java?rev=1145862&r1=1145861&r2=1145862&view=diff
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/api/IoFilter.java (original)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/api/IoFilter.java Wed Jul 13 05:06:00 2011
@@ -27,7 +27,6 @@ package org.apache.mina.api;
  */
 public interface IoFilter {
 
-    // ---- Events Functions ---
     /**
      * Invoked from an I/O processor thread when a new connection has been created. Because this method is supposed to
      * be called from the same thread that handles I/O of multiple sessions, please implement this method to perform

Modified: mina/branches/3.0/core/src/main/java/org/apache/mina/api/IoFilterChain.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/api/IoFilterChain.java?rev=1145862&r1=1145861&r2=1145862&view=diff
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/api/IoFilterChain.java (original)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/api/IoFilterChain.java Wed Jul 13 05:06:00 2011
@@ -65,46 +65,7 @@ public interface IoFilterChain {
      *
      * @return  List of all {@link IoFilter} present in the chain
      */
-    List<IoFilter> getAll();
-
-    /**
-     * Add the specified {@link IoFilter} to the chain. The specific Filter is
-     * added at the end of the current processing chain
-     *
-     * @param ioFilter  Filter to be added in the Chain
-     */
-    void addLast(IoFilter ioFilter);
-
-    /**
-     * Add the specified {@link IoFilter} to the beginning of the chain. The filter is
-     * inserted before all the other filter currently in the chain.
-     * @param ioFilter
-     */
-    void addFirst(IoFilter ioFilter);
-
-    /**
-     * Insert the specified {@link IoFilter} before the filter at the given position
-     * @param position where we want to insert before our filter
-     * @param ioFilter the filter to be inserted
-     * @throws IndexOutOfBoundsException if the position is out of this list
-     */
-    void insertBefore(int position, IoFilter ioFilter) throws IndexOutOfBoundsException;
-
-    /**
-     * Insert the specified {@link IoFilter} after the filter at the given position
-     * @param position where we want to insert before our filter
-     * @param ioFilter the filter to be inserted
-     * @throws IndexOutOfBoundsException if the position is out of this list
-     */
-    void insertAfter(int position, IoFilter ioFilter);
-
-    /**
-     * Removes the Filter from the Chain.
-     *
-     * @param ioFilter  Filter to be removed
-     * @return <code>true</code> if successful
-     */
-    boolean removeFilter(IoFilter ioFilter);
+    List<IoFilter> getChain();
 
     /**
      * Call this method for processing a exception caught event using this chain.

Modified: mina/branches/3.0/core/src/main/java/org/apache/mina/filterchain/DefaultIoFilterChain.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/filterchain/DefaultIoFilterChain.java?rev=1145862&r1=1145861&r2=1145862&view=diff
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/filterchain/DefaultIoFilterChain.java (original)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/filterchain/DefaultIoFilterChain.java Wed Jul 13 05:06:00 2011
@@ -21,68 +21,43 @@ package org.apache.mina.filterchain;
 
 import java.util.ArrayList;
 import java.util.List;
-import java.util.concurrent.CopyOnWriteArrayList;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import org.apache.mina.api.IoFilter;
 import org.apache.mina.api.IoFilterChain;
 import org.apache.mina.api.IoSession;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 public class DefaultIoFilterChain implements IoFilterChain {
 
     private static final Logger LOG = LoggerFactory.getLogger(DefaultIoFilterChain.class);
 
     /**
-     * The list of {@link IoFilter} compounding this chain.
-     * We use a {@link CopyOnWriteArrayList} because we want to read quickly (and thread safely) but we don't care much about chain
-     * modification performances.
+     * The list of {@link IoFilter} implementing this chain.
      */
-    private List<IoFilter> chain = new CopyOnWriteArrayList<IoFilter>();
-
-    //===================
-    // CHAIN MANIPULATION
-    //===================
+    private final List<IoFilter> chain;
 
-    @Override
-    public List<IoFilter> getAll() {
-        // send a copy of the list
-        return new ArrayList<IoFilter>(chain);
-    }
-
-    @Override
-    public void addFirst(IoFilter ioFilter) {
-        chain.add(0, ioFilter);
-    }
-
-    @Override
-    public void addLast(IoFilter ioFilter) {
-        chain.add(ioFilter);
-    }
-
-    @Override
-    public boolean removeFilter(IoFilter ioFilter) {
-        return chain.remove(ioFilter);
-    }
-
-    @Override
-    public void insertBefore(int position, IoFilter ioFilter) throws IndexOutOfBoundsException {
-        chain.add(position, ioFilter);
+    /**
+     * The instance of {@link DefaultIoFilterChain} with an empty chain.
+     */
+    public DefaultIoFilterChain() {
+        this.chain = new ArrayList<IoFilter>();
     }
 
-    @Override
-    public void insertAfter(int position, IoFilter ioFilter) throws IndexOutOfBoundsException {
-        chain.add(position + 1, ioFilter);
+    /**
+     * The instance of {@link DefaultIoFilterChain} is initialized with a copy
+     * of a filter chain.
+     *
+     * @param chain the chain to be copied
+     */
+    public DefaultIoFilterChain(List<IoFilter> chain) {
+        this.chain = new ArrayList<IoFilter>(chain);
     }
 
     @Override
-    public String toString() {
-        StringBuilder bldr = new StringBuilder("IoFilterChain {");
-        int index = 0;
-        for (IoFilter filter : chain) {
-            bldr.append(index).append(":").append(filter).append(", ");
-        }
-        return bldr.append("}").toString();
+    public List<IoFilter> getChain() {
+        return chain;
     }
 
     @Override
@@ -152,4 +127,14 @@ public class DefaultIoFilterChain implem
         return message;
     }
 
+    @Override
+    public String toString() {
+        StringBuilder bldr = new StringBuilder("IoFilterChain {");
+        int index = 0;
+        for (IoFilter filter : chain) {
+            bldr.append(index).append(":").append(filter).append(", ");
+        }
+        return bldr.append("}").toString();
+    }
+
 }
\ No newline at end of file

Modified: mina/branches/3.0/core/src/test/java/filterchain/DefaultIoFilterChainTest.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/test/java/filterchain/DefaultIoFilterChainTest.java?rev=1145862&r1=1145861&r2=1145862&view=diff
==============================================================================
--- mina/branches/3.0/core/src/test/java/filterchain/DefaultIoFilterChainTest.java (original)
+++ mina/branches/3.0/core/src/test/java/filterchain/DefaultIoFilterChainTest.java Wed Jul 13 05:06:00 2011
@@ -31,68 +31,6 @@ import org.junit.Test;
 
 public class DefaultIoFilterChainTest {
 
-    @Test
-    public void testChainModification() {
-        DefaultIoFilterChain filterChain = new DefaultIoFilterChain();
-
-        DummyFilter filterA = new DummyFilter("A");
-        DummyFilter filterB = new DummyFilter("B");
-        DummyFilter filterC = new DummyFilter("C");
-
-        // add two filters
-        filterChain.addFirst(filterB);
-        filterChain.addFirst(filterA);
-        System.out.println(filterChain);
-        assertEquals(filterChain.getAll().size(), 2);
-        List<IoFilter> l = filterChain.getAll();
-
-        assertEquals(l.get(0), filterA);
-        assertEquals(l.get(1), filterB);
-
-        assertTrue(filterChain.removeFilter(filterB));
-        assertEquals(filterChain.getAll().size(), 1);
-        assertFalse(filterChain.removeFilter(filterB));
-        assertEquals(filterChain.getAll().size(), 1);
-        assertTrue(filterChain.removeFilter(filterA));
-        assertTrue(filterChain.getAll().isEmpty());
-
-        // add three filter
-        filterChain.addLast(filterB);
-        filterChain.addLast(filterC);
-        filterChain.addFirst(filterA);
-        assertEquals(filterChain.getAll().size(), 3);
-        l = filterChain.getAll();
-
-        assertEquals(l.get(0), filterA);
-        assertEquals(l.get(1), filterB);
-        assertEquals(l.get(2), filterC);
-
-        filterChain.removeFilter(filterB);
-        assertEquals(filterChain.getAll().size(), 2);
-        l = filterChain.getAll();
-        assertEquals(l.get(0), filterA);
-        assertEquals(l.get(1), filterC);
-
-        filterChain.insertAfter(0, filterB);
-        assertEquals(filterChain.getAll().size(), 3);
-        l = filterChain.getAll();
-
-        assertEquals(l.get(0), filterA);
-        assertEquals(l.get(1), filterB);
-        assertEquals(l.get(2), filterC);
-        filterChain.removeFilter(filterB);
-
-        filterChain.insertBefore(1, filterB);
-
-        assertEquals(filterChain.getAll().size(), 3);
-        l = filterChain.getAll();
-
-        assertEquals(l.get(0), filterA);
-        assertEquals(l.get(1), filterB);
-        assertEquals(l.get(2), filterC);
-
-    }
-
     private static class DummyFilter implements IoFilter {
 
         String id;