forge-from-scratch quickstart demonstrates how to create a fully Java EE compliant project using JBoss Forge and Red Hat JBoss Developer Studio 9.1 or later and deploy it to Red Hat JBoss Enterprise Application Platform 7 or later.
Once generated, the sample project will be a standard Maven 3, Java Web project with JPA, EJB, CDI, JSF with complete JAX-RS endpoints for all data Entities. It will also provide views to Create, Read, Update, and Delete records.
But that is not all! You can use Forge on your new or existing projects to continue to enhance any application.
Note: This quickstart uses the H2 database included with Red Hat JBoss Enterprise Application Platform 7. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment!
The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7 or later.
All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Red Hat JBoss Developer Studio 9.1 or greater. This version of JBoss Developer Studio embeds Maven 3.3.3, so you do not need to install it separately.
JBoss Developer Studio 9.1 ships with Forge 3.0.1.Final. Because the Forge syntax changed in Forge 3.0, the
generate.fsh script that ships with this quickstart was updated to use the new syntax and no longer works with previous releases of JBoss Developer Studio. For this reason, you must use JBoss Developer Studio 9.1 or greater to run this example.
Forge ConsoleWindow. To open it, navigate to menu item Window -> Show View -> Other. Locate Forge -> Forge Console and click OK.
In the Forge Console Window, navigate to the root directory of this quickstart.
$ cd QUICKSTART_HOME/forge-from-scratch/
Notice there is a file in this directory named
generate.fsh. Run this file from the Forge console using the
$ run generate.fsh
$ project-new --named forge-example --top-level-package org.example;
***SUCCESS*** Project named 'forge-example' has been created.
User Operation is waiting for "Importing Forge project" to complete..
***SUCCESS***messages, you see
***SUCCESS*** Build Successnear the end of the console output.
Note: After you run the
run generate.fsh command, you will see the following warnings for the generated files. You can ignore these warnings.
The serializable class Address does not declare a static final serialVersionUID field of type long The serializable class Customer does not declare a static final serialVersionUID field of type long The serializable class Item does not declare a static final serialVersionUID field of type long The serializable class ProductOrder does not declare a static final serialVersionUID field of type long The serializable class Profile does not declare a static final serialVersionUID field of type long The serializable class ZipCode does not declare a static final serialVersionUID field of type long location references to "/faces/error.xhtml" that does not exist in web content
This quickstart created a native Java EE 7 application.
QUICKSTART_HOME/forge-from-scratch/folder. You see a folder with the name
Project Explorerview in JBoss Developer Studio.
Run on Server. If you have more than one server, choose the JBoss EAP 7 Runtime server. Then click
Note: You will see the following warnings in the server log. You can ignore these warnings.
HHH000059: Defining hibernate.transaction.flush_before_completion=true ignored in HEM HHH000431: Unable to determine H2 database version, certain features may not work
The application appears in a 'Welcome to Forge' Window and displays the following:
Welcome to Forge Your application is running.
The following entities are displayed on the lower left side of the page:
When you click on an entity, you are provided with a form that allows you to:
The running application also provides links to find more information about the Forge.
When you are ready to undeploy the application from JBoss EAP:
forge-exampleproject created by this quickstart, right-click, and choose
OK when asked if you are sure you want to remove resource from the server. You should see the following message:
INFO [org.jboss.as.server] (DeploymentScanner-threads - 1) WFLYSRV0009: Undeployed "forge-example.war" (runtime-name: "forge-example.war")
generate.fsh and take a look inside! There is not much magic happening here. All of the commands used to generate this project are clearly listed just as if they were typed by your own hands.
Play around with creating more entities, relationships, UI, and generating JAX-RS endpoints,all with just a few simple commands.