You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by cz...@apache.org on 2006/03/03 11:13:17 UTC

svn commit: r382748 - in /cocoon/trunk: cocoon-blocks-fw/cocoon-blocks-fw-ecm-impl/src/main/java/org/apache/cocoon/core/container/handler/ cocoon-core/src/main/java/org/apache/cocoon/ cocoon-core/src/main/java/org/apache/cocoon/components/source/ cocoo...

Author: cziegeler
Date: Fri Mar  3 02:13:14 2006
New Revision: 382748

URL: http://svn.apache.org/viewcvs?rev=382748&view=rev
Log:
Add some constants for common beans

Added:
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/ProcessingUtil.java
      - copied, changed from r382712, cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/ProcessorUtil.java
Removed:
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/ProcessorUtil.java
Modified:
    cocoon/trunk/cocoon-blocks-fw/cocoon-blocks-fw-ecm-impl/src/main/java/org/apache/cocoon/core/container/handler/PoolableComponentHandler.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/Cocoon.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/source/SourceUtil.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/BeanFactoryUtil.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/PoolableFactoryBean.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/XmlConfigCreator.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/environment/internal/EnvironmentHelper.java

Modified: cocoon/trunk/cocoon-blocks-fw/cocoon-blocks-fw-ecm-impl/src/main/java/org/apache/cocoon/core/container/handler/PoolableComponentHandler.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-blocks-fw/cocoon-blocks-fw-ecm-impl/src/main/java/org/apache/cocoon/core/container/handler/PoolableComponentHandler.java?rev=382748&r1=382747&r2=382748&view=diff
==============================================================================
--- cocoon/trunk/cocoon-blocks-fw/cocoon-blocks-fw-ecm-impl/src/main/java/org/apache/cocoon/core/container/handler/PoolableComponentHandler.java (original)
+++ cocoon/trunk/cocoon-blocks-fw/cocoon-blocks-fw-ecm-impl/src/main/java/org/apache/cocoon/core/container/handler/PoolableComponentHandler.java Fri Mar  3 02:13:14 2006
@@ -25,7 +25,7 @@
 
 import org.apache.avalon.framework.configuration.Configuration;
 import org.apache.avalon.framework.logger.Logger;
-import org.apache.cocoon.ProcessorUtil;
+import org.apache.cocoon.ProcessingUtil;
 import org.apache.cocoon.components.ComponentInfo;
 import org.apache.cocoon.core.container.ComponentFactory;
 
@@ -130,7 +130,7 @@
         return interfaces;
     }
 
-    protected static final class ProxyHandler implements InvocationHandler, ProcessorUtil.CleanupTask {
+    protected static final class ProxyHandler implements InvocationHandler, ProcessingUtil.CleanupTask {
         
         private final ThreadLocal componentHolder = new ThreadLocal();
         private final PoolableComponentHandler handler;
@@ -149,7 +149,7 @@
             }
             if ( this.componentHolder.get() == null ) {
                 this.componentHolder.set(this.handler.getFromPool());
-                ProcessorUtil.addCleanupTask(this);
+                ProcessingUtil.addCleanupTask(this);
             }
             try {
                 return method.invoke(this.componentHolder.get(), args);

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/Cocoon.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/Cocoon.java?rev=382748&r1=382747&r2=382748&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/Cocoon.java (original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/Cocoon.java Fri Mar  3 02:13:14 2006
@@ -257,7 +257,7 @@
             if (this.logger.isDebugEnabled()) {
                 --activeRequestCount;
             }
-            ProcessorUtil.cleanup();
+            ProcessingUtil.cleanup();
 
             EnvironmentHelper.checkEnvironment(environmentDepth, this.logger);
         }

Copied: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/ProcessingUtil.java (from r382712, cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/ProcessorUtil.java)
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/ProcessingUtil.java?p2=cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/ProcessingUtil.java&p1=cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/ProcessorUtil.java&r1=382712&r2=382748&rev=382748&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/ProcessorUtil.java (original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/ProcessingUtil.java Fri Mar  3 02:13:14 2006
@@ -19,17 +19,33 @@
 import java.util.Iterator;
 import java.util.List;
 
+import org.apache.avalon.framework.service.ServiceManager;
+import org.apache.cocoon.core.Settings;
+import org.apache.cocoon.environment.internal.EnvironmentHelper;
+
 /**
  * This is an utility class for processing Cocoon requests.
  *
  * $Id$
  */
-public class ProcessorUtil {
+public class ProcessingUtil {
+
+    /** Bean name for the Avalon context. */
+    public static String CONTEXT_ROLE = "org.apache.avalon.framework.context.Context";
+
+    /** Bean name for the logger. */
+    public static String LOGGER_ROLE = "org.apache.avalon.framework.logger.Logger";
+
+    /** Bean name for the settings. */
+    public static String SETTINGS_ROLE = Settings.class.getName();
+
+    /** Bean name for the service manager. */
+    public static String SERVICE_MANAGER_ROLE = "org.apache.avalon.framework.service.ServiceManager";
 
     /**
      * Avoid construction.
      */
-    private ProcessorUtil() {}
+    private ProcessingUtil() {}
 
     /**
      * The cleanup threads that are invoked after the processing of a
@@ -81,4 +97,13 @@
         void invoke();
     }
 
+    /**
+     * Get the current sitemap component manager.
+     * This method return the current sitemap component manager. This
+     * is the manager that holds all the components of the currently
+     * processed (sub)sitemap.
+     */
+    static public ServiceManager getSitemapServiceManager() {
+        return EnvironmentHelper.getSitemapServiceManager(); 
+    }
 }

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/source/SourceUtil.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/source/SourceUtil.java?rev=382748&r1=382747&r2=382748&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/source/SourceUtil.java (original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/source/SourceUtil.java Fri Mar  3 02:13:14 2006
@@ -21,8 +21,8 @@
 import org.apache.avalon.framework.service.ServiceSelector;
 
 import org.apache.cocoon.ProcessingException;
+import org.apache.cocoon.ProcessingUtil;
 import org.apache.cocoon.ResourceNotFoundException;
-import org.apache.cocoon.environment.internal.EnvironmentHelper;
 import org.apache.cocoon.serialization.Serializer;
 import org.apache.cocoon.util.NetUtils;
 import org.apache.cocoon.xml.IncludeXMLConsumer;
@@ -131,7 +131,7 @@
     static public void toSAX(Source source,
                              ContentHandler handler)
     throws SAXException, IOException, ProcessingException {
-        toSAX(EnvironmentHelper.getSitemapServiceManager(),
+        toSAX(ProcessingUtil.getSitemapServiceManager(),
               source, null, handler);
     }
 
@@ -150,7 +150,7 @@
                              String mimeTypeHint,
                              ContentHandler handler)
     throws SAXException, IOException, ProcessingException {
-        toSAX(EnvironmentHelper.getSitemapServiceManager(),
+        toSAX(ProcessingUtil.getSitemapServiceManager(),
               source, mimeTypeHint, handler);
     }
 
@@ -573,7 +573,7 @@
                 frag.normalize();
 
                 if (null != serializerName) {
-                    ServiceManager manager = EnvironmentHelper.getSitemapServiceManager();
+                    ServiceManager manager = ProcessingUtil.getSitemapServiceManager();
 
                     ServiceSelector selector = null;
                     Serializer serializer = null;
@@ -615,7 +615,7 @@
             } else {
                 String content;
                 if (null != serializerName) {
-                    ServiceManager manager = EnvironmentHelper.getSitemapServiceManager();
+                    ServiceManager manager = ProcessingUtil.getSitemapServiceManager();
 
                     ServiceSelector selector = null;
                     Serializer serializer = null;

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/BeanFactoryUtil.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/BeanFactoryUtil.java?rev=382748&r1=382747&r2=382748&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/BeanFactoryUtil.java (original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/BeanFactoryUtil.java Fri Mar  3 02:13:14 2006
@@ -25,9 +25,9 @@
 import org.apache.avalon.excalibur.logger.ServletLogger;
 import org.apache.avalon.framework.configuration.Configuration;
 import org.apache.avalon.framework.configuration.DefaultConfiguration;
-import org.apache.avalon.framework.context.Context;
 import org.apache.avalon.framework.context.DefaultContext;
 import org.apache.avalon.framework.logger.Logger;
+import org.apache.cocoon.ProcessingUtil;
 import org.apache.cocoon.acting.Action;
 import org.apache.cocoon.components.pipeline.ProcessingPipeline;
 import org.apache.cocoon.components.treeprocessor.ProcessorComponentInfo;
@@ -105,9 +105,9 @@
     throws Exception {
         final ApplicationContext parent = (ApplicationContext)env.servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE);
         CocoonBeanFactory factory = new CocoonBeanFactory(parent);
-        factory.registerSingleton(Context.class.getName(), env.context);
-        factory.registerSingleton(Logger.class.getName(), env.logger);
-        factory.registerSingleton(Settings.class.getName(), env.settings);
+        factory.registerSingleton(ProcessingUtil.CONTEXT_ROLE, env.context);
+        factory.registerSingleton(ProcessingUtil.LOGGER_ROLE, env.logger);
+        factory.registerSingleton(ProcessingUtil.SETTINGS_ROLE, env.settings);
         return factory;
     }
 

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/PoolableFactoryBean.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/PoolableFactoryBean.java?rev=382748&r1=382747&r2=382748&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/PoolableFactoryBean.java (original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/PoolableFactoryBean.java Fri Mar  3 02:13:14 2006
@@ -26,7 +26,7 @@
 import java.util.Set;
 
 import org.apache.avalon.excalibur.pool.Recyclable;
-import org.apache.cocoon.ProcessorUtil;
+import org.apache.cocoon.ProcessingUtil;
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.BeanFactoryAware;
@@ -314,7 +314,7 @@
         }
     }
 
-    protected static final class ProxyHandler implements InvocationHandler, ProcessorUtil.CleanupTask {
+    protected static final class ProxyHandler implements InvocationHandler, ProcessingUtil.CleanupTask {
         
         private final ThreadLocal componentHolder = new ThreadLocal();
         private final PoolableFactoryBean handler;
@@ -333,7 +333,7 @@
             }
             if ( this.componentHolder.get() == null ) {
                 this.componentHolder.set(this.handler.getFromPool());
-                ProcessorUtil.addCleanupTask(this);
+                ProcessingUtil.addCleanupTask(this);
             }
             try {
                 return method.invoke(this.componentHolder.get(), args);
@@ -344,7 +344,7 @@
         
         
         /**
-         * @see ProcessorUtil.CleanupTask#invoke()
+         * @see ProcessingUtil.CleanupTask#invoke()
          */
         public void invoke() {
             try {

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/XmlConfigCreator.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/XmlConfigCreator.java?rev=382748&r1=382747&r2=382748&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/XmlConfigCreator.java (original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/core/container/spring/XmlConfigCreator.java Fri Mar  3 02:13:14 2006
@@ -26,6 +26,7 @@
 import org.apache.avalon.framework.service.ServiceManager;
 import org.apache.avalon.framework.thread.ThreadSafe;
 import org.apache.cocoon.Cocoon;
+import org.apache.cocoon.ProcessingUtil;
 import org.apache.cocoon.Processor;
 import org.springframework.util.StringUtils;
 
@@ -71,7 +72,7 @@
         }
         // start with "static" components: ServiceManager
         buffer.append("<bean");
-        this.appendAttribute(buffer, "id", ServiceManager.class.getName());
+        this.appendAttribute(buffer, "id", ProcessingUtil.SERVICE_MANAGER_ROLE);
         this.appendAttribute(buffer, "class", AvalonServiceManager.class.getName());
         this.appendAttribute(buffer, "singleton", "true");
         buffer.append("/>\n");

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/environment/internal/EnvironmentHelper.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/environment/internal/EnvironmentHelper.java?rev=382748&r1=382747&r2=382748&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/environment/internal/EnvironmentHelper.java (original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/environment/internal/EnvironmentHelper.java Fri Mar  3 02:13:14 2006
@@ -41,6 +41,8 @@
  * For developing your own components/applications based on Cocoon, you shouldn't
  * really need it.
  *
+ * INTERNAL CLASS. Do not use this, can be removed without warning or deprecation cycle.
+ *
  * @version $Id$
  * @since 2.2
  */
@@ -338,7 +340,7 @@
     }
 
     /**
-     * INTERNAL METHOD. Do not use, can be removed without warning or deprecation cycle.
+     * INTERNAL METHOD. Do not use this, can be removed without warning or deprecation cycle.
      */
     public static void checkEnvironment(int depth, Logger logger)
     throws Exception {
@@ -354,7 +356,8 @@
     }
 
     /**
-     * Return the environment
+     * Return the environment.
+     * INTERNAL METHOD. Do not use this, can be removed without warning or deprecation cycle.
      */
     public static Environment getCurrentEnvironment() {
         final EnvironmentStack stack = (EnvironmentStack) environmentStack.get();
@@ -367,6 +370,7 @@
 
     /**
      * Return the current processor
+     * INTERNAL METHOD. Do not use this, can be removed without warning or deprecation cycle.
      */
     public static Processor getCurrentProcessor() {
         final EnvironmentStack stack = (EnvironmentStack)environmentStack.get();
@@ -382,6 +386,7 @@
      * This method return the current sitemap component manager. This
      * is the manager that holds all the components of the currently
      * processed (sub)sitemap.
+     * INTERNAL METHOD. Do not use this, can be removed without warning or deprecation cycle.
      */
     static public ServiceManager getSitemapServiceManager() {
         final EnvironmentStack stack = (EnvironmentStack)environmentStack.get();
@@ -394,7 +399,8 @@
 
     /**
      * Create an environment aware xml consumer for the cocoon
-     * protocol
+     * protocol.
+     * INTERNAL METHOD. Do not use this, can be removed without warning or deprecation cycle.
      */
     public static XMLConsumer createEnvironmentAwareConsumer(XMLConsumer consumer) {
         final EnvironmentStack stack = (EnvironmentStack)environmentStack.get();