You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by ni...@apache.org on 2006/01/22 13:24:30 UTC

svn commit: r371276 - in /directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring: Binding.java IoAddressEditor.java IoFilterMapping.java

Author: niklas
Date: Sun Jan 22 04:24:23 2006
New Revision: 371276

URL: http://svn.apache.org/viewcvs?rev=371276&view=rev
Log:
Added/Changed Javadoc

Modified:
    directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/Binding.java
    directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/IoAddressEditor.java
    directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/IoFilterMapping.java

Modified: directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/Binding.java
URL: http://svn.apache.org/viewcvs/directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/Binding.java?rev=371276&r1=371275&r2=371276&view=diff
==============================================================================
--- directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/Binding.java (original)
+++ directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/Binding.java Sun Jan 22 04:24:23 2006
@@ -40,6 +40,72 @@
  * (e.g. using an {@link org.apache.mina.filter.SSLFilter} when connecting on port
  * 443 but not on port 80). 
  * </p>
+ * <p>
+ * Example of usage:
+ * 
+ * <pre>
+ *   &lt;!-- POP3 server IoHandler implementation--&gt;
+ *   &lt;bean id=&quot;pop3Handler&quot; class=&quot;com.foo.bar.MyPop3Handler&quot;&gt;
+ *       ...
+ *   &lt;/bean&gt;
+ *   
+ *   &lt;!-- Telnet based admin console handler. Should only be accessible from localhost --&gt;
+ *   &lt;bean id=&quot;adminHandler&quot; class=&quot;com.foo.bar.MyAdminHandler&quot;&gt;
+ *       ...
+ *   &lt;/bean&gt;
+ *   
+ *   &lt;!-- Create a thread pool filter. The threads will be shared among all the bindings --&gt;
+ *   &lt;bean id=&quot;threadPoolFilter&quot; class=&quot;org.apache.mina.filter.ThreadPoolFilter&quot;&gt;
+ *     &lt;!-- Threads will be named IoWorker-1, IoWorker-2, etc --&gt;
+ *     &lt;constructor-arg value=&quot;IoWorker&quot;/&gt;
+ *     &lt;property name=&quot;maximumPoolSize&quot; value=&quot;10&quot;/&gt;
+ *   &lt;/bean&gt;
+ *   
+ *   &lt;!-- Create an SSL filter to be used for POP3 over SSL --&gt;
+ *   &lt;bean id=&quot;sslFilter&quot; class=&quot;org.apache.mina.filter.SSLFilter&quot;&gt;
+ *         ...
+ *   &lt;/bean&gt;
+ *   
+ *   &lt;!-- Finally, let's set up the bindings --&gt;
+ *   
+ *   &lt;bean id=&quot;sslBinding&quot; class=&quot;org.apache.mina.integration.spring.Binding&quot;&gt;
+ *     &lt;!-- Bind to port 995 on all interfaces using the NIO provider 
+ *             and the socket transport type --&gt;
+ *     &lt;property name=&quot;address&quot; value=&quot;nio:socket:*:995&quot;/&gt;
+ *     &lt;property name=&quot;handler&quot; ref=&quot;pop3Handler&quot;/&gt;
+ *     &lt;property name=&quot;filters&quot;&gt;
+ *       &lt;list&gt;
+ *         &lt;ref local=&quot;threadPoolFilter&quot;/&gt;
+ *         &lt;ref local=&quot;sslFilter&quot;/&gt;
+ *       &lt;/list&gt;
+ *     &lt;/property&gt;
+ *   &lt;/bean&gt;
+ *   
+ *   &lt;bean id=&quot;nonSslBinding&quot; class=&quot;org.apache.mina.integration.spring.Binding&quot;&gt;
+ *     &lt;!-- Bind to port 110 on all interfaces using the NIO provider 
+ *             and the socket transport type --&gt;
+ *     &lt;property name=&quot;address&quot; value=&quot;nio:socket:*:110&quot;/&gt;
+ *     &lt;property name=&quot;handler&quot; ref=&quot;pop3Handler&quot;/&gt;
+ *     &lt;property name=&quot;filters&quot;&gt;
+ *       &lt;list&gt;
+ *         &lt;ref local=&quot;threadPoolFilter&quot;/&gt;
+ *       &lt;/list&gt;
+ *     &lt;/property&gt;
+ *   &lt;/bean&gt;
+ *   
+ *   &lt;bean id=&quot;adminBinding&quot; class=&quot;org.apache.mina.integration.spring.Binding&quot;&gt;
+ *     &lt;!-- Bind to port 60987 on the loopback interface using the NIO 
+ *             provider and the socket transport type --&gt;
+ *     &lt;property name=&quot;address&quot; value=&quot;nio:socket:127.0.0.1:60987&quot;/&gt;
+ *     &lt;property name=&quot;handler&quot; ref=&quot;adminHandler&quot;/&gt;
+ *     &lt;property name=&quot;filters&quot;&gt;
+ *       &lt;list&gt;
+ *         &lt;ref local=&quot;threadPoolFilter&quot;/&gt;
+ *       &lt;/list&gt;
+ *     &lt;/property&gt;
+ *   &lt;/bean&gt;
+ * </pre>
+ * </p>
  *
  * @author The Apache Directory Project (dev@directory.apache.org)
  * @version $Rev$, $Date$

Modified: directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/IoAddressEditor.java
URL: http://svn.apache.org/viewcvs/directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/IoAddressEditor.java?rev=371276&r1=371275&r2=371276&view=diff
==============================================================================
--- directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/IoAddressEditor.java (original)
+++ directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/IoAddressEditor.java Sun Jan 22 04:24:23 2006
@@ -26,8 +26,9 @@
  * Java Bean PropertyEditor which converts Strings into {@link IoAddress} objects.
  * This may be used together with Spring to be able to set IoAddress bean
  * properties
- * 
+ * <p>
  * Simply calls {@link IoAddress#IoAddress(String)} when converting from a String.
+ * </p>
  * <p>
  * Use Spring's CustomEditorConfigurer to use this property editor in a Spring
  * context. See chapter 3.14 of the Spring Reference Documentation for more

Modified: directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/IoFilterMapping.java
URL: http://svn.apache.org/viewcvs/directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/IoFilterMapping.java?rev=371276&r1=371275&r2=371276&view=diff
==============================================================================
--- directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/IoFilterMapping.java (original)
+++ directory/sandbox/trustin/mina-spi/spring/src/main/java/org/apache/mina/integration/spring/IoFilterMapping.java Sun Jan 22 04:24:23 2006
@@ -28,13 +28,7 @@
  * <p> 
  * Use this class when you want to configure the
  * filters added to the filter chain of all sessions created from a particular
- * {@link Binding}.
- * </p>
- * <p>
- * This class can also be used when creating {@link Binding} objects. This lets
- * one configure per-port filters. These filters will only be added to the
- * filter chain of sessions for incoming connections on the port specified by
- * the {@link Binding}. Note that {@link Binding} can also be configured to 
+ * {@link Binding}. Note that {@link Binding} can also be configured to 
  * generate filter names automatically. In that case you add the {@link IoFilter}
  * instances directly to the {@link Binding}.
  * </p>