[Yanel-commits] rev 48786 - public/yanel/trunk/src/webapp/src/java/org/wyona/yanel/servlet

[michi at wyona.com]

Author: michi
Date: 2010-04-14 14:29:05 +0200 (Wed, 14 Apr 2010)
New Revision: 48786

Modified:
   public/yanel/trunk/src/webapp/src/java/org/wyona/yanel/servlet/YanelServlet.java
Log:
javadoc added

Modified: public/yanel/trunk/src/webapp/src/java/org/wyona/yanel/servlet/YanelServlet.java
===================================================================
--- public/yanel/trunk/src/webapp/src/java/org/wyona/yanel/servlet/YanelServlet.java	2010-04-14 12:26:54 UTC (rev 48785)
+++ public/yanel/trunk/src/webapp/src/java/org/wyona/yanel/servlet/YanelServlet.java	2010-04-14 12:29:05 UTC (rev 48786)
@@ -1684,11 +1684,17 @@
         return realm;
     }
 
+    /**
+     * Generate response using a resource configuration
+     * @param rc Resource configuration
+     */
     private boolean generateResponseFromRTview(HttpServletRequest request, HttpServletResponse response, ResourceConfiguration rc, String path) throws ServletException {
         String viewId = request.getParameter(VIEW_ID_PARAM_NAME);
+
         if (request.getParameter("yanel.format") != null) { // backwards compatible
             viewId = request.getParameter("yanel.format");
         }
+
         try {
             Realm realm = getRealm(request);
             Resource resource = yanelInstance.getResourceManager().getResource(getEnvironment(request, response), realm, path, rc);
@@ -1711,8 +1717,8 @@
         java.util.Map<String, String> properties = new HashMap<String, String>();
 
         final String pathPrefix = "/" + reservedPrefix + "/";
-        final String aboutPagePath = pathPrefix + "about.html"; // About Yanel
-        final String aboutRealmPagePath = pathPrefix + "about-realm.html"; // About realm
+        final String ABOUT_PAGE_PATH = pathPrefix + "about.html"; // About Yanel
+        final String ABOUT_REALM_PAGE_PATH = pathPrefix + "about-realm.html"; // About realm
         final String resourceTypesPathPrefix = pathPrefix + "resource-types/";
 
         //XXX REFACTORME: in the cases where we simply use a resource-type's view
@@ -1728,18 +1734,19 @@
         } catch (Exception e) {
             throw new ServletException(e.getMessage(), e);
         }
+
         if (rc != null) {
             if (generateResponseFromRTview(request, response, rc, path)) return;
             response.setStatus(javax.servlet.http.HttpServletResponse.SC_NOT_FOUND);
             return;
-        } else if (path.equals(aboutPagePath)) {
+        } else if (path.equals(ABOUT_PAGE_PATH)) {
             //XXX REFACTORME: we should define an "about" resource-type instead!
             response.setStatus(javax.servlet.http.HttpServletResponse.SC_OK);
             response.setHeader("Content-Type", "text/html");
             PrintWriter w = response.getWriter();
             w.print(About.toHTML(yanelInstance.getVersion(), yanelInstance.getRevision()));
             return;
-        } else if (path.equals(aboutRealmPagePath)) {
+        } else if (path.equals(ABOUT_REALM_PAGE_PATH)) {
             //XXX REFACTORME: we should define an "about-realm" resource-type instead!
             response.setStatus(javax.servlet.http.HttpServletResponse.SC_OK);
             response.setHeader("Content-Type", "text/html");
@@ -1840,7 +1847,10 @@
             }
         }
     }
-    
+ 
+    /**
+     * Set expire date within HTTP header
+     */
     private void setExpiresHeader(HttpServletResponse response, int hours) {
         Calendar calendar = Calendar.getInstance();
         calendar.add(Calendar.HOUR_OF_DAY, hours);