. Generic "command servlet" implementation

- Replaces specific command servlets, such as the WorkflowActionServlet with a generic CommandServlet

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2619 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/web/app/Application.java

@@ -573,6 +573,19 @@ public class Application
             Application.BEAN_CONFIG_SERVICE);
    }
    
+   /**
+    * Helper to get the ConfigService instance
+    * 
+    * @param context        ServletContext
+    * 
+    * @return ConfigService
+    */
+   public static ConfigService getConfigService(ServletContext context)
+   {
+      return (ConfigService)WebApplicationContextUtils.getRequiredWebApplicationContext(context).getBean(
+            Application.BEAN_CONFIG_SERVICE);
+   }
+   
    /**
     * Helper to get the client config element from the config service
     * 

source/java/org/alfresco/web/config/CommandServletConfigElement.java

@@ -0,0 +1,105 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.config;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.alfresco.config.ConfigElement;
+import org.alfresco.config.ConfigException;
+import org.alfresco.config.element.ConfigElementAdapter;
+
+/**
+ * @author Kevin Roast
+ */
+public class CommandServletConfigElement extends ConfigElementAdapter
+{
+   public static final String CONFIG_ELEMENT_ID = "command-servlet";
+   
+   private Map<String, Class> commandProcessors = new HashMap<String, Class>(4, 1.0f);
+   
+   /**
+    * Default constructor
+    */
+   public CommandServletConfigElement()
+   {
+      super("command-servlet");
+   }
+
+   /**
+    * Constructor
+    * 
+    * @param name Name of the element this config element represents
+    */
+   public CommandServletConfigElement(String name)
+   {
+      super(name);
+   }
+   
+   /**
+    * @see org.alfresco.config.element.ConfigElementAdapter#getChildren()
+    */
+   public List<ConfigElement> getChildren()
+   {
+      throw new ConfigException("Reading the Command Servlet config via the generic interfaces is not supported");
+   }
+   
+   /**
+    * @see org.alfresco.config.element.ConfigElementAdapter#combine(org.alfresco.config.ConfigElement)
+    */
+   public ConfigElement combine(ConfigElement configElement)
+   {
+      CommandServletConfigElement existingElement = (CommandServletConfigElement)configElement;
+      CommandServletConfigElement newElement = new CommandServletConfigElement();
+      
+      for (String name : commandProcessors.keySet())
+      {
+         newElement.addCommandProcessor(name, commandProcessors.get(name));
+      }
+      for (String name : existingElement.commandProcessors.keySet())
+      {
+         newElement.addCommandProcessor(name, existingElement.commandProcessors.get(name));
+      }
+      
+      return newElement;
+   }
+   
+   /*package*/ void addCommandProcessor(String name, String className)
+   {
+      try
+      {
+         Class clazz = Class.forName(className);
+         commandProcessors.put(name, clazz);
+      }
+      catch (Throwable err)
+      {
+         throw new ConfigException("Unable to load command proccessor class: " +
+               className + " due to " + err.getMessage());
+      }
+   }
+   
+   private void addCommandProcessor(String name, Class clazz)
+   {
+      commandProcessors.put(name, clazz);
+   }
+   
+   public Class getCommandProcessor(String name)
+   {
+      return commandProcessors.get(name);
+   }
+}

source/java/org/alfresco/web/config/CommandServletElementReader.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.config;
+
+import java.util.Iterator;
+
+import org.alfresco.config.ConfigElement;
+import org.alfresco.config.ConfigException;
+import org.alfresco.config.xml.elementreader.ConfigElementReader;
+import org.dom4j.Element;
+
+/**
+ * @author Kevin Roast
+ */
+public class CommandServletElementReader implements ConfigElementReader
+{
+   public static final String ELEMENT_COMMANDPROCESSOR = "command-processor";
+   public static final String ATTRIBUTE_NAME = "name";
+   public static final String ATTRIBUTE_CLASS = "class";
+   
+   /**
+    * @see org.alfresco.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element)
+    */
+   @SuppressWarnings("unchecked")
+   public ConfigElement parse(Element element)
+   {
+      CommandServletConfigElement configElement = new CommandServletConfigElement();
+      
+      if (element != null)
+      {
+         if (CommandServletConfigElement.CONFIG_ELEMENT_ID.equals(element.getName()) == false)
+         {
+            throw new ConfigException("CommandServletElementReader can only parse config elements of type 'command-servlet'");
+         }
+         
+         Iterator<Element> itr = element.elementIterator(ELEMENT_COMMANDPROCESSOR);
+         while (itr.hasNext())
+         {
+            Element procElement = itr.next();
+            
+            String name = procElement.attributeValue(ATTRIBUTE_NAME);
+            String className = procElement.attributeValue(ATTRIBUTE_CLASS);
+            
+            if (name == null || name.length() == 0)
+            {
+               throw new ConfigException("'name' attribute is mandatory for command processor config element.");
+            }
+            if (className == null || className.length() == 0)
+            {
+               throw new ConfigException("'class' attribute is mandatory for command processor config element.");
+            }
+            
+            configElement.addCommandProcessor(name, className);
+         }
+      }
+      
+      return configElement;
+   }
+}