svn commit: r723746 - /cocoon/cocoon3/trunk/cocoon-servlet/src/main/java/org/apache/cocoon/servlet/node/StatusCodeCollector.java

[re...@apache.org]

Author: reinhard
Date: Fri Dec  5 06:46:33 2008
New Revision: 723746

URL: http://svn.apache.org/viewvc?rev=723746&view=rev
Log:
javadocs

Modified:
    cocoon/cocoon3/trunk/cocoon-servlet/src/main/java/org/apache/cocoon/servlet/node/StatusCodeCollector.java

Modified: cocoon/cocoon3/trunk/cocoon-servlet/src/main/java/org/apache/cocoon/servlet/node/StatusCodeCollector.java
URL: http://svn.apache.org/viewvc/cocoon/cocoon3/trunk/cocoon-servlet/src/main/java/org/apache/cocoon/servlet/node/StatusCodeCollector.java?rev=723746&r1=723745&r2=723746&view=diff
==============================================================================
--- cocoon/cocoon3/trunk/cocoon-servlet/src/main/java/org/apache/cocoon/servlet/node/StatusCodeCollector.java (original)
+++ cocoon/cocoon3/trunk/cocoon-servlet/src/main/java/org/apache/cocoon/servlet/node/StatusCodeCollector.java Fri Dec  5 06:46:33 2008
@@ -20,13 +20,23 @@
 
 import javax.servlet.http.HttpServletResponse;
 
+import org.apache.cocoon.servlet.XMLSitemapServlet;
 import org.apache.cocoon.sitemap.Invocation;
 import org.apache.cocoon.sitemap.node.InvocationResult;
 import org.apache.cocoon.sitemap.node.SerializeNode;
+import org.apache.cocoon.sitemap.node.Sitemap;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
 
+/**
+ * This {@link Aspect} is used to collect the status-code property from a {@link SerializeNode} because the sitemap
+ * interpreter doesn't have any dependencies on the Servlet API and doesn't 'know' about the concepts of HTTP.
+ * 
+ * A servlet that uses the the {@link Sitemap} (e.g. the {@link XMLSitemapServlet}) can use this collector to read the
+ * status code and set it on the servlet response object. The collector can also be used to directly manipulate the
+ * status code of the current thread by using the {@link #setStatusCode(int)} method.
+ */
 @Aspect
 public class StatusCodeCollector {