Skip to content

Latest commit

 

History

History
 
 

template

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
pom.xml
pom.xml
 
 

README.md

QUICKSTART_NAME: Brief Description of the Quickstart (try to limit the description to 55 characters)

Author: YOUR_NAME and optional CONTACT_INFO
Level: [one of the following: Beginner, Intermediate, or Advanced]
Technologies: (list technologies used here)
Summary: (A brief description of the quickstart to appear in the table and in Google search SEO results. Try to limit the description to 155 characters )
Prerequisites: (list any quickstarts that must be deployed prior to running this one)
Target Product: (${product.name}, JBoss Mobile, JBoss Data Grid, etc) Official names are here: https://mojo.redhat.com/docs/DOC-962110
Source: (The URL for the repository that is the source of record for this quickstart)

NOTE: This file is meant to serve as a template or guideline for your own quickstart README.md file:

  • The first lines in the file after the quickstart name and description (Author:, Level:, etc.) are metadata tags used by the JBoss Developer site. Make sure you include 2 spaces at the end of each line so they also render correctly when rendered as HTML files.
  • Be sure to replace the QUICKSTART_NAME and YOUR_NAME variables in your README file with the appropriate values.
  • Contributor instructions are enclosed within comments <!-- Contributor: -->. These instructions are only meant to help you and you should NOT include them in your README file!
  • Review the other quickstart README files if you need help with formatting or content.

What is it?

The QUICKSTART_NAME quickstart demonstrates ... in ${product.name.full}.

  • What are the technologies demonstrated by the quickstart?
  • What does it do when you run it?

You should include any information that would help the user understand the quickstart.

If possible, give an overview, including any code they should look at to understand how it works..

System Requirements

The application this project produces is designed to be run on ${product.name.full} ${product.version} or later.

All you need to build this project is ${build.requirements}. See Configure Maven for ${product.name} ${product.version} to make sure you are configured correctly for testing the quickstarts.

Use of ${jboss.home.name}

In the following instructions, replace ${jboss.home.name} with the actual path to your ${product.name} installation. The installation path is described in detail here: Use of ${jboss.home.name} and JBOSS_HOME Variables.

Configure Optional Components

Start the Server

  • Start the ${product.name} Server

  • Start the ${product.name} Server with the Full Profile

  • Start the ${product.name} Server with Custom Options. You will need to provide the argument string to pass on the command line, for example:

    --server-config=../../docs/examples/configs/standalone-xts.xml

Build and Deploy the Quickstart

  1. Make sure you have started the ${product.name} server as described above.

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

  3. Type this command to build and deploy the archive:

     mvn clean install wildfly:deploy

  4. This will deploy target/${project.artifactId}.war (or target/${project.artifactId}.ear) to the running instance of the server.

Access the Application

    Access the running application in a browser at the following URL:  <http://localhost:8080/${project.artifactId}>

    You will be presented with a simple form for adding key/value pairs and a checkbox to indicate whether the updates should be executed using an unmanaged component.

        If the box is checked, the updates will be executed within a session bean method.
        If the box is not checked, the transactions and JPA updates will run in a servlet instead of session beans.

    To list all existing key/value pairs, leave the key input box empty.

    To add or update the value of a key, enter a key and value input boxe and click the submit button to see the results.

Undeploy the Archive

  1. Make sure you have started the ${product.name} server as described above.

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

  3. When you are finished testing, type this command to undeploy the archive:

     mvn wildfly:undeploy

Run the Arquillian Tests (For quickstarts that contain Arquillian tests)

This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.

  1. Make sure you have started the ${product.name} server as described above.

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

  3. Type the following command to run the test goal with the following profile activated:

     mvn clean verify -Parq-remote

You can also let Arquillian manage the ${product.name} server by using the arq-managed profile. For more information about how to run the Arquillian tests, see Run the Arquillian Tests.

Investigate the Console Output

  • If applicable, copy and paste output from the JUnit tests to show what to expect in the console from the tests.

Investigate the Server Log

  • If applicable, copy and paste log messages output by the application to show what to expect in the server log when running the 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 from Eclipse using JBoss tools. For general information about how to import a quickstart, add a ${product.name} server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.

Debug the Application

If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.

mvn dependency:sources