The spring-kitchensink-basic
quickstart is an example of a Java EE 7 application using JSP, JPA and Spring 4.x.
What is it?
The spring-kitchensink-basic
quickstart is an example of a Java EE 7 application using JSP, JPA and Spring 4.x in Red Hat JBoss Enterprise Application Platform. It
includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java:
-
In the
jboss-as-spring-mvc-context.xml
file, thecontext:component-scan
andmvc:annotation-driven
elements 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.
System Requirements
The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7.1 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 to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.
Use of EAP_HOME
In the following instructions, replace EAP_HOME
with the actual path to your JBoss EAP installation. The installation path is described in detail here: Use of EAP_HOME and JBOSS_HOME Variables.
Start the JBoss EAP Standalone Server
-
Open a terminal and navigate to the root of the JBoss EAP directory.
-
Start the JBoss EAP server with the default profile by typing the following command.
$ EAP_HOME/bin/standalone.sh
NoteFor Windows, use the EAP_HOME\bin\standalone.bat
script.
Build and Deploy the Quickstart
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type the following command to build the artifacts.
$ mvn clean package wildfly:deploy
This deploys the spring-kitchensink-basic/target/spring-kitchensink-basic.war
to the running instance of the server.
You should see a message in the server log indicating that the archive deployed successfully.
Access the application
The application will be running at the following URL: http://localhost:8080/spring-kitchensink-basic/.
Undeploy the Quickstart
When you are finished testing the quickstart, follow these steps to undeploy the archive.
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type this command to undeploy the archive:
$ mvn wildfly:undeploy
Run the Arquillian Functional Tests
This quickstart provides Arquillian functional tests. They are located under the functional-tests/
directory. Functional tests verify that your application behaves correctly from the user’s point of view and simulate clicking around the web page as a normal user would do.
Note
|
The Arquillian functional tests deploy the application, so make sure you undeploy the quickstart before you begin. |
Follow these steps to run the functional tests.
-
Start the JBoss EAP server as described above.
-
Build the quickstart archive.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Build the quickstart archive using the following command:
$ mvn clean package
-
-
Navigate to the
functional-tests/
directory in this quickstart. -
Type the following command to run the
verify
goal with thearq-remote
profile activated.$ mvn clean verify -Parq-remote
Note
|
You can also let Arquillian manage the JBoss EAP server by using the |
Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
You can also start the server and deploy the quickstarts or run the Arquillian tests in Red Hat JBoss Developer Studio or from Eclipse using JBoss tools. For general information about how to import a quickstart, add a JBoss EAP server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.
Deploy the Quickstart to OpenShift Online
Use these instructions to deploy the quickstart to Red Hat OpenShift Online. If you do not yet have an OpenShift Online account and are interested in signing up for one, see Choose a Plan in the OpenShift Online documentation located on the Red Hat Customer Portal. For information about running JBoss EAP on Red Hat OpenShift Online, see Getting Started with JBoss EAP for OpenShift Online, also located on the Red Hat Customer Portal.
Create and Deploy the Quickstart Project
Follow these instructions to deploy this quickstart to OpenShift Online.
-
Browse to OpenShift Online console and login with your credentials.
-
On the View All Projects or Welcome to Project page, click Create Project.
-
On the Create Project page, enter the following information:
Name: spring-kitchensink-basic Display Name spring-kitchensink-basic Description: spring-kitchensink-basic
-
Click Create to create the project.
-
On the My Projects page, choose your new spring-kitchensink-basic and click Browse Catalog.
-
Choose JBoss EAP CD (no https) and then click Next to view the Information page.
-
Click Next to navigate to the Configuration page. . . Enter the following information. You can leave the remaining fields as they are.
Add to Project: spring-kitchensink-basic Application Name: spring-kitchensink-basic Custom http Route Hostname: (leave blank) Git Repository URL: https://github.com/jboss-developer/jboss-eap-quickstarts/ Git Reference: openshift Context directory: spring-kitchensink-basic
-
Click the Create button.
-
Click on the Continue to the project overview link.
-
You should see "Build #1 is running …" with the console log below.
Cloning ... Downloading ... Building ... Copying ... Pushing ...
-
At the end of the build, you should see "Push successful".
-
Click View Full Log to see the entire log.
-
-
Click the Overview tab to see the
spring-kitchensink-basic
deployment. -
Click on the application URL on the right side of the page to view the running application. It should be in the following pattern:
http://APPLICATION_NAME-PROJECT_NAME.PORT.HOST.openshiftapps.com
Delete the Quickstart Project
Follow these instructions to delete the project from OpenShift Online.
-
Go to the View All Projects page and select Delete Project from the drop down list to the right of the spring-kitchensink-basic project.
-
Type the name of the project to confirm, and then click Delete
Debug the Application
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