Author: Marius Bogoevici, Tejas Mehta, Joshua Wilson
Level: Intermediate
Technologies: JSP, JPA, JSON, Spring, JUnit
Summary: The spring-kitchensink-controlleradvice
quickstart showcases Spring 4.x's @ControllerAdvice
, which was introduced in Spring 3.2.
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/
The spring-kitchensink-controlleradvice
quickstart is a deployable Maven 3 project that demonstrates how to use JSP, JPA, and Spring 4.x in WildFly Application Server 11 or later.
This example showcases Spring 4.x's @ControllerAdvice
, introduced in Spring 3.2, and used by MemberControllerAdvice.java
.
MemberControllerAdvice uses @ExceptionHandler
, @InitBinder
and @ModelAttribute
to configure global actions to be performed.
In jboss-as-spring-mvc-context.xml
<context:component-scan base-package="org.jboss.as.quickstarts.kitchensink.spring.controlleradvice.controller"/>
and <mvc:annotation-driven/>
are used to register both the non-rest and rest controllers.
The controllers map the respective urls to methods using @RequestMapping(url)
.
To return JSON, the rest controller uses @ResponseBody
.
The datasource and entitymanager are retrieved via JNDI.
The application this project produces is designed to be run on WildFly Application Server 11 or later.
All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven for WildFly 11 to make sure you are configured correctly for testing the quickstarts.
For Linux: WILDFLY_HOME/bin/standalone.sh
For Windows: WILDFLY_HOME\bin\standalone.bat
mvn clean install wildfly:deploy
This will deploy target/spring-kitchensink-controlleradvice.war
to the running instance of the server.
The application will be running at the following URL: http://localhost:8080/spring-kitchensink-controlleradvice/.
mvn wildfly:undeploy
This quickstart provides Arquillian functional tests as well. They are located in the functional-tests/ subdirectory under the root directory of this quickstart. Functional tests verify that your application behaves correctly from the user's point of view. The tests open a browser instance, simulate clicking around the page as a normal user would do, and then close the browser instance.
To run these tests, you must build the main project as described above.
mvn clean package
Navigate to the functional-tests/ directory in this quickstart.
mvn clean verify -Parq-remote
If you prefer to run the functional tests using managed instance of the WildFly server, meaning the tests will start the server for you, type the following command:
mvn clean verify -Parq-managed
You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a WildFly server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.
If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
mvn dependency:sources
mvn dependency:resolve -Dclassifier=javadoc