Author: jochen
Date: Mon Jan 24 23:10:00 2011
New Revision: 1063054
URL: http://svn.apache.org/viewvc?rev=1063054&view=rev
Log:
PR: XMLRPC-169
Submitted-By: Alan Burlison <[email protected]>
Documentation fixes that ought to clearly demonstrate the weaknesses of the
WebServer class.
Modified:
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/server/XmlRpcServerConfigImpl.java
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/webserver/ServletWebServer.java
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/webserver/WebServer.java
webservices/xmlrpc/trunk/src/changes/changes.xml
Modified:
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/server/XmlRpcServerConfigImpl.java
URL:
http://svn.apache.org/viewvc/webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/server/XmlRpcServerConfigImpl.java?rev=1063054&r1=1063053&r2=1063054&view=diff
==============================================================================
---
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/server/XmlRpcServerConfigImpl.java
(original)
+++
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/server/XmlRpcServerConfigImpl.java
Mon Jan 24 23:10:00 2011
@@ -28,8 +28,11 @@ public class XmlRpcServerConfigImpl exte
private boolean isKeepAliveEnabled;
private boolean isEnabledForExceptions;
- /** Sets, whether HTTP keepalive is enabled for this server.
- * @param pKeepAliveEnabled True, if keepalive is enabled. False
otherwise.
+ /** Sets, whether HTTP keepalive is enabled for this server. Note that
the
+ * {@link org.apache.xmlrpc.webserver.WebServer} and
+ * {@link org.apache.xmlrpc.webserver.ServletWebServer} classes do not
+ * implement keepalive, so this will have no effect for those classes.
+ * @param pKeepAliveEnabled True, if keepalive is enabled. False other
* @param pKeepAliveEnabled True, if keepalive is enabled. False otherwise.
*/
public void setKeepAliveEnabled(boolean pKeepAliveEnabled) {
isKeepAliveEnabled = pKeepAliveEnabled;
Modified:
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/webserver/ServletWebServer.java
URL:
http://svn.apache.org/viewvc/webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/webserver/ServletWebServer.java?rev=1063054&r1=1063053&r2=1063054&view=diff
==============================================================================
---
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/webserver/ServletWebServer.java
(original)
+++
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/webserver/ServletWebServer.java
Mon Jan 24 23:10:00 2011
@@ -36,9 +36,12 @@ import org.apache.xmlrpc.util.ThreadPool
/**
* <p>This is a subclass of the {@link WebServer}, which offers a minimal
- * servlet API. It is recommended to use this class, rather than the
- * {@link WebServer}, because it offers you a smooth migration path to
- * a full blown servlet engine.</p>
+ * servlet API. It is recommended that you use this class rather than the
+ * {@link WebServer} because it offers a smooth migration path to a full blown
+ * servlet engine.</p>
+ * <p>Note that this class has the same limitations as its parent
+ * {@link WebServer} in that it doesn't support HTTP keepalives and it doesn't
+ * support chunked mode requests.</p>
* <p>Use of the {@link ServletWebServer} goes like this: First of all,
* create a servlet. It may be an instance of {@link XmlRpcServlet} or
* a subclass thereof. Note, that servlets are stateless: One servlet
Modified:
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/webserver/WebServer.java
URL:
http://svn.apache.org/viewvc/webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/webserver/WebServer.java?rev=1063054&r1=1063053&r2=1063054&view=diff
==============================================================================
---
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/webserver/WebServer.java
(original)
+++
webservices/xmlrpc/trunk/server/src/main/java/org/apache/xmlrpc/webserver/WebServer.java
Mon Jan 24 23:10:00 2011
@@ -34,21 +34,18 @@ import org.apache.xmlrpc.util.ThreadPool
/**
- * <p>The {@link WebServer} is a minimal HTTP server, that might be used
- * as an embedded web server.</p>
- * <p>Use of the {@link WebServer} has grown very popular amongst users
- * of Apache XML-RPC. Why this is the case, can hardly be explained,
- * because the {@link WebServer} is at best a workaround, compared to
- * full blown servlet engines like Tomcat or Jetty. For example, under
- * heavy load it will almost definitely be slower than a real servlet
- * engine, because it does neither support proper keepalive (multiple
- * requests per physical connection) nor chunked mode (in other words,
- * it cannot stream requests).</p>
- * <p>If you still insist in using the {@link WebServer}, it is
- * recommended to use its subclass, the {@link ServletWebServer} instead,
- * which offers a minimal subset of the servlet API. In other words,
- * you keep yourself the option to migrate to a real servlet engine
- * later.</p>
+ * <p>The {@link WebServer} is a minimal HTTP server that can be used as an
+ * embedded web server.</p>
+ * <p>Use of the {@link WebServer} has grown very popular amongst users of
+ * Apache XML-RPC. This is despite the limitations of this class when compared
+ * to a full blown servlet engine such as Tomcat or Jetty. For example, under
+ * heavy load this class will almost definitely be slower than a real servlet
+ * engine because it doesn't support keepalive (multiple requests per physical
+ * connection) or chunked mode (it cannot stream requests).</p>
+ * <p>If you still want so use the {@link WebServer} class it is recommended
+ * you use its subclass, the {@link ServletWebServer} which offers a minimal
+ * subset of the servlet API. That will keep the open the option to migrate to
+ * a full servlet engine.</p>
* <p>Use of the {@link WebServer} goes roughly like this: First of all,
* create a property file (for example "MyHandlers.properties") and
* add it to your jar file. The property keys are handler names and
Modified: webservices/xmlrpc/trunk/src/changes/changes.xml
URL:
http://svn.apache.org/viewvc/webservices/xmlrpc/trunk/src/changes/changes.xml?rev=1063054&r1=1063053&r2=1063054&view=diff
==============================================================================
--- webservices/xmlrpc/trunk/src/changes/changes.xml (original)
+++ webservices/xmlrpc/trunk/src/changes/changes.xml Mon Jan 24 23:10:00 2011
@@ -30,6 +30,10 @@
<action dev="jochen" type="add" issue="XMLRPC-184" due-to="Antoine
Toulme" due-to-email="[email protected]">
Jar files are now created as proper OSGI packages using the
bundle-maven-plugin.
</action>
+ <action dev="jochen" type="fix" issue="XMLRPC-169" due-to="Alan
Burlison" due-to-email="[email protected]">
+ Documentation fixes that ought to clearly demonstrate the weaknesses
of the
+ WebServer class.
+ </action>
</release>
<release version="3.1.3" date="2010-Feb-06">
