Summary: This document provides basic information about the extension providing Spring MVC support for Web Services.
- Support multiple urls and methods
- Support new annotations from Spring 4 like @GetMapping
This extension provides support for Spring MVC.
In what situation should you install this extension?
The main purpose of this extension is to create HTTP API entry points for JEE back-end applications that are used to create REST API Services. If you need to have links from a Client Front-end (see examples below) to the Spring MVC/JEE Back-end you should install this extension.
|iOS Front-End Example||AngularJS Front-End Example|
This extension handles Spring MVC Web Services used in JEE applications, for example:
For each class annotated with
- org.springframework.web.bind.annotation.RequestMapping (@RequestMapping )
- org.springframework.web.bind.annotation.GetMapping (@GetMapping )
- org.springframework.web.bind.annotation.PostMapping (@PostMapping )
- org.springframework.web.bind.annotation.PutMapping (@PutMapping )
- org.springframework.web.bind.annotation.DeleteMapping (@DeleteMapping )
org.springframework.web.bind.annotation.PatchMapping (@PatchMapping ),
the following will be done:
- a Web Service object will be created
- a Web Service Port object child of the web service will be created
- for each Method annotated with "Annotation"Mapping, the following will be created:
- a Web Service operation child of the Web Service Port with correct get/put/delete/post type
- a fire link from the Web Service operation to the method
Basic case @RequestMapping
The following Java code
The following Java code:
will generate one operation per url mapping:
The following Java code:
will generate one operation per receiving method:
Spring 4 annotations
The syntax @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping are supported. Example with the following Java code:
Properties used inside annotations are evaluated by looking them into properties file. Example with the following Java code:
With properties file:
Support of thymeleaf
The following syntaxes are supported for thymeleaf templating:
Will create a link from the HTML5 content to a call to a webservice with url '/seedstartermng'
'th:href' are also supported:
Support for User Input Security
Service entry points are created automatically for applications that have a presentation layer based on SpringMVC with @RequestMapping (and associated annotations) usage. This can be seen in the analysis log file as follows:
This corresponds to the generation of a file in the following location:
Function Point, Quality and Sizing support
- Function Points (transactions): a green tick indicates that OMG Function Point counting and Transaction Risk Index are supported
- Quality and Sizing: a green tick indicates that CAST can measure size and that a minimum set of Quality Rules exist
|Quality and Sizing|
CAST AIP release
|7.3.4 and all higher 7.3.x releases|
Supported DBMS servers
This extension is compatible with the following DBMS servers:
|CAST AIP release||CSS2||Oracle||Microsoft|
|7.3.x / 8.0.x / 8.1.x / 8.2.x|
|An installation of any compatible release of CAST AIP (see table above)|
Dependencies with other extensions
Some CAST extensions require the presence of other CAST extensions in order to function correctly. The Spring MVC extension requires that the following other CAST extensions are also installed:
- Web services linker service (internal technical extension)
Note that when using the CAST Extension Downloader to download the extension and the Manage Extensions interface in CAST Server Manager to install the extension, any dependent extensions are automatically downloaded and installed for you. You do not need to do anything.
Download and installation instructions
The latest release status of this extension can be seen when downloading it from the CAST Extend server.
CAST Transaction Configuration Center (TCC) Entry Points
In Spring MVC ≥ 1.3.x, if you are using the extension with CAST AIP ≥ 8.3.x, a set of Spring MVC specific Transaction Entry Points are now automatically imported when the extension is installed. These Transaction Entry Points will be available in the CAST Transaction Configuration Center:
Manual import action for CAST AIP ≤ 8.2.x
- Locate the .TCCSetup file in the extension folder: Configuration\TCC\Base_Java_SpringMVC.TCCSetup
- In the CAST Transaction Configuration Center, ensure you have selected the Templates node:
- This .TCCSetup file is to be imported into the CAST Transaction Calibration Center using either the:
- File > Import Configuration menu option:
- Or right clicking on the Template node and selecting Import Configuration:
- The import of the "Base_Java_SpringMVC.TCCSetup" file will provide you with a sample Transaction Entry point in the Free Definition node under Templates:
- Now right click the "Standard Entry Point" item and select copy:
- Paste the item into the equivalent node under the Application, for example, below we have copied it into the Application MEUDON:
- Repeat for any additional items or generic sets that have been imported from the .TCCSetup file.
Packaging, delivering and analyzing your source code
Once the extension is installed, no further configuration changes are required before you can package your source code and run an analysis. The process of packaging, delivering and analyzing your source code does not change in any way:
- Package and deliver your application (that includes source code which uses Spring MVC) in the exact same way as you always have. You can refer to the existing official CAST documentation for more information about this - see: .
- Analyze your delivered application source code in the CAST Management Studio in the exact same way as you always have - the source code which uses Spring MVC will be detected and handled correctly. You can refer to the existing official CAST documentation for more information about configuring an analysis - see:
|Message ID||Message Type|
|SPMVC-001||Warning||Analysis||Various||None||Contact CAST Technical Support|
|SPMVC-002||Warning||Analysis||A property could not be found so we could not determine the name of a service.||Provide properties file with the value|
At the end of the log you will find a message in the form:
Indicating how many services have been found.
Note on JEE analyser warnings
The JEE analyser will complain that some annotations specific to SpringMVC are not handled by an environment profile while they are handled by this extension; you can simply ignore these warnings:
What results can you expect?
Once the analysis/snapshot generation has completed, HTTP API transaction entry points will be available for use when configuring the CAST Transaction Configuration Center. In addition, you can view the results in the normal manner (for example via CAST Enlighten).
Click to enlarge:
The following objects are displayed in CAST Enlighten on the Java side:
|Spring MVC Delete Operation Service|
|Spring MVC Get Operation Service|
|Spring MVC Post Operation Service|
|Spring MVC Put Operation Service|
|Spring MVC Port|
|Spring MVC Service|
No Quality Rules