Various minor formatting and documentation.

git-svn-id: https://svn.libreccm.org/ccm/trunk@2007 8810af33-2d31-482b-a856-94f89814c4df

ccm-cms/src/com/arsdigita/cms/CMSConfig.java

@@ -120,7 +120,7 @@ public final class CMSConfig extends AbstractConfig {
             "/default/folder.jsp");
     /**
      * Path or the root folter for template folders. Path is relative to webapp
-     * root.
+     * root. Modify with care! Usually modified by developers only!
      */
     private final Parameter m_templateRootPath =
                             new StringParameter(

ccm-core/src/com/arsdigita/bebop/BebopConfig.java

@@ -23,12 +23,12 @@ import com.arsdigita.bebop.util.BebopConstants;
 import com.arsdigita.runtime.AbstractConfig;
 import com.arsdigita.templating.PresentationManager;
 import com.arsdigita.ui.SimplePage;
+import com.arsdigita.util.parameter.BooleanParameter;
 import com.arsdigita.util.parameter.ClassParameter;
 import com.arsdigita.util.parameter.EnumerationParameter;
 import com.arsdigita.util.parameter.Parameter;
 import com.arsdigita.util.parameter.SingletonParameter;
 import com.arsdigita.util.parameter.StringParameter;
-import com.arsdigita.util.parameter.BooleanParameter;
 import org.apache.log4j.Logger;
 
 /**

ccm-core/src/com/arsdigita/bebop/page/PageTransformer.java

@@ -19,14 +19,17 @@
 
 package com.arsdigita.bebop.page;
 
+import com.arsdigita.bebop.Bebop;
 import com.arsdigita.developersupport.DeveloperSupport;
 import com.arsdigita.dispatcher.DispatcherHelper;
 import com.arsdigita.globalization.Globalization;
+import com.arsdigita.globalization.GlobalizationHelper;
 import com.arsdigita.kernel.Kernel;
 import com.arsdigita.profiler.Profiler;
-import com.arsdigita.templating.Templating;
-import com.arsdigita.templating.XSLTemplate;
 import com.arsdigita.templating.PresentationManager;
+import com.arsdigita.templating.Templating;
+import com.arsdigita.templating.XSLParameterGenerator;
+import com.arsdigita.templating.XSLTemplate;
 import com.arsdigita.util.Assert;
 import com.arsdigita.util.UncheckedWrapperException;
 import com.arsdigita.web.CachePolicy;
@@ -34,34 +37,27 @@ import com.arsdigita.web.Debugger;
 import com.arsdigita.web.TransformationDebugger;
 import com.arsdigita.web.Web;
 import com.arsdigita.xml.Document;
-import com.arsdigita.bebop.Bebop;
 
-import com.arsdigita.globalization.GlobalizationHelper;
 import java.io.IOException;
 import java.io.OutputStream;
 import java.io.OutputStreamWriter;
 import java.io.PrintWriter;
-
-
 import java.text.SimpleDateFormat;
-
-import java.util.Date;
-import java.util.Iterator;
-import java.util.Map;
-import java.util.HashMap;
 import java.util.Collection;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Locale;
+import java.util.Map;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import javax.servlet.jsp.PageContext;
-
 import javax.xml.transform.Transformer;
 import javax.xml.transform.TransformerException;
 import javax.xml.transform.dom.DOMSource;
 import javax.xml.transform.stream.StreamResult;
-import com.arsdigita.templating.XSLParameterGenerator;
 
-import java.util.Locale;
 import org.apache.log4j.Logger;
 
 /**
@@ -322,9 +318,11 @@ public class PageTransformer implements PresentationManager {
 
                 // Get the stylesheet transformer object corresponding to the
                 // current request.
-                final XSLTemplate template = Templating.getTemplate(req,
+                final XSLTemplate template = Templating.getTemplate(
-                                                                    fancyErrors, !Boolean.TRUE.
+                        req,
-                        equals(req.getAttribute(CACHE_XSL_NONE)));
+                        fancyErrors, 
+                        !Boolean.TRUE.equals(req.getAttribute(CACHE_XSL_NONE))
+                                                                    );
 
                 DeveloperSupport.endStage("PresMgr get stylesheet");
 

ccm-core/src/com/arsdigita/dispatcher/DispatcherConfig.java

@@ -19,9 +19,9 @@
 package com.arsdigita.dispatcher;
 
 import com.arsdigita.runtime.AbstractConfig;
+import com.arsdigita.util.parameter.BooleanParameter;
 import com.arsdigita.util.parameter.IntegerParameter;
 import com.arsdigita.util.parameter.Parameter;
-import com.arsdigita.util.parameter.BooleanParameter;
 import com.arsdigita.util.parameter.StringParameter;
 import org.apache.log4j.Logger;
 
@@ -33,9 +33,9 @@ public final class DispatcherConfig extends AbstractConfig {
 
     private static final Logger s_log = Logger.getLogger(DispatcherConfig.class);
 
-    private final Parameter m_staticURLPrefix;
     private final Parameter m_cachingActive;
     private final Parameter m_defaultExpiry;
+    private final Parameter m_staticURLPrefix;
 
     /** Default top-level container for all Bebop components and containersPage
      *  to use for dispatching Bebop pages. A custom installation may provide 
@@ -48,10 +48,6 @@ public final class DispatcherConfig extends AbstractConfig {
                             "com.arsdigita.bebop.Page");
 
     public DispatcherConfig() {
-        m_staticURLPrefix = new StringParameter
-            ("waf.dispatcher.static_url_prefix", Parameter.REQUIRED,
-             "/STATICII/");
-
         m_cachingActive = new BooleanParameter
             ("waf.dispatcher.is_caching_active", 
              Parameter.REQUIRED, Boolean.TRUE);
@@ -61,6 +57,10 @@ public final class DispatcherConfig extends AbstractConfig {
             ("waf.dispatcher.default_expiry", Parameter.REQUIRED,
              new Integer(259200));
 
+        m_staticURLPrefix = new StringParameter
+            ("waf.dispatcher.static_url_prefix", Parameter.REQUIRED,
+             "/STATICII/");
+
         register(m_staticURLPrefix);
         register(m_cachingActive);
         register(m_defaultExpiry);

ccm-core/src/com/arsdigita/kernel/KernelConfig.java

@@ -56,10 +56,10 @@ public final class KernelConfig extends AbstractConfig {
         return s_conf;
     }
 
-    /**  */
+    /**  TODO: should be renamed waf.kernel.debug"                           */
     private static Parameter m_debug = new BooleanParameter
             ("waf.debug", Parameter.REQUIRED, Boolean.FALSE);
-    /** Whether WEB development support should be activated (true) or not.   */
+    /** Whether WEB development support should be activated (true) or not. */
     // Handled in OLD initializer c.ad.webdevsupport.LegacyInitializer
     private static Parameter m_webdevSupport = new BooleanParameter
             ("waf.webdev_support", Parameter.REQUIRED, Boolean.FALSE);
@@ -70,10 +70,21 @@ public final class KernelConfig extends AbstractConfig {
     private final EnumerationParameter m_identifier = new EnumerationParameter
             ("waf.kernel.primary_user_identifier", Parameter.REQUIRED,
              "email");
-    private final Parameter m_SSO;
+    /** 
-    private final Parameter m_remember;
+     *                                                                        */
+    private final Parameter m_SSO = new BooleanParameter
+            ("waf.kernel.sso_login", Parameter.REQUIRED, Boolean.FALSE);
+
+    /** 
+     *                                                                        */
+    private final Parameter m_remember = new BooleanParameter
+            ("waf.kernel.remember_login", Parameter.REQUIRED, Boolean.TRUE);
+
+    /** 
+     *                                                                        */
     private final Parameter m_secureLogin = new BooleanParameter
         	("waf.kernel.secure_login", Parameter.REQUIRED, Boolean.FALSE);
+
     /** String containing the supported languages.
         The first one is considered default.                                 */
     private final Parameter m_supportedLanguages = new StringParameter
@@ -85,18 +96,15 @@ public final class KernelConfig extends AbstractConfig {
             ("waf.kernel.language_independent_code", Parameter.OPTIONAL,
              "--");
 
+    /**
+     * Constructor
+     */
     public KernelConfig() {
 
         // Add recognised Login user identification to enumeration parameter
         m_identifier.put("email", "email");
         m_identifier.put("screen_name", "screenName");
   
-        m_SSO = new BooleanParameter
-            ("waf.kernel.sso_login", Parameter.REQUIRED, Boolean.FALSE); 
-
-        m_remember = new BooleanParameter
-            ("waf.kernel.remember_login", Parameter.REQUIRED, Boolean.TRUE);
-
 
         register(m_debug);
         register(m_webdevSupport);

ccm-core/src/com/arsdigita/ui/UIConfig.java

@@ -21,9 +21,9 @@ package com.arsdigita.ui;
 
 import com.arsdigita.runtime.AbstractConfig;
 import com.arsdigita.util.StringUtils;
-import com.arsdigita.util.parameter.StringParameter;
-import com.arsdigita.util.parameter.StringArrayParameter;
 import com.arsdigita.util.parameter.Parameter;
+import com.arsdigita.util.parameter.StringArrayParameter;
+import com.arsdigita.util.parameter.StringParameter;
 
 import java.util.Arrays;
 import java.util.ArrayList;

ccm-core/src/com/arsdigita/web/WebConfig.java

@@ -202,7 +202,8 @@ public final class WebConfig extends AbstractConfig {
      * the <code>com.arsdigita.web.cache_policy</code> system property
      * using one fo the following values: <code>user</code> for
      * per-user caching, <code>world</code> for globally enabled
-     * caching, and <code>disable</code> to always prevent caching.
+     * caching, <code>disable</code> to prevent HTTP header caching, and
+     * <code>none</code>to always prevent caching in any case.
      */
     public final CachePolicy getCachePolicy() {
         return (CachePolicy) get(m_policy);

ccm-forum/src/com/arsdigita/forum/ForumConfig.java

@@ -21,18 +21,15 @@ package com.arsdigita.forum;
 import com.arsdigita.kernel.User;
 import com.arsdigita.kernel.UserCollection;
 import com.arsdigita.runtime.AbstractConfig;
-// import com.arsdigita.util.UncheckedWrapperException;
 import com.arsdigita.util.parameter.BooleanParameter;
 import com.arsdigita.util.parameter.IntegerParameter;
 import com.arsdigita.util.parameter.Parameter;
-import com.arsdigita.util.parameter.StringParameter;
 import com.arsdigita.util.parameter.ResourceParameter;
+import com.arsdigita.util.parameter.StringParameter;
 import com.arsdigita.web.Web;
 
 import java.io.IOException;
 import java.io.InputStream;
-// import java.net.MalformedURLException;
-// import java.net.URL;
 
 import org.apache.log4j.Logger;
 

ccm-ldn-aplaws/src/com/arsdigita/aplaws/Initializer.java

@@ -19,12 +19,10 @@
 package com.arsdigita.aplaws;
 
 import com.arsdigita.categorization.Categorization;
+import com.arsdigita.london.terms.TermCategoryListener;
 import com.arsdigita.runtime.CompoundInitializer;
 import com.arsdigita.runtime.DomainInitEvent;
 import com.arsdigita.templating.PatternStylesheetResolver;
-
-import com.arsdigita.london.terms.TermCategoryListener;
-
 import org.apache.log4j.Logger;
 
 

ccm-ldn-aplaws/src/com/arsdigita/aplaws/Loader.java

@@ -23,10 +23,10 @@ import com.arsdigita.categorization.RootCategoryCollection;
 import com.arsdigita.cms.ContentSection;
 import com.arsdigita.cms.SecurityManager;
 import com.arsdigita.cms.ui.role.RoleFactory;
-import com.arsdigita.loader.PackageLoader;
 import com.arsdigita.kernel.Role;
 import com.arsdigita.kernel.RoleCollection;
 import com.arsdigita.kernel.permissions.PrivilegeDescriptor;
+import com.arsdigita.loader.PackageLoader;
 import com.arsdigita.persistence.DataQuery;
 import com.arsdigita.runtime.ScriptContext;
 import com.arsdigita.util.Assert;

ccm-ldn-aplaws/src/com/arsdigita/aplaws/ObjectTypeTraversalAdapter.java

@@ -18,8 +18,8 @@
 
 package com.arsdigita.aplaws;
 
-import com.arsdigita.persistence.metadata.Property;
 import com.arsdigita.persistence.metadata.ObjectType;
+import com.arsdigita.persistence.metadata.Property;
 
 // XXX this class is pretty similar to DomainObjectTraversal
 // and it would be nice to figure out a way to let them share

ccm-ldn-aplaws/src/com/arsdigita/aplaws/SimpleObjectTypeTraversalAdapter.java

@@ -18,10 +18,10 @@
 
 package com.arsdigita.aplaws;
 
-import org.apache.log4j.Logger;
-import com.arsdigita.persistence.metadata.Property;
 import com.arsdigita.persistence.metadata.ObjectType;
+import com.arsdigita.persistence.metadata.Property;
 import java.util.HashSet;
+import org.apache.log4j.Logger;
 
 /**
  * This is a general purpose traversal adaptor

ccm-ldn-aplaws/src/com/arsdigita/aplaws/WebAppPatternGenerator.java

@@ -30,7 +30,10 @@ import org.apache.log4j.Logger;
 
 /**
  * Generates a set of patterns corresponding to the current 
- * web application prefix
+ * web application prefix.
+ * 
+ * It is a slight modification of 
+ * {@see com.arsdigita.templating.WebAppPatternGenerator}
  */
 public class WebAppPatternGenerator implements PatternGenerator {
 
@@ -59,6 +62,7 @@ public class WebAppPatternGenerator implements PatternGenerator {
             ctx = ctx.substring(1);
         }
         
-        return new String[] { ctx };
+        return new String[] { ctx };  // this version cuts ","+ Web.ROOT_WEBAPP
+                                      // as in c.a.templating.WebAppPatternGenerator
     }
 }

ccm-ldn-aplaws/src/com/arsdigita/aplaws/ui/ItemCategoryPicker.java

@@ -18,8 +18,6 @@
 
 package com.arsdigita.aplaws.ui;
 
-import org.apache.log4j.Logger;
-
 import com.arsdigita.bebop.PageState;
 import com.arsdigita.bebop.parameters.BigDecimalParameter;
 import com.arsdigita.bebop.parameters.StringParameter;
@@ -31,9 +29,11 @@ import com.arsdigita.kernel.ACSObject;
 import com.arsdigita.london.terms.ui.ACSObjectCategoryPicker;
 import com.arsdigita.london.terms.ui.TermWidget;
 
+import org.apache.log4j.Logger;
+
 /**
  * <p> cms specific Concrete implementation of 
- * <code>com.arsdigita.aplaws.ui.ACSObjectCategoryPicker</code>. </p>
+ * <code>com.arsdigita.london.terms.ui.ACSObjectCategoryPicker</code>. </p>
  * 
  *  
  * 
@@ -56,9 +56,9 @@ public class ItemCategoryPicker extends ACSObjectCategoryPicker {
 
 
     /*
-     * @see com.arsdigita.aplaws.ui.ACSObjectCategoryPicker#getForm(
+     * @see com.arsdigita.london.terms.ui.ACSObjectCategoryPicker#getForm(
-                         com.arsdigita.bebop.parameters.BigDecimalParameter, 
+     *                   com.arsdigita.bebop.parameters.BigDecimalParameter, 
-                         com.arsdigita.bebop.parameters.StringParameter)
+     *                   com.arsdigita.bebop.parameters.StringParameter)
      */
     protected ACSObjectCategoryForm getForm(BigDecimalParameter root,
                                             StringParameter mode) {
@@ -68,7 +68,7 @@ public class ItemCategoryPicker extends ACSObjectCategoryPicker {
 
 
     /* 
-     * @see com.arsdigita.aplaws.ui.ACSObjectCategoryPicker#getObject()
+     * @see com.arsdigita.london.terms.ui.ACSObjectCategoryPicker#getObject()
      */
     protected ACSObject getObject(PageState state) {
         ContentItem item = CMS.getContext().getContentItem();

ccm-portalworkspace/src/com/arsdigita/portalworkspace/WorkspaceConfig.java

@@ -22,9 +22,9 @@ import com.arsdigita.kernel.permissions.PrivilegeDescriptor;
 import com.arsdigita.runtime.AbstractConfig;
 import com.arsdigita.util.parameter.BooleanParameter;
 import com.arsdigita.util.parameter.Parameter;
+import com.arsdigita.util.parameter.ResourceParameter;
 import com.arsdigita.util.parameter.StringArrayParameter;
 import com.arsdigita.util.parameter.StringParameter;
-import com.arsdigita.util.parameter.ResourceParameter;
 
 import java.io.InputStream;
 import java.util.Arrays;