Skip to content

Commit

Permalink
readme updated for 5.0.0-RELEASE
Browse files Browse the repository at this point in the history
  • Loading branch information
dgradecak committed Nov 24, 2017
1 parent 38f44e5 commit 5e0b63b
Showing 1 changed file with 4 additions and 41 deletions.
45 changes: 4 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,41 +8,7 @@ since Alfresco MVC 5.0.0

Personally I do not like webscripts because of the boilerplate code that comes with them (XML, FTL, Java/Javascript). Also I am not a big fan of javascript on the server side as in a medium sized application that becomes unmaintainable. That is why I wrote Alfresco @MVC.

Alfresco @MVC consist of several libraries, REST, AOP, QueryTemplate, Spring-DATA. REST and AOP have no third party dependencies, where QueryTemplate and Spring-DATA do have.

Alfresco-MVC DATA
===
A proof of concept implementation of Spring Data on top of Alfresco. With the combination of Alfresco MVC and Spring Data, developers benefit of a incredible rapid development library.

Define the Alfresco Spring Data repository
```
@Repository
public interface CmDocumentRepository extends AlfrescoNodeRepository<CmDocument> {}
```

A new annotation helping to identify and describe Alfresco nodes (for now there is a naming convention camel cased QName is the field name, or use a custom mapper as in Alfresco MVC queryTemplate)
```
@AlfrescoNode
public class CmDocument extends AbstractPersistable {
private String cmVersionLabel;
private String cmTitle;
private String cmDescription;
...
}
@AlfrescoNode(entityMapper = CmDocumentPropertiesMapper.class, nodeMapper = CmDocumentPropertiesMapper.class)
```

Enable the repositories with @EnableAlfrescoRepositories in spring's configuration
```
@Configuration
@EnableAlfrescoRepositories(basePackageClasses = CmDocumentRepository.class)
public class AlfrescoMvcDataModuleConfig extends AlfrescoMvcDataConfig{
}
```

Alfresco @MVC consist of several libraries, REST, AOP, QueryTemplate. REST and AOP have no third party dependencies, where QueryTemplate do have.

Alfresco-MVC REST
===
Expand Down Expand Up @@ -156,7 +122,7 @@ There is a spring proxy limitation (spring 3.2.x) in order to use @Autowired on

Alfresco-MVC QUERY TEMPLATE
===
Inspired by spring's jdbc/rest templates this is a very useful way of writing alfresco lucene/solr queries (not canned queries). Has a dependencies on Srring Data Commons.
Inspired by spring's jdbc/rest templates this is a very useful way of writing alfresco lucene/solr queries (not canned queries). Has a dependencies on Spring Data Commons.
The QueryTemplate class is thread safe and it is advised to use it as singleton.

```
Expand Down Expand Up @@ -206,9 +172,6 @@ Alfresco @MVC comes with a couple of sample applications that are located in /al
- alfresco-mvc-querytemplate-sample => http://localhost:8080/alfresco/service/mvc/querytemplate/sample
http://localhost:8080/alfresco/service/mvc/querytemplate/search (search engine has to be enabled)

- alfresco-mvc-data-sample => http://localhost:8080/alfresco/service/mvc/data/document
http://localhost:8080/alfresco/service/mvc/data/folder

alfresco-mvc-querytemplate-sample is the most complete sample that reassemble all the features of Alfresco @MVC

Maven dependency:
Expand All @@ -220,7 +183,7 @@ Latest snapshot version comes with a BOM:
<dependency>
<groupId>com.gradecak.alfresco-mvc</groupId>
<artifactId>alfresco-mvc-bom</artifactId>
<version>5.0.0-SNAPSHOT</version>
<version>5.0.1-SNAPSHOT</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down Expand Up @@ -251,7 +214,7 @@ Latest release version:
<dependency>
<groupId>com.gradecak.alfresco</groupId>
<artifactId>alfresco-mvc</artifactId>
<version>4.5.0-RELEASE</version>
<version>5.0.0-RELEASE</version>
</dependency>
```

Expand Down

0 comments on commit 5e0b63b

Please sign in to comment.