inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-31 17:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

. Generic "command servlet" implementation

Browse Source 
- 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
This commit is contained in:
Kevin Roast
2006-04-04 13:18:44 +00:00
parent 54c9595dc6
commit 057252f0e4
6 changed files with 212 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
config/alfresco/templates/workflow_details.ftl
View File

@@ -5,7 +5,7 @@
<#assign ref=document.nodeRef>
<#assign workspace=ref[0..ref?index_of("://")-1]>
<#assign storenode=ref[ref?index_of("://")+3..]>
&nbsp;&nbsp;Approve Step: <a href="/alfresco/workflow/approve/${workspace}/${storenode}">${document.properties["app:approveStep"]}</a><br>
&nbsp;&nbsp;Approve Step: <a href="/alfresco/command/workflow/approve/${workspace}/${storenode}">${document.properties["app:approveStep"]}</a><br>
</#if>
<#if document.properties["app:approveFolder"]?exists>
&nbsp;&nbsp;Approve Folder: <a href="/alfresco${document.properties["app:approveFolder"].url}">${document.properties["app:approveFolder"].name}</a><br>
@@ -14,7 +14,7 @@
<#assign ref=document.nodeRef>
<#assign workspace=ref[0..ref?index_of("://")-1]>
<#assign storenode=ref[ref?index_of("://")+3..]>
&nbsp;&nbsp;Reject Step: <a href="/alfresco/workflow/reject/${workspace}/${storenode}">${document.properties["app:rejectStep"]}</a><br>
&nbsp;&nbsp;Reject Step: <a href="/alfresco/command/workflow/reject/${workspace}/${storenode}">${document.properties["app:rejectStep"]}</a><br>
</#if>
<#if document.properties["app:rejectFolder"]?exists>
&nbsp;&nbsp;Reject Folder: <a href="/alfresco${document.properties["app:rejectFolder"].url}">${document.properties["app:rejectFolder"].name}</a><br>

18
config/alfresco/web-client-config.xml
View File

@@ -10,6 +10,7 @@
<element-reader element-name="property-sheet" class="org.alfresco.web.config.PropertySheetElementReader"/>
<element-reader element-name="navigation" class="org.alfresco.web.config.NavigationElementReader" />
<element-reader element-name="languages" class="org.alfresco.web.config.LanguagesElementReader" />
<element-reader element-name="command-servlet" class="org.alfresco.web.config.CommandServletElementReader" />
<element-reader element-name="advanced-search" class="org.alfresco.web.config.AdvancedSearchElementReader" />
<element-reader element-name="views" class="org.alfresco.web.config.ViewsElementReader" />
<element-reader element-name="actions" class="org.alfresco.web.config.ActionsElementReader" />
@@ -60,9 +61,10 @@
<!-- the list of available language files -->
<languages>
<language locale="en_US">English</language>
<!-- <language locale="fr_FR">French</language> -->
<!-- <language locale="de_DE">German</language> -->
<!-- <language locale="ja_JP">Japanese</language> -->
<language locale="fr_FR">French</language>
<language locale="de_DE">German</language>
<language locale="ja_JP">Japanese</language>
<language locale="th_TH">Thailand</language>
</languages>
</config>
@@ -124,6 +126,16 @@
</node-event-listeners> -->
</config>
<config evaluator="string-compare" condition="Command Servlet">
<!-- The list registed servlet command processors -->
<!-- Command processors implement org.alfresco.web.app.servlet.command.CommandProcessor -->
<!-- They are registered against a name and all calls to the command servlet -->
<!-- which match the name are forwared to the class instance -->
<command-servlet>
<command-processor name="workflow" class="org.alfresco.web.app.servlet.command.WorkflowCommandProcessor" />
</command-servlet>
</config>
<config evaluator="string-compare" condition="Advanced Search">
<!-- advanced search custom attribute config -->
<advanced-search>

13
source/java/org/alfresco/web/app/Application.java
View File

@@ -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
*

105
source/java/org/alfresco/web/config/CommandServletConfigElement.java Normal file
View File

@@ -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);
}
}

73
source/java/org/alfresco/web/config/CommandServletElementReader.java Normal file
View File

@@ -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;
}
}

8
source/web/WEB-INF/web_TEMPLATE.xml
View File

@@ -151,8 +151,8 @@
</servlet>
<servlet>
<servlet-name>workflowAction</servlet-name>
<servlet-class>org.alfresco.web.app.servlet.WorkflowActionServlet</servlet-class>
<servlet-name>commandServlet</servlet-name>
<servlet-class>org.alfresco.web.app.servlet.CommandServlet</servlet-class>
</servlet>
<servlet>
@@ -201,8 +201,8 @@
</servlet-mapping>
<servlet-mapping>
<servlet-name>workflowAction</servlet-name>
<url-pattern>/workflow/*</url-pattern>
<servlet-name>commandServlet</servlet-name>
<url-pattern>/command/*</url-pattern>
</servlet-mapping>
<servlet-mapping>