The spring-greeter quickstart is based on the greeter quickstart, but differs in that it uses Spring MVC for Mapping GET and POST requests.

What is it?

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7.1 or later.

The spring-greeter quickstart is based on the greeter quickstart, but differs in that it uses Spring MVC for Mapping GET and POST requests:

  • The mvc:annotation-driven element configured in the src/main/webapp/WEB-INF/spring-mvc-context.xml file tells Spring to look for @RequestMapping in the controllers.

  • Spring then routes the HTTP requests to the correct methods in CreateController.java and GreetController

Spring’s XML configurations are used to get hold of the database and entity manager (via jndi) to perform transactional operations:

  • The tx:jta-transaction-manager and tx:annotation-driven elements are configured in the /src/main/webapp/WEB-INF/spring-business-context.xml file.

  • Methods in UserDaoImpl are marked as @Transactional, which Spring, using aspect oriented programming, surrounds with boilerplate code to make the methods transactional

When you deploy this example, two users are automatically created for you: emuster and jdoe. This data is located in the src/main/resources/init-db.sql file.

To test this example:

  1. Enter a name in the username field and click on Greet!.

  2. If you enter a username that is not in the database, you get a message No such user exists!`.

  3. If you enter a valid username, you get a message "Hello, " followed by the user’s first and last name.

  4. To create a new user, click the Add a new user link. Enter the username, first name, and last name, and then click Add User. The user is added and a message displays the new user ID number.

  5. Click on the Greet a user! link to return to the Greet! page.

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

  1. Open a terminal and navigate to the root of the JBoss EAP directory.

  2. Start the JBoss EAP server with the default profile by typing the following command.

    $ EAP_HOME/bin/standalone.sh 
    Note
    For Windows, use the EAP_HOME\bin\standalone.bat script.

Build and Deploy the Quickstart

  1. Make sure you start the JBoss EAP server as described above.

  2. Open a terminal and navigate to the root directory of this quickstart.

  3. Type the following command to build the artifacts.

    $ mvn clean package wildfly:deploy

This deploys the spring-greeter/target/spring-greeter.war to the running instance of the server.

You should see a message in the server log indicating that the archive deployed successfully.

If you do not have Maven configured you can manually copy target/spring-greeter.war to EAP_HOME/standalone/deployments/ directory.

Access the application

The application will be running at the following URL: http://localhost:8080/spring-greeter/

Undeploy the Quickstart

When you are finished testing the quickstart, follow these steps to undeploy the archive.

  1. Make sure you start the JBoss EAP server as described above.

  2. Open a terminal and navigate to the root directory of this quickstart.

  3. Type this command to undeploy the archive:

    $ mvn wildfly:undeploy

Or you can manually remove the application by removing spring-greeter.war from the EAP_HOME/standalone/deployments/ directory.

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.

  1. Start the JBoss EAP server as described above.

  2. Build the quickstart archive.

    1. Open a terminal and navigate to the root directory of this quickstart.

    2. Build the quickstart archive using the following command:

      $ mvn clean package
  3. Navigate to the functional-tests/ directory in this quickstart.

  4. Type the following command to run the verify goal with the arq-remote profile activated.

    $ mvn clean verify -Parq-remote
Note

You can also let Arquillian manage the JBoss EAP server by using the arq-managed profile, meaning the tests will start the server for you. This profile requires that you provide Arquillian with the location of the JBoss EAP server, either by setting the JBOSS_HOME environment variable, or by setting the jbossHome property in the arquillian.xml file. For more information, see Run the Arquillian Tests.

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.

  1. Browse to OpenShift Online console and login with your credentials.

  2. On the View All Projects or Welcome to Project page, click Create Project.

  3. On the Create Project page, enter the following information:

    Name:  spring-greeter
    Display Name spring-greeter
    Description: spring-greeter
  4. Click Create to create the project.

  5. On the My Projects page, choose your new spring-greeter and click Browse Catalog.

  6. Choose JBoss EAP CD (no https) and then click Next to view the Information page.

  7. 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-greeter
    Application Name: spring-greeter
    Custom http Route Hostname: (leave blank)
    Git Repository URL: https://github.com/jboss-developer/jboss-eap-quickstarts/
    Git Reference: openshift
    Context directory: spring-greeter
  8. Click the Create button.

  9. 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.

  10. Click the Overview tab to see the spring-greeter deployment.

  11. 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.

  1. Go to the View All Projects page and select Delete Project from the drop down list to the right of the spring-greeter project.

  2. 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