cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gkossakow...@apache.org
Subject svn commit: r544906 - /cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/
Date Wed, 06 Jun 2007 18:08:20 GMT
Author: gkossakowski
Date: Wed Jun  6 11:08:16 2007
New Revision: 544906

URL: http://svn.apache.org/viewvc?view=rev&rev=544906
Log:
COCOON-2050: Adding some documentation for servlet service components.

Modified:
    cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceConsumerSource.java
    cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceConsumerSourceFactory.java
    cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceGenerator.java
    cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceSerializer.java
    cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceTransformer.java

Modified: cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceConsumerSource.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceConsumerSource.java?view=diff&rev=544906&r1=544905&r2=544906
==============================================================================
--- cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceConsumerSource.java
(original)
+++ cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceConsumerSource.java
Wed Jun  6 11:08:16 2007
@@ -26,6 +26,11 @@
 import org.apache.excalibur.source.SourceException;
 import org.apache.excalibur.source.impl.AbstractSource;
 
+/**
+ * The <code>ServletServiceConsumerSource</code> makes available the data that
has been passed to a sitemap service.
+ * In a sitemap the source should be referenced with <code>service-consumer:</code>
syntax.<br>
+ * FIXME: Provide a link to the documents discussing servlet (and sitemap) services.
+ */
 public class ServletServiceConsumerSource extends AbstractSource {
 	
 	private Log logger = LogFactory.getLog(getClass());
@@ -36,7 +41,7 @@
 		try {
 			requestBody = request.getInputStream();
 		} catch (Exception e) {
-			logger.error("Error during obtaning request's body (POST data)", e);
+			logger.error("Error during obtaining request's body (POST data)", e);
 		}
 	}
 

Modified: cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceConsumerSourceFactory.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceConsumerSourceFactory.java?view=diff&rev=544906&r1=544905&r2=544906
==============================================================================
--- cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceConsumerSourceFactory.java
(original)
+++ cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceConsumerSourceFactory.java
Wed Jun  6 11:08:16 2007
@@ -26,6 +26,10 @@
 import org.apache.excalibur.source.Source;
 import org.apache.excalibur.source.SourceFactory;
 
+/**
+ * A factory for <code>service-consumer:</code> source.
+ * @see ServletServiceConsumerSource
+ */
 public class ServletServiceConsumerSourceFactory implements SourceFactory {
 	
 	private ProcessInfoProvider processInfoProvider;

Modified: cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceGenerator.java?view=diff&rev=544906&r1=544905&r2=544906
==============================================================================
--- cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceGenerator.java
(original)
+++ cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceGenerator.java
Wed Jun  6 11:08:16 2007
@@ -36,8 +36,15 @@
 import org.xml.sax.SAXException;
 
 /**
+ * @cocoon.sitemap.component.documentation
+ * The <code>ServletServiceGenerator</code> POSTs its input data to a called
service and passes the XML data returned
+ * by the service down the pipeline.
+ * @cocoon.sitemap.component.name servletService
  * 
- *
+ * <p>The generator takes only <code>service</code> parameter that should
contain the URL of the called service.<br>
+ * Use <code>servlet:</code> source for that purpose.</p>
+ * 
+ * FIXME: Provide a link to the documents discussing servlet (and sitemap) services. 
  */
 public class ServletServiceGenerator extends AbstractGenerator {
 	

Modified: cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceSerializer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceSerializer.java?view=diff&rev=544906&r1=544905&r2=544906
==============================================================================
--- cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceSerializer.java
(original)
+++ cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceSerializer.java
Wed Jun  6 11:08:16 2007
@@ -39,6 +39,17 @@
 import org.apache.excalibur.source.SourceException;
 import org.xml.sax.SAXException;
 
+/**
+ * @cocoon.sitemap.component.documentation
+ * The <code>ServletServiceSerializer</code> POSTs its input data to a called
service. Result of the serialization is a data returned
+ * by the called service.
+ * @cocoon.sitemap.component.name servletService
+ * 
+ * <p>The serializer takes only <code>service</code> parameter that should
contain the URL of the called service.<br>
+ * Use <code>servlet:</code> source for that purpose.</p>
+ * 
+ * FIXME: Provide a link to the documents discussing servlet (and sitemap) services. 
+ */
 public class ServletServiceSerializer extends AbstractSerializer implements SitemapModelComponent
{
 
 	private Log logger = LogFactory.getLog(getClass());

Modified: cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceTransformer.java?view=diff&rev=544906&r1=544905&r2=544906
==============================================================================
--- cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceTransformer.java
(original)
+++ cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/postable/components/ServletServiceTransformer.java
Wed Jun  6 11:08:16 2007
@@ -33,6 +33,17 @@
 import org.apache.excalibur.source.SourceException;
 import org.xml.sax.SAXException;
 
+/**
+ * @cocoon.sitemap.component.documentation
+ * The <code>ServletServiceTransformer</code> POSTs its input data to a called
service and passes the XML data returned
+ * by the service down the pipeline.
+ * @cocoon.sitemap.component.name servletService
+ * 
+ * <p>The generator takes only <code>service</code> parameter that should
contain the URL of the called service.<br>
+ * Use <code>servlet:</code> source for that purpose.</p>
+ * 
+ * FIXME: Provide a link to the documents discussing servlet (and sitemap) services. 
+ */
 public class ServletServiceTransformer extends AbstractSAXTransformer implements DisposableSitemapComponent
{
 	private Log logger = LogFactory.getLog(getClass());
 	



Mime
View raw message