Author: norman Date: Wed Jan 11 14:04:02 2012 New Revision: 1230047 URL: http://svn.apache.org/viewvc?rev=1230047&view=rev Log: Cleanup and javadocs
Modified: james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolConfiguration.java james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolConfigurationImpl.java james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolServer.java james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/future/FutureStartTlsResponse.java james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/future/FutureStreamResponseImpl.java james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/LifecycleAwareProtocolHandler.java james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerResultHandler.java james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/UnknownCommandHandler.java james/protocols/trunk/netty/src/main/java/org/apache/james/protocols/netty/HandlerConstants.java Modified: james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolConfiguration.java URL: http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolConfiguration.java?rev=1230047&r1=1230046&r2=1230047&view=diff ============================================================================== --- james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolConfiguration.java (original) +++ james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolConfiguration.java Wed Jan 11 14:04:02 2012 @@ -19,6 +19,11 @@ package org.apache.james.protocols.api; +/** + * Configuration which is used in scope of a Protocol + * + * + */ public interface ProtocolConfiguration { Modified: james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolConfigurationImpl.java URL: http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolConfigurationImpl.java?rev=1230047&r1=1230046&r2=1230047&view=diff ============================================================================== --- james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolConfigurationImpl.java (original) +++ james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolConfigurationImpl.java Wed Jan 11 14:04:02 2012 @@ -20,7 +20,15 @@ package org.apache.james.protocols.api; +/** + * Default implementation of a {@link ProtocolConfiguration} which allows to easily set the different configurations. + * + * Be aware that set and get operations are not thread-safe + * + * + */ public class ProtocolConfigurationImpl implements ProtocolConfiguration { + private String greeting; private String softwareName = "JAMES Protocols Server"; private String helloName = "localhost"; Modified: james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolServer.java URL: http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolServer.java?rev=1230047&r1=1230046&r2=1230047&view=diff ============================================================================== --- james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolServer.java (original) +++ james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolServer.java Wed Jan 11 14:04:02 2012 @@ -21,6 +21,10 @@ package org.apache.james.protocols.api; import java.net.InetSocketAddress; import java.util.List; +/** + * A {@link ProtocolServer} accept inbound traffic and handle it. Basically the protocols API can be used to handle every "line based" protocol in an easy fashion + * + */ public interface ProtocolServer { /** Modified: james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/future/FutureStartTlsResponse.java URL: http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/future/FutureStartTlsResponse.java?rev=1230047&r1=1230046&r2=1230047&view=diff ============================================================================== --- james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/future/FutureStartTlsResponse.java (original) +++ james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/future/FutureStartTlsResponse.java Wed Jan 11 14:04:02 2012 @@ -22,6 +22,11 @@ package org.apache.james.protocols.api.f import org.apache.james.protocols.api.Response; import org.apache.james.protocols.api.StartTlsResponse; +/** + * Special {@link FutureResponse} which will get notified once a {@link StartTlsResponse} is ready + * + * + */ public class FutureStartTlsResponse extends FutureResponseImpl implements StartTlsResponse{ Modified: james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/future/FutureStreamResponseImpl.java URL: http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/future/FutureStreamResponseImpl.java?rev=1230047&r1=1230046&r2=1230047&view=diff ============================================================================== --- james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/future/FutureStreamResponseImpl.java (original) +++ james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/future/FutureStreamResponseImpl.java Wed Jan 11 14:04:02 2012 @@ -24,6 +24,11 @@ import java.io.InputStream; import org.apache.james.protocols.api.Response; import org.apache.james.protocols.api.StreamResponse; +/** + * Special {@link FutureResponse} which wraps a {@link StreamResponse} and so provide an async way to get notified about ready responses + * + * + */ public class FutureStreamResponseImpl extends FutureResponseImpl implements StreamResponse{ /** Modified: james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/LifecycleAwareProtocolHandler.java URL: http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/LifecycleAwareProtocolHandler.java?rev=1230047&r1=1230046&r2=1230047&view=diff ============================================================================== --- james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/LifecycleAwareProtocolHandler.java (original) +++ james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/LifecycleAwareProtocolHandler.java Wed Jan 11 14:04:02 2012 @@ -28,7 +28,7 @@ public interface LifecycleAwareProtocolH /** * Destroy object */ - public void destroy(); + void destroy(); } Modified: james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerResultHandler.java URL: http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerResultHandler.java?rev=1230047&r1=1230046&r2=1230047&view=diff ============================================================================== --- james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerResultHandler.java (original) +++ james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerResultHandler.java Wed Jan 11 14:04:02 2012 @@ -22,6 +22,15 @@ package org.apache.james.protocols.api.h import org.apache.james.protocols.api.ProtocolSession; import org.apache.james.protocols.api.Response; +/** + * An special {@link ProtocolHandler} which allows to <strong>intercept</code> returned {@link Response}'s and act on them. + * + * This could be to gather statistics or even replace them. + * @author Maurer + * + * @param <R> + * @param <S> + */ public interface ProtocolHandlerResultHandler<R extends Response, S extends ProtocolSession> extends ProtocolHandler{ /** Modified: james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/UnknownCommandHandler.java URL: http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/UnknownCommandHandler.java?rev=1230047&r1=1230046&r2=1230047&view=diff ============================================================================== --- james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/UnknownCommandHandler.java (original) +++ james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/handler/UnknownCommandHandler.java Wed Jan 11 14:04:02 2012 @@ -24,6 +24,13 @@ import java.util.Collections; import org.apache.james.protocols.api.ProtocolSession; +/** + * A special {@link CommandHandler} implementation which should be extended by {@link CommandHandler}'s which should get called for unknown command. So this is some kind + * of a <strong>fallback</strong> {@link CommandHandler} which will get executed if no other matching {@link CommandHandler} could be found for a given command. + * + * + * @param <S> + */ public abstract class UnknownCommandHandler<S extends ProtocolSession> implements CommandHandler<S>{ /** Modified: james/protocols/trunk/netty/src/main/java/org/apache/james/protocols/netty/HandlerConstants.java URL: http://svn.apache.org/viewvc/james/protocols/trunk/netty/src/main/java/org/apache/james/protocols/netty/HandlerConstants.java?rev=1230047&r1=1230046&r2=1230047&view=diff ============================================================================== --- james/protocols/trunk/netty/src/main/java/org/apache/james/protocols/netty/HandlerConstants.java (original) +++ james/protocols/trunk/netty/src/main/java/org/apache/james/protocols/netty/HandlerConstants.java Wed Jan 11 14:04:02 2012 @@ -22,29 +22,29 @@ import org.jboss.netty.channel.ChannelHa import org.jboss.netty.channel.ChannelPipeline; /** - * Provide the keys under which the {@link ChannelHandler}'s are stored in the {@link ChannelPipeline} + * Provide the keys under which the {@link ChannelHandler}'s are stored in the + * {@link ChannelPipeline} + * * - * */ public interface HandlerConstants { - public static final String SSL_HANDLER = "sslHandler"; - - public static final String GROUP_HANDLER ="groupHandler"; - - public static final String CONNECTION_LIMIT_HANDLER =" connectionLimit"; - - public static final String CONNECTION_PER_IP_LIMIT_HANDLER ="connectionPerIpLimit"; - - public static final String FRAMER = "framer"; - - public static final String EXECUTION_HANDLER = "executionHandler"; - - public static final String TIMEOUT_HANDLER = "timeoutHandler"; - - public static final String CORE_HANDLER = "coreHandler"; + public static final String SSL_HANDLER = "sslHandler"; + + public static final String GROUP_HANDLER = "groupHandler"; + + public static final String CONNECTION_LIMIT_HANDLER = " connectionLimit"; + + public static final String CONNECTION_PER_IP_LIMIT_HANDLER = "connectionPerIpLimit"; + + public static final String FRAMER = "framer"; + + public static final String EXECUTION_HANDLER = "executionHandler"; + + public static final String TIMEOUT_HANDLER = "timeoutHandler"; - public static final String CHUNK_HANDLER = "chunkHandler"; + public static final String CORE_HANDLER = "coreHandler"; + public static final String CHUNK_HANDLER = "chunkHandler"; } --------------------------------------------------------------------- To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org