Download & Sources

It is recommended to use the latest version from the Download page

Installation

Install the Alfreco @MVC jar file in you application or container lib directory. Once installed this webscript enables the usage of Spring MVC within Alfresco.

Configure the webscript

A common place would be the module-context.xml file

<bean id="webscript.#XXX#.dispatch.post" class="com.gradecak.alfresco.mvc.DispatcherWebScript" parent="webscript" scope="prototype">
     <property name="contextConfigLocation" value="/YOUR_MODULE_PATH/servlet-context.xml"/>
</bean>

• where #XXX# is your package structure
• usually the module path in a Tomcat installation is : /WEB-INF/classes/alfresco/module/YOUR_MODULE
• do not forget to add a webscript for the GET method

and the descriptor (this is an example)

<webscript>
	<shortname>Dispatcher web script</shortname>
	<description>Dispatcher web script</description>
	<url>/PATH/{path}</url>
	<url>/PATH</url>
	<format default="json" />
	<authentication>none</authentication>
	<transaction>none</transaction>
</webscript>

• note that the transaction tag is set to none, you can change it normally as any other webscript and it will be used as the primary source of transaction demarcation. Of course, Spring @MVC let you handle the transaction with @Transactional and this is also supported in Alfresco @MVC. More information about Spring transaction management can be found on Spring's site or check the documentation for TransactionManagement

servlet-context.xml

Simply enable Spring annotations and use all the Spring config supported by Spring release included in Alfresco.

Sure, do not forget to include the package scanner in order to let Spring know about your annotated classes.

<context:component-scan base-package="com.gradecak.spring.controller" />

Spring controller

@Controller
@RequestMapping("/user/*")
public class UserController {

    @RequestMapping(value = "get", method = RequestMethod.GET)
    public String getUser(@RequestParam String userId) {
         ....

    }
}

• AutoWiring
• TransactionManagement
• Views