JarCasting
JarCasting JarCasting

Alfresco MVC rest

Glue between SpringMVC and Alfresco. This library enables the usage of Spring @MVC within Alfresco.

License

License
GroupId

GroupId

com.gradecak.alfresco-mvc
ArtifactId

ArtifactId

alfresco-mvc-rest
Last Version

Last Version

7.5.1-RELEASE
Release Date

Release Date
Type

Type

jar
Description

Description

Alfresco MVC rest
Glue between SpringMVC and Alfresco. This library enables the usage of Spring @MVC within Alfresco.
Source Code Management

Source Code Management

https://github.com/dgradecak/alfresco-mvc/tree/master/alfresco-mvc-rest

Download alfresco-mvc-rest

Filename Size
alfresco-mvc-rest-7.5.1-RELEASE.pom
alfresco-mvc-rest-7.5.1-RELEASE.jar 35 KB
alfresco-mvc-rest-7.5.1-RELEASE-tests.jar 41 KB
alfresco-mvc-rest-7.5.1-RELEASE-sources.jar 25 KB
alfresco-mvc-rest-7.5.1-RELEASE-javadoc.jar 529 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.gradecak.alfresco-mvc/alfresco-mvc-rest/ -->
<dependency>
    <groupId>com.gradecak.alfresco-mvc</groupId>
    <artifactId>alfresco-mvc-rest</artifactId>
    <version>7.5.1-RELEASE</version>
</dependency>
// https://jarcasting.com/artifacts/com.gradecak.alfresco-mvc/alfresco-mvc-rest/
implementation 'com.gradecak.alfresco-mvc:alfresco-mvc-rest:7.5.1-RELEASE'
// https://jarcasting.com/artifacts/com.gradecak.alfresco-mvc/alfresco-mvc-rest/
implementation ("com.gradecak.alfresco-mvc:alfresco-mvc-rest:7.5.1-RELEASE")
'com.gradecak.alfresco-mvc:alfresco-mvc-rest:jar:7.5.1-RELEASE'
<dependency org="com.gradecak.alfresco-mvc" name="alfresco-mvc-rest" rev="7.5.1-RELEASE">
  <artifact name="alfresco-mvc-rest" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.gradecak.alfresco-mvc', module='alfresco-mvc-rest', version='7.5.1-RELEASE')
)
libraryDependencies += "com.gradecak.alfresco-mvc" % "alfresco-mvc-rest" % "7.5.1-RELEASE"
[com.gradecak.alfresco-mvc/alfresco-mvc-rest "7.5.1-RELEASE"]

Dependencies

provided (6)

Group / Artifact Type Version
javax.servlet : javax.servlet-api jar 3.0.1
org.alfresco » alfresco-data-model jar
org.alfresco » alfresco-remote-api jar
org.springframework : spring-webmvc jar
org.alfresco » alfresco-repository jar
org.springframework : spring-test jar 5.1.8.RELEASE

test (2)

Group / Artifact Type Version
org.mockito : mockito-core jar 3.0.0
org.junit.jupiter : junit-jupiter-engine jar 5.5.1

Project Modules

There are no modules declared in this project.

The missing glue between Alfresco and Spring MVC

Works on Enterprise as well as on Community and it ruses a widely accepted REST framework

The docs are on the wiki page

You should use it when

  • You need custom APIs
  • You want to be more productive
  • You write custom webscripts

You would benefit of

  • Faster development
  • Java developers know how to use Spring MVC

Supported Alfresco versions

v7.5.0-RELEASE

  • Possibility to disable parent context servlet behavior @AlfrescoDispatcherWebscript(... servletConfigOptions = {ServletConfigOptions.DISABLED_PARENT_HANDLER_MAPPINGS, ...})
  • DispatcherWebscript servlet context can inherit all parent context properties (alfresco global included), or by annotation @AlfrescoDispatcherWebscript(inheritGlobalProperties = true, ...)
  • Tested on Alfresco Community 6.2.0-GA
  • Tested on Alfresco Enterprise 6.2

v7

  • the querytemplate module has been deprecated and will be removed in the next major release (Alfresco 5.2+ include a REST API and we recommend using classes from the package org.alfresco.rest.api)
  • @AlfrescoRestResponse can be used to annotate a controller or a controller method in order to use Alfresco Rest API response processing
  • clearer isolation of Spring MVC Web and specific Jackson processors have been removed by default, since spring has been updated to 5.1.x in Alfresco ACS and Alfresco introduced org.alfresco.rest.framework.jacksonextensions.RestJsonModule which we are reusing now. Therefore if you want to continue using any of the serializers/deserializers or converters/formatters you need to manually include them in your WebMvcConfigurer implementation
  • use @EnableWebAlfrescoMvc which enables @EnableWebMvc and reuses com.gradecak.alfresco.mvc.rest.config.DefaultAlfrescoMvcServletContextConfig otherwise just use @EnableWebMvc and customize your servlet context as needed
  • ResponseMapBuilder has been deprecated use a Map instead
  • Tested on Alfresco Community 6.0.7-GA, 6.1.x, 6.2.0-GA
  • Tested on Alfresco Enterprise 6.0.1, 6.1, 6.2

v6

  • Tested on Alfresco Community 6.0.7-GA, 6.1.x, 6.2.0-A2
  • Tested on Alfresco Enterprise 6.0.1, 6.1, 6.2
  • there is an known issue with AGS/RM that can be easily avoided by not using the default servlet context configuration

v5

  • Tested on Alfresco Community 3.4.d, 4.0.x, 4.2.x, 5.0.a, 5.0.d, 5.1.e, 5.2.f, 5.2.g (might work with older version, if not please check previous releases/snapshots)
  • Tested on Alfresco Enterprise 3.4.5, 4.1.5, 4.2.1, 5.1.x, 5.2.x (might work with older version, if not please check previous releases/snapshots)

v4

  • Tested on Alfresco Community 3.4.d, 4.0.x, 4.2.x, 5.0.a, 5.0.d, 5.1.e, 5.2.f, 5.2.g (might work with older version, if not please check previous releases/snapshots)
  • Tested on Alfresco Enterprise 3.4.5, 4.1.5, 4.2.1, 5.1.x, 5.2.x (might work with older version, if not please check previous releases/snapshots)

Versions

Version
7.5.1-RELEASE
7.5.0-RELEASE
7.0.0-RELEASE
6.0.0-RELEASE
5.0.1-RELEASE
5.0.0-RELEASE