-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat JBoss Developer Studio
Getting Started with JBoss Developer Studio Tools
Introduction to Using Red Hat JBoss Developer Studio Tools
Misha Husnain Ali
mhusnain@redhat.com
Supriya Bharadwaj
sbharadw@redhat.com
devtools-docs@redhat.com
Abstract
Chapter 1. Setting Up and Managing a Repository for Your Projects
1.1. Using Git with Red Hat JBoss Developer Studio
The IDE includes the Git Perspective to allow developers to create, add, and manage their Git repositories quickly and easily with a graphical interface. This article introduces the basic workflow of a Git project and how to accomplish the most common Git-related tasks via the Git perspective. Common Git-based tasks include:
1.1.1. Setting Up the Git Perspective
Use the following instructions to locate the Git Perspective in the IDE:
- In the menu bar at the top of the page, click Window → Perspective → Open Perspective → Other.
-
From the list of available perspectives, select
Git
and clickOK
.
Result: The Git Repositories
view appears on the upper left side of the window.
1.1.2. Setting up a Repository in the Git Perspective
The first step to using the Git Perspective in the IDE is to set up a Git repository. There are three ways to set up a Git repository in the Git Perspective:
The most common use case for developers is to clone an existing repository, or import an existing local clone of a repository into the IDE. However, the first option is an easy way to create a full repository (bare or normal) from scratch.
1.1.3. Creating a New Git Repository
If a repository is not already created and available, use the following steps to create a new repository:
Click the
Create a new Git Repository and add it to this view
button.Figure 1.1. Click the Create a New Git Repository Button
In the dialog box:
-
Ensure that the automatically populated default value for the
Repository Directory
field is correct. Optionally, if required, check the
Create a bare repository
to create a new bare repository. For details about bare repositories and how they differ from a normal repository, see the Did You Know? section.Figure 1.2. Create a New Git Repository
Result: A new git repository is created on your local machine and is listed in the
Git Repositories
view.
-
Ensure that the automatically populated default value for the
1.1.4. Cloning an Existing Git Repository
If your repository already exists online (for example, in GitHub), use the following steps to create a local clone:
- Ensure that you have forked the repository online. This option is available in the repository host’s website.
Click the
Clone a Git Repository and add the clone to this view
button.Figure 1.3. Click the Clone a Git Repository Button
Enter the details of the source repository as follows:
-
Add the
URI
for the repository’s online source. This automatically populates theHost
andRepository Path
fields. -
Add your username and password for the source repository under the
Authentication
details. Click
Next
to continue.Figure 1.4. Enter the Source Repository Details
-
Add the
Customize the local version of your Git repository as follows:
-
Confirm that the automatically populated information for the destination
Directory
andInitial Branch
are correctly populated. -
Optionally, set a non-default name for the
Remote name
field. Optionally, select the
Add project to working sets
option and use the drop down menu and theSelect
button to select the appropriate working sets for this repository.Figure 1.5. Customize the Local Version of the Git Repository
-
Click
Finish
to conclude cloning an existing Git repository.
-
Confirm that the automatically populated information for the destination
Result: The new cloned repository is listed in the Git Repositories
view.
1.1.5. Adding an Existing Local Git Repository
If you have already cloned a Git repository locally, the following instructions are necessary to add your Git repository to the IDE. If you have not yet cloned your repository, follow the instructions in the prerequisites section below:
1.1.5.1. Prerequisites
- Ensure that you have forked the repository online.
In the command line on your local system, navigate to the location where you want to store the local copy of the repository and enter the following command to clone the repository:
$ git clone ${repo_URL}
1.1.6. Adding an Existing Git Repository
Use the following instructions to add your existing local Git Repository to JBoss Developer Studio’s Git Perspective:
Click the
Add an existing local Git Repository to this view
button.Figure 1.6. Click the Add an Existing Local Git Repository Button
Select the local Git Repository as follows:
-
Click
Browse
to navigate to the local directory that contains the Git repository. -
Optionally, select the
Look for nested repositories
checkbox to search for nested repositories. In the
Search results
box, ensure that the appropriate .git file is selected.Figure 1.7. Find and Add Local Repository
-
Click
Finish
.
-
Click
Result: The local repository now appears in the Git Repositories
view.
1.1.7. Adding a Remote for the Repository
After setting up your repository for the first time, set up a remote for repository. This is a one-time set up step for newly created or added repository.
-
In the
Git Repositories
view, expand the target repository. -
From the expanded options, right-click
Remotes
and thenCreate Remotes
. In the
New Remote
dialog box:-
Add a name in the
Remote name
field. -
Ensure that the
Configure Push
radio button is selected. -
Click
OK
to continue.
-
Add a name in the
In the
Configure Push
dialog box:-
Click
Change
to view theSelect a URI
dialog box. -
Add the URI to your repository in the
URI
field. This automatically populates theHost
andRepository path
fields. -
Add your repository username and password in the
Authentication
section of the dialog box and clickFinish
to continue.
-
Click
-
Click
Save
to save your push configuration settings.
Result: Expand the Remotes
folder in the repository view to see the newly added remote.
1.1.8. Creating and Working With a New Branch
This section provides instructions for creating a new branch and common tasks with the new branch, such as:
1.1.9. Creating a New Branch
If your repository is already set up in the IDE, create a new branch to make changes to the files.
In the
Git Repositories
view:- Expand the name of your Git Repository.
-
Click
Branches
to expand the branch view. -
Click
Remote Tracking
to view all remote branches for the repository. A branch displays with a name that begins with origin/master. Right-click this branch and select
Create Branch
from the displayed options.Figure 1.8. Create a Branch from Origin/Master
Add the required details about the new branch:
-
Add the desired new branch name in the
Branch name
field. -
Ensure that the
Configure upstream for push and pull
checkbox is selected. -
In the
When doing a pull
options, select the option that suits your requirement. TheMerge upstream commits into local branch
option creates commits when a merge occurs. These commits are included in the subsequent pull request. TheRebase commits of a local branch onto upstream
option performs a rebase before adding your changes, which prevents additional commits in your pull request. Ensure that the
Checkout new branch
check box is selected.Figure 1.9. Add Details for a New Branch
-
Click
Finish
to create the new branch.
-
Add the desired new branch name in the
Result: The new branch appears under Repository_Name → Branches → Local.
1.1.10. Working in the New Branch
After creating a new branch, you can implement changes in the new branch as follows:
- Expand Repository_Name → Branches → Local and find the new branch where changes are to be implemented.
Confirm that the target branch is checked out. The currently checked-out branch displays a small black check mark:
Figure 1.10. An Example of a Checked-out Branch
Right-click on the checked-out branch name and mouse-over the
Show In
option in the menu and then clickTerminal
in the submenu.Figure 1.11. The Show Branch in Terminal Option
On the right view, a
Terminal
tab appears. In the same row, click the icon that resembles a computer monitor to view the command line prompt in this view.Figure 1.12. The Open a Terminal Button
In the
Launch Terminal
dialog box:-
Ensure that Local Terminal is selected in the
Choose a Terminal
drop-down box. -
Select Default (ISO-8859-1) in the
Encoding
box. -
Click
OK
. Note that as a default, the terminal window is at the /home/YourCurrentUser/ directory.
-
Ensure that Local Terminal is selected in the
Result: The Terminal
tab now displays a command line terminal. Use the terminal view to make the required changes to your checked-out files.
1.1.11. Updating the Branch Before Implementing Changes
When working locally on a branch, it is better to ensure the local branch is up to date before creating a pull request (PR). As an example, if someone else has checked out the same repository and created a new branch, made changes, and merged the changes, use the following procedure to update your repository and branch before committing your own changes.
In the example below, a new branch called TrackingID-1234 is created using the IDE. Assuming that someone else is working on the same repository and has created a new branch called NEWBRANCH, made changes to it, and then merged the changes back into the repository. The local branch (TrackingID-1234) is now out of date because it does not include the changes from NEWBRANCH. Use the following instructions to update the branch:
- Right-click the name of the repository to update.
-
From the menu that displays, click
Pull
. - A status menu appears that displays the progress of the pull request.
-
When the pull completes, a
Pull Result for Repository_Name
menu appears that lists the results of the fetch and update operations. -
Click
OK
to conclude the operation.
Result: The repository now contains the most updated version of the contents.
1.1.12. Commiting and Merging Changes
After all required changes are complete, commit the changes and then create a Pull Request. Pull Requests are then evaluated by the repository owner and either merged into the repository or rejected.
-
Ensure that the black and white tick mark that indicates the current branch appears at the correct working branch in the
Local
folder of your repository view. -
Right-click the name of the repository. In the displayed menu, click the
Commit
option. In the
Commit Changes
dialog box:-
Add a commit message describing the changes in the
Commit message
text box. -
Confirm that the automatically populated
Author
andCommitter
fields contain the correct name and email address. In the
Files
area, all files added using the git add command display in the box. Select the checkbox next to each file to include it in the commit. See the Did You Know? section to learn about only including some of the changed files in a commit.Figure 1.13. Add details to the Commit Changes Dialog Box
-
Click
Commit
to create a new commit (without creating a Pull Request) or clickCommit and Push
to commit the changes and create a Pull Request at the same time.
-
Add a commit message describing the changes in the
1.1.13. Committing Without Pushing the Changes
If you selected Commit
in the previous procedure to commit changes but not push them, use the following instructions:
When the operation completes, the repository is now ahead by one commit. This is represented with an arrow and the number one:
Figure 1.14. Git Repository Status
-
When you are ready to create a Pull Request, right click the current branch name and click
Push Branch
. -
An automatically populated
Push Branch Branch_Name
dialog box appears. Confirm that the settings are correct. The settings selected when creating this branch are used for this step. ClickNext
to continue. - A dialog box appears requesting the repository access username and password.
-
A
Push Confirmation
dialog box appears. ClickFinish
to create the Pull Request. If requested, supply the username and password for the repository once again. -
When the operation completes, a
Push summary
dialog box appears. ClickOK
to dismiss this dialog box.
Result: The included changes are now committed and a Pull Request is generated for the repository owner to review.
1.1.14. Committing and Pushing the Changes
If you selected Commit and Push
in the previous procedure, use the following instructions:
- A dialog box appears requesting the repository access username and password.
When the operation completes, the repository is now ahead by one commit. This is represented with an arrow and the number one:
Figure 1.15. Git Repository Status
-
After the Pull Request is evaluated and merged, right-click the repository and click
Pull
to manually update the repository.
Result: A Pull Request is generating and ready for the repository owner to review.
1.1.15. Did You Know?
-
Bare repositories are recommended for central repositories, but not for development environments. Bare repositories differ from normal repositories because they do not contain a working or checked out copy of any source files. This prevents editing files and committing changes in the repository. Additionally, they store the git revision history for your repository in the repository’s root folder instead of in a
.git
sub-folder. -
When selecting the files to commit in the
Commit Changes
, you can select only the files you want included in the commit using the checkboxes next to each file name. The unchecked files are not included in the commit and no extra actions are required to reconcile the uncommitted files when committing and creating a Pull Request. -
If you need to add a change ID to each commit message, in the
Comming Changes
dialog box, click the rightmost icon at the top right corner to add a change ID to the commit message.
1.2. Configuring Maven Basics
In the context of application development, Maven provides a standardized build system for projects. One of the main benefits of using Maven with your project is that it facilitates fetching dependencies from one or more repositories. This article serves as an introduction to using Maven with the IDE and contains instructions for the following tasks:
Root Maven projects can serve as aggregators for multiple Maven modules, also known as sub-projects. For each module that is part of a maven project, a <module> entry is added to the project’s pom.xml file. A pom.xml that contains <module> entries is often referred to as an aggregator pom.
When modules are included into a project it is possible to execute Maven goals across all of the modules by a single command issued from the parent project directory.
Note that the provided instructions pertain to the creation of a parent+module project structure. If you prefer to create just a simple project, simply start with an archetype or don’t use the pom
packaging in step 2.a
.
1.2.1. Creating a New Maven Project
Use the following instructions to create the parent project of a multi-module Maven project. The instructions provided ensure that the packaging option is set to pom
, which is a requirement for multi-module Maven projects. Alternately, to create a standalone Maven project instead, set the packaging option to an option other than pom
.
Create a new project:
- In the workspace, navigate to File → New → Other.
-
Type
maven
in theFilter
field and selectMaven Project
. -
Click
Next
to continue.
Enter the initial project details:
-
Check the
Create a simple project (skip archetype selection)
check box. If this check box is selected, theSelect an Archetype
step of the wizard is skipped and the project type is set to pom, which is required to create a Maven Module based on this Maven project. Alternately, to create a standalone project, uncheck theCreate a simple project (skip archetype selection)
check box and follow the instructions in the wizard. -
Ensure that the
Use default Workspace location
check box is not checked and specify a non-default location for your workspace files using theBrowse
button. Using a non-default workspace location is recommended because this allows other tools to access the workspace location easily. The following optional steps are available for further configuration, if required:
-
(Optional) Check the
Add project(s) to working set
check box to add the newly created projects to a working set. (Optional) Click
Advanced
to view additional optional advanced configuration for the new Maven project, such as:-
Resolve Workspace projects
: dependencies opened as workspace projects will be resolved without having to install them to your local Maven repository first. This way, any changes made to one of these dependencies will have an immediate effect on other projects consuming it (compilation, refactoring, etc.). WhenResolve Workspace projects
is disabled, dependencies existing in the workspace must be installed to your local Maven repository after any change (by runningmvn install
), in order to see effects in projects consuming them. -
Profiles
: select a set of Maven profiles to activate or deactivate in the workspace. Profiles are defined in the projectpom.xml
, or inherited from a parentpom.xml
, or defined in the relevantsettings.xml
. Name templates
: allows you to disambiguate projects names in the workspace by prepending or appending the group ID or SCM branch names to the default artifact ID.Figure 1.16. Create a New Maven Project
-
-
(Optional) Check the
-
When the configuration is complete, click
Next
to continue.
-
Check the
Configure the project details:
-
Enter the desired group ID, which is similar to an organization namespace (for example, com.company.businessunit.project), in the
Group Id
field. -
Enter the desired artifact ID value, which is the name for your project, in the
Artifact Id
field. This value must not include any spaces and the only special characters allowed are periods ('.'), underscores ('_'), and dashes ('-'). -
Set the
Version
field’s value to0.0.1-SNAPSHOT
or a similar value. For details about the appropriate version build numbers, see Project Versions -
Set the value of the
Packaging
field topom
. -
(Optional) Add a name for your project in the
Name
field. (Optional) Add a description for your project in the
Description
field.Figure 1.17. Configure Project Details
-
Click
Finish
to conclude the new Maven project creation wizard.
-
Enter the desired group ID, which is similar to an organization namespace (for example, com.company.businessunit.project), in the
Result: Your new Maven project is created and appears in the Project Explorer
view.
1.2.2. Creating a New Maven Module
Each Maven project with a packaging pom can include multiple Maven modules. Follow the instructions to create your first Maven module:
1.2.2.1. Prerequisites
- You must have an existing Maven project available with the packaging type pom. See Create a New Maven Project for instructions to create a new Maven project.
1.2.2.2. Creating a New Maven Module
Create a new Maven module as follows:
- In the Project Explorer view, right-click the recently created pom project and select New → Project.
-
From the wizard selection screen, expand
Maven
and selectMaven Module
. -
Click
Next >
to continue.
Enter the initial module details:
-
Ensure that the
Create a simple project (skip archetype selection)
check box is not checked. If this check box is selected, theSelect an Archetype
step of the wizard is skipped. -
Enter the desired module name in the
Module Name
field. This value corresponds to the Maven project’s Project ID. -
Use the
Browse
button to locate the desired parent project and select it. The following optional steps are available for further configuration, if required:
-
(Optional) Check the
Add project(s) to working set
check box to add the newly created projects to a working set. (Optional) Click
Advanced
to view additional optional advanced configuration for the new Maven project, such as:-
Resolve Workspace projects
: dependencies opened as workspace projects will be resolved without having to install them to your local Maven repository first. This way, any changes made to one of these dependencies will have an immediate effect on other projects consuming it (compilation, refactoring, etc.). WhenResolve Workspace projects
is disabled, dependencies existing in the workspace must be installed to your local Maven repository after any change (by runningmvn install
), in order to see effects in projects consuming them. -
Profiles
: select a set of Maven profiles to activate or deactivate in the workspace. Profiles are defined in the projectpom.xml
, or inherited from a parentpom.xml
, or defined in the relevantsettings.xml
. Name templates
: allows you to disambiguate projects names in the workspace by prepending or appending the group ID or SCM branch names to the default artifact ID.Figure 1.18. Set the Module Name and Parent
-
-
(Optional) Check the
-
When the configuration is complete, click
Next
to continue.
-
Ensure that the
Enter the module archetype information:
-
Ensure that the
Show the last version of Archetype only
check box is checked. This ensures that only the latest version of each archetype displays. Select an archetype based on the purpose of the project you are creating. Use the keyword maven-archetype-quickstart in the
Filter
field to locate a sample Maven project archetype.Figure 1.19. Select a Module Archetype
- Click Next to continue.
-
Ensure that the
Enter the module details:
-
Add the same group ID value that was used for the Maven project to the
Group Id
field. -
Add the desired version number in the
Version
field. For details about the appropriate version build numbers, see Project Versions The
Artefact Id
andPackage
fields are automatically populated based on the parent project details.Figure 1.20. Configure the Module Archetype Parameters
-
Click
Finish
to conclude setting up the Maven module.
-
Add the same group ID value that was used for the Maven project to the
(Optional) To change the settings for the created Maven module, expand the module name in the
Project Explorer
view and double clickpom.xml
from the expanded list. AnOverview
tab appears and all settings can be changed from this tab.Figure 1.21. Change the Module Settings from the Overview View
Result: Your new Maven module is created and appears in the
Project Explorer
view. Additionally, a hierarchical view of the nested projects is now available in the Project Explorer view as well (see Nested/Hierarchical view of projects).
1.2.3. Adding Maven Support to an Existing Non-Maven Project
The previous tasks contain instructions to create a new Maven project and Maven module. However, for an existing application that was not created with Maven support, use the following instructions to add Maven support to the non-Maven project:
-
Right-click the project name in the
Project Explorer
view. -
From the displayed options, click
Configure
. -
From the displayed sub-menu, click
Convert to Maven Project
. Configure details for the new pom file:
- The basic fields for the new pom file are prepopulated based on the project details. If required, edit the existing values.
-
(Optional) Add a name for the new project in the
Name
field. (Optional) Add a brief description for the project in the
Description
field.Figure 1.22. Create a New Pom Descriptor
-
Click
Finish
to finalize the pom information.
- If the project references java dependencies, a wizard appears displaying all these dependencies and a green check mark when each dependency is identified. Learn more about dependency identification in the Did You Know section.
Check the
Delete original references from project
check box to avoid retaining duplicate or stale dependencies in your project.Figure 1.23. Identify Maven Dependencies
-
Click
Finish
when all dependencies are converted.
Result: The existing project is now configured for Maven support.
1.2.4. Did You Know?
The wizard used to convert a non-Maven project to a Maven project attempts to identify all the project’s classpath entries and their equivalent Maven dependencies. From the list of identified dependencies, users can select which ones will be added to the generated Maven pom.xml file. When identifying dependencies, one of several strategies may be used:
- Checking if the jar contains the relevant maven metadata.
- Identify the dependency using the Nexus indexer.
- Identify the dependency using the JBoss Nexus instance REST API (if we are online) via a SHA1 search.
-
Identify the dependency using the
search.maven.org
REST API (if we are online) via a SHA1 search.
-
All unchecked dependencies will be ignored and are not added to the generated
pom.xml
. However, some of these can be added as transitive dependencies to your project. For instance, if you addjsp-api
but removeservlet-api
, the latter appears in the project classpath, as it is a dependency ofjsp-api
. -
You can double-click on a dependency from a list (or click the
Edit
button) to edit its Maven coordinates or scope. Selecting several dependencies (ctrl+click) and clicking theEdit
button allows batch editing of their scope.
1.2.5. Troubleshooting
Error Message:
Unidentifiable Dependency
in theMaven Dependency
column.Figure 1.24. Unidentifiable Dependency
Issue: Either:
- the jar file is corrupted/invalid.
- the jar file is valid but does not contain any metadata used for identification.
Resolution:
-
Make sure that jar exists as a Maven artifact. If needed, you can install it to your local repository and then Click on the
Identify dependencies
button. -
Double click on the dependency, or click on the
Edit…
button and set the expected maven coordinates.
-
Make sure that jar exists as a Maven artifact. If needed, you can install it to your local repository and then Click on the
Error Message: Some selected dependencies can not be resolved. Click here to configure repositories in your settings.xml.
Figure 1.25. Dependencies Can Not Be Resolved Error
- Issue:: This error displays when a dependency can be identified (that is, whether it contains the pom properties or other metadata) but the dependency is not available in any repository defined in your settings.xml.
-
Resolution: Click the
here
link in the error message and compare the old and new settings for the dependency and add a new and correct repository. Users may choose to use one of the predefined repositories from Red Hat.
Chapter 2. Developing First Applications with JBoss Developer Studio Tools
2.1. Configuring JBoss Developer Studio for use with JBoss EAP and JBoss Web Framework Kit
This article provides details for new and existing users who need to configure a fresh install of the IDE or upgrade the versions of Red Hat JBoss Enterprise Application Platform or JBoss Web Framework Kit in use.
The IDE supports application development and deployment with JBoss EAP and JBoss Web Framework Kit only after you configure the IDE for use with JBoss EAP and JBoss Web Framework Kit. This configuration is essential for using the enterprise versions of the example Maven projects provided in JBoss Central. These projects are intended for deployment to JBoss EAP and necessitate IDE access to the JBoss EAP and JBoss Web Framework Kit Maven repositories.
Instructions are provided for the following tasks:
- Setting up JBoss EAP for use in the IDE in one of three different ways
- Configuring Maven for JBoss EAP and JBoss Web Framework Kit Maven repositories
2.1.1. Setting Up JBoss EAP
To set up JBoss EAP for use in the IDE, you must direct the IDE to the local or remote runtime servers. This establishes a communication channel between the IDE and the JBoss EAP server for efficient deployment and server management workflows. Depending on your circumstance, you can set up the JBoss EAP server in one of three ways:
- If you are installing a new instance of the IDE, you can use the combined installer to download, install, and set up the IDE and JBoss EAP.
- If you already have the IDE installed but not JBoss EAP, you can download, install, and set up JBoss EAP from within the IDE.
- If the IDE and JBoss EAP are already installed, you can use runtime detection to set up JBoss EAP from within the IDE.
2.1.2. Downloading, Installing and Setting Up the IDE and JBoss EAP using a Single Installer
If you are installing a new instance of the IDE, you can use the combined installer to download, install, and set up the IDE and JBoss EAP. A specific JBoss EAP version is packaged in the installer; for details of the JBoss EAP version see https://access.redhat.com/site/articles/427493
.
Note:
If you want to install a different version of JBoss EAP, you can either download it from within the IDE (see download, install, and set up JBoss EAP from within the IDE) or install it separately and then follow the instructions in C,use runtime detection to set up JBoss EAP from within the IDE.
To install the IDE and JBoss EAP using a single installer:
-
Log onto the Red Hat Customer Portal at
https://access.redhat.com
. - Locate the downloads for versions of the IDE greater than or equal to 9.x.
-
Download the installer
.jar
file. -
On the command line, navigate to the downloaded installer
.jar
file and enter:java -jar jboss-devstudio-version-installer-eap.jar
where version is the version of the .jar file. -
In the
Red Hat JBoss Developer Studio
wizard, clickNext
. -
In the
End User License Agreement
window, read the terms of the End User License Agreement, clickI accept the terms of this license agreement
, and then clickNext
. -
In the
Select Target Folder
window, clickBrowse
to select the location to install and clickNext
. -
When you are prompted about the specified location being created (or overwritten), review the message and, if satisfied, click
OK
(orYes
). In the
Select Java VM
window, select the appropriate option for your Java VM preference and then clickNext
:-
To select the default Java VM that is listed in the disabled field below, click
Default Java VM
. -
To select a different Java VM, click
Specific Java VM
and then clickBrowse
to locate the Java VM.
-
To select the default Java VM that is listed in the disabled field below, click
In the
Select Platforms and Servers
window, with reference to installing JBoss EAP, clickYes, and have it ready for use in JBoss Developer Studio
and clickNext
.Figure 2.1. Select Platforms and Servers Window Confirming Installation
-
Review the information in the
Summary Information
window and clickNext
. -
The
Installation
window opens showing the installation progress. Once the installation is complete clickNext
. -
In the
Setup Shortcuts
window, click the desired shortcut options and clickNext
. -
In the
Finish
window, clickDone
to complete the installation. The IDE starts. -
In the
Workspace Launcher
window, in theWorkspace
field type the path for a new or existing workspace or clickBrowse
to navigate to a workspace and clickOK
. - When prompted to allow Red Hat to receive anonymous usage statistics, select the appropriate option.
-
Click
Get started with JBoss Central
to begin working.
Result:
The server is listed in the Servers
view in stopped mode.
2.1.3. Downloading, Installing and Setting Up JBoss EAP from within the IDE
If the IDE is already installed, you can download, install, and set up JBoss EAP from within the IDE. With this option, you can choose from a range of supported JBoss EAP versions; for details of supported JBoss EAP versions see https://access.redhat.com/site/articles/427493
.
To download, install and set up JBoss EAP from within the IDE:
- Start the IDE.
-
Click
Window
→Preferences
, expandJBoss Tools
, and then clickJBoss Runtime Detection
. -
In the
Paths
pane, clickDownload
. In the
Download Runtimes
window, from theDownload Runtimes
table select the JBoss EAP version that you want to download and clickNext
.Note:
For JBoss EAP 6.1.x and later, continue to follow the steps given here. For JBoss EAP 6.0.x and earlier, follow the on-screen instructions for downloading JBoss EAP from the Red Hat Customer Portal and after JBoss EAP is installed continue to use runtime detection to set up JBoss EAP from within the IDE.Figure 2.2. Download Runtimes Window Listing Available JBoss EAP Versions
-
In the
JBoss.org Credentials
window, in theDomain
field, typejboss.org
and then clickAdd
next to theUsername
field. Note that if you do not have a JBoss.org account, you must click the link to sign up. -
In the
Add a Credential
window,Username
field, type your username and in thePassword
field, type the password and clickOK
. -
In the
Download Runtimes
window, clickNext
. -
In the
JBoss.org Terms and Conditions
window, read the terms and conditions, from thePlease choose the country of use
list, select your country of use, and then clickAccept Now
. If you have previously accepted the terms and conditions in the IDE or through the jboss.org website, this window is skipped. -
Click
Next
. -
Read the
General Public License
, clickI accept the terms of the license agreement
, and then clickNext
. -
For the
Install Folder
field, clickBrowse
and choose a location in which to install JBoss EAP and clickFinish
. -
Click
Apply
and clickOK
to close thePreferences
window. The download and installation starts and may take some time to complete.
Result:
The server is listed in the Servers
view in stopped mode.
2.1.4. Using Runtime Detection to Set Up JBoss EAP from within the IDE
If the IDE and JBoss EAP are already installed, you can use runtime detection to set up JBoss EAP from within the IDE. The runtime detection feature automatically identifies the JBoss EAP instance installed on your local system and generates a corresponding default server setup for use in the IDE. This feature makes getting started with a default JBoss EAP server very quick.
Note:
Specific JBoss EAP versions are supported by each IDE release; for details of supported JBoss EAP versions see https://access.redhat.com/site/articles/427493
.
To use runtime detection to set up JBoss EAP for use in the IDE:
- Start the IDE.
-
Click
Window
→Preferences
, expandJBoss Tools
, and then selectJBoss Runtime Detection
. -
Click
Add
. -
Navigate to
path/to/jboss-eap
and clickOK
. JBoss Server Tools recursively scans the path searching for installed servers and displays a list of those it finds. Ensure the
jboss-eap-version
check box is selected, where version denotes the JBoss EAP version, and clickOK
.Figure 2.3. Selecting a Runtime
-
Click
Apply
and clickOK
to close thePreferences
window.
Result:
The server is listed in the Servers
view in stopped mode.
2.1.5. Configuring Maven for JBoss EAP and JBoss Web Framework Kit Maven Repositories
To configure Maven to use the JBoss EAP and JBoss Web Framework Kit Maven repositories when working inside the IDE, you must ensure that the IDE knows the location of your Maven configuration settings.xml
file and that the necessary profiles for the JBoss EAP and JBoss Web Framework Kit Maven repositories are contained in that file. This ensures that Maven knows where to search for project dependencies when it is called to build Maven projects from within the IDE.
2.1.6. Specifying Maven settings.xml File Location
If you have multiple Maven settings.xml
files or you are using a shared settings.xml
file, then this file may not be in the default location expected by the IDE. In this case, you must inform the IDE of the file location.
To specify the Maven settings.xml file location:
- Start the IDE.
-
Click
Window
→Preferences
, expandMaven
, and then clickUser Settings
. -
For the
User Settings
field, clickBrowse
and locate thesettings.xml
file. -
Click
Update Settings
. -
Click
Apply
and then clickOK
.
2.1.7. Using JBoss EAP and JBoss Web Framework Kit Maven Repositories
You can either download the JBoss EAP and JBoss Web Framework Kit Maven repositories from the Red Hat Customer Portal or use the online Maven repository located at https://maven.repository.redhat.com/ga
.
2.1.8. Using the Offline Maven Repositories
If you have not previously used these versions of JBoss EAP and JBoss Web Framework Kit, you must configure your Maven settings.xml
file to use the associated product Maven repositories. You can manually edit your settings.xml
file in a text editor or use the JBoss Developer Studio Maven integration feature to automatically detect the JBoss repositories and appropriately edit your settings.xml
file.
Note:
The JBoss EAP and JBoss Web Framework Kit Maven repositories must be already obtained from the Red Hat Customer Portal and located on a system that you can access.
To specify the JBoss EAP and JBoss Web Framework Kit Maven repositories locations using the IDE:
- Start the IDE.
-
Click
Window
→Preferences
, expandJBoss Tools
, and then clickJBoss Maven Integration
. -
Click
Configure Maven Repositories
. -
Click
Add Repository
. -
Click
Recognize JBoss Maven Enterprise Repositories
. -
Navigate to
path/to/jboss-eap-maven-repository
and clickOK
. JBoss Maven Tools recursively scans the path searching for a Maven repository. Modify the information in the
ID
andName
fields as desired, ensure theActive by default
check box is selected, and then clickOK
.Figure 2.4. Details of the Selected Maven Repository
-
Click
Add Repository
. -
Click
Recognize JBoss Maven Enterprise Repositories
. -
Navigate to
path/to/jboss-wfk-maven-repository
and clickOK
. JBoss Maven Tools recursively scans the path searching for a Maven repository. -
Modify the information in the
ID
andName
fields as desired, ensure theActive by default
check box is selected, and then clickOK
. -
Click
Finish
and at the prompt asking if you are sure you want to update the Maven configuration file clickYes
. If the specified configuration file does not exist, JBoss Maven Tools creates it. -
Click
Apply
and clickOK
to close thePreferences
window.
2.1.9. Using the Online Maven Repositories
Adding the online repository to the IDE, adds https://maven.repository.redhat.com/ga
to your settings.xml
, which takes care of all the dependencies.
To use the online Maven repositories:
- Start the IDE.
-
Click
Window
→Preferences
, expandJBoss Tools
, and then clickJBoss Maven Integration
. -
Click
Configure Maven Repositories
. -
Click
Add Repository
. In the
Profile ID
drop-down list, selectredhat-ga-repository
.Figure 2.5. Add a Maven Repository
-
Click
OK
. -
In the
Configure Maven Repositories
window, clickFinish
. -
Click
Apply
and then clickOK
to close thePreferences
window.
2.2. Creating and Importing Node.js Applications
Node.js is an event-based, asynchronous I/O framework and is used to develop applications that run JavaScript on the client and server side. This allows the application to re-use parts of the code and to avoid switching contexts. Node.js is commonly used to create applications such as static file servers, messaging middleware, HTML5 game servers, web application framework, and others.
JBoss Developer Studio supports node.js application development using the npm package installer and offers a built-in debugging tool to identify and fix issues with applications. In the subsequent sections, instructions are available for the following tasks:
2.2.1. Setting Up Prerequisites for Node.js Development
Ensure that the following prerequisites are met to start developing node.js applications in JBoss Developer Studio:
-
Install npm. On Red Hat Enterprise Linux and Fedora, use the
sudo dnf install npm
command. See the npm documentation (https://docs.npmjs.com/getting-started/installing-node) for installation information about other operating systems. - Install JBoss Developer Studio.
Result: You are now ready to start developing Node.js applications with JBoss Developer Studio.
2.2.2. Creating a new JavaScript Application
To create a new JavaScript project and application in JBoss Developer Studio:
To create a new JavaScript project:
-
Click File → New → Other and type
JavaScript
in the search text box. -
Select
JavaScript Project
and click Next. -
In the
Project Name
field, add a name for your new project. - Ensure that the rest of the fields, which are set to the default settings, are as required, and then click Finish to create the new project.
-
If asked to view the JavaScript perspective, click Yes. Your new project is listed in the
Project Explorer
view.
-
Click File → New → Other and type
To interactively create a
package.json
file:-
Click File → New → Other and then type
npm
in the search box. - From the search results, click npm Init.
- Set the Base directory to your JavaScript project folder in your JBoss Developer Studio workspace.
-
Optionally, clear the
Use default configuration
check box to supply non-default values for these fields. Click Finish to continue with the default values for the
package.json
file or to continue after changing the default values.Figure 2.6. Generate a New package.json File
The new
package.json
file is generated and displayed for editing. If required, manually edit the file in the displayed pane and save the changes.Figure 2.7. Manually Edit the Generated package.json File
-
Click File → New → Other and then type
Manually edit the
package.json
file to add dependencies. Dependencies are modules which provide extended functionality, such as libraries and frameworks. See the following screen capture for an example of the required format for dependencies and developer dependencies.Figure 2.8. Adding Dependencies to the package.json File
For further details about dependencies, see the NPM documentation: https://docs.npmjs.com/files/package.json#dependencies
Create a new JavaScript file with the required business logic:
-
In the
Project Explorer
view, right-click the name of your project, and select New → File. -
In the dialog box, add a name for the new file, for example
index.js
, and click Finish to create the new file. - The new file displays for editing in a new tab. Add the required business logic to the your JavaScript files and save the changes.
-
In the
-
Run the project files by right-clicking the
index.js
file in your project and select Run As → Node.js Application. TheConsole
view appears and displays details about the application as it runs, or errors if it is unable to run the application.
Result: You have created a new JavaScript project and application.
2.2.3. Importing an Existing JavaScript Project
You can import an existing JavaScript project directly into JBoss Developer Studio and then make changes and run the project as follows:
Import an existing project into JBoss Developer Studio:
- Click File → Import.
-
In the
Import
dialog box, expand the General option. - Click Existing Projects into Workspace and then click Next.
In the
Import Projects
dialog box:-
Click either the
Select root directory
orSelect archive file
options based on your project format. - Click Browse to add the path to the project root directory or archive file.
-
In the
Projects
box, select one or more projects to import into the workspace. -
If required, click the
Search for nested projects
option to locate nested projects in the root directory or archive file. -
Click the
Copy projects into workspace
option to save a copy of the imported project in the workspace directory specified for JBoss Developer Studio. -
If required, select the
Add project to working sets
checkbox and add the details for a new or existing working set. -
Click Finish to add the project to the workspace. The
Project Explorer
view now contains your imported project.
-
Click either the
-
If required, expand the project in the
Project Explorer
view and either double-click the project files to edit them, or right-click and select New → File to add a new JavaScript file for your project. -
Run the project files by right-clicking the
index.js
file in your project and click Run As → Node.js Application. TheConsole
view appears and displays details about the application as it runs, or errors if it is unable to run the application.
Result: You have imported an existing JavaScript project into JBoss Developer Studio.
2.2.4. Debugging Node.js Applications
After either creating a new Node.js project or importing an existing one and then running the project, some errors may appear. JBoss Developer Studio includes a debugger to help identify and resolve these issues. To use the debugging feature:
Start the debugger for your project:
-
In the
Project Explorer
view, expand your project. -
Right-click the
index.js
file for your project and click Debug As → Node.js Project. -
Select the
Remember my decision
check box in the dialog box to apply your selection to subsequent perspective shifts and then click Yes or No to continue.
-
In the
Review the elements of your project’s JavaScript files to locate errors in one of two ways:
-
Expand any variable listed in the
Variables
tab to view additional objects and edit the details for each item. -
Hover the mouse cursor over any variables in the
index.js
tab to view and edit its property details.
-
Expand any variable listed in the
Make changes to the files to address the errors:
-
Edit the
index.js
file in the appropriate view. -
Save the changes. The
Console
view runs the updated file and displays changes.
-
Edit the
After debugging the errors, use the Resume, Suspend, and Terminate buttons ( ) as follows to test your changes:
- The Resume button (green triangle) continues running the project files.
- The Suspend button (two yellow rectangles) temporarily stops running the project files to allow users to make changes.
- The Terminate button (red square) ends the running of the project files.
- Repeat steps 4 through 6 as necessary to locate and fix errors found by the debugger.
-
When debugging is concluded, click Window → Show View → Other and select
Project Explorer
from the options. This displays the list of projects again.
Result: You have debugged your application and returned to the Project Explorer
view.
2.3. Developing Applications Using the Forge Tool
Red Hat JBoss Developer Studio offers Forge Tools for developing Java EE applications and to extend the IDE functionality in Eclipse. Start developing Java EE applications using either the Forge context menu or the command line from the IDE.
2.3.1. Creating a New Project
After you have created a Forge project you can set up persistence, add entities and fields, and create scaffold for the project.
To create a new project:
- Press Ctrl+4 to start Forge and open the JBoss Forge context menu.
-
Click
Project:New
to open theCreate a new project
window. In the
Create a new project
window:-
In the
Project name
field, type a project name. -
In the
Top level package
field, type{com.example}
as the top package. -
In the
Project location
field, enter a target location for the Forge project. -
In the
Stack
list, clickJava EE 7
.
-
In the
-
Click
Finish
.
Figure 2.9. Create a New Forge Project
Result: The project is listed in the Project Explorer
view.
2.3.2. Setting Up Persistence
Setting up the JPA prerequisites, creates the persistence.xml file in the project and adds the required dependencies to the pom.xml file.
Note:
While creating the JPA entity, the Forge console automatically detects any prerequisites that must be set up and prompts you to create those at runtime.
To set up persistence:
- Press Ctrl+4 to open the JBoss Forge context menu.
-
Click
JPA: New Entity
. The window is populated with default values. -
Click
Next
to continue using the default values or edit the fields to change the values. -
In the
Configure your connection settings
window, ensure that the fields display the appropriate values and then clickNext
. In the
Create a new JPA entity
window:-
In the
Package Name
field, type the package name. -
In the
Type Name
field, type a name for the new entity.
-
In the
-
Click
Finish
.
Result
: The new entity appears in the JBoss editor and is also listed in the Project Explorer
view with the name: .java
.
Figure 2.10. .java Displayed in the JBoss Editor
2.3.3. Adding Fields to the Entity
To add fields to the entity:
- Press Ctrl+4 to open the JBoss Forge context menu.
-
Click
JPA: New Field
. In the
Create a new field
window:-
In the
Target Entity
field, select{package_name.model.entity}
. -
In the
Field Name
field, typeFirstName
.
-
In the
Click
Finish
.Figure 2.11. Add Field to the Entity
- Repeat steps 1 through 4 to add more fields to the entity.
Result: The fields are added to the Customer.java file.
2.3.4. Creating a Scaffold
Scaffolding is automatic code generation by a program, using available information, usually a database to generate a basic CRUD (create, read, update, delete) admin interface. The Scaffold Generate
command is used to create the scaffold.
To create the scaffold:
- Press Ctrl+4 to open the JBoss Forge context menu.
-
Click
Scaffold Generate
. -
In the
Scaffold Type
list, clickAngular JS
and then clickNext
. -
If your project is not configured to use all the technologies that you want to use, Forge prompts you to set up the dependencies. Click
Next
. In the
Select JPA entities
window:-
Select the check box in the
Targets
field. -
Select the
Generate REST resources
check box.
-
Select the check box in the
-
Click
Finish
.
Figure 2.12. Select JPA Entities to Create the Scaffold
Result: The entities are created and listed in the Project Explorer
view.
2.3.5. Running and Testing the Application
In this example we use the JBoss EAP server to run the application.
To run the application:
-
In the
Project Explorer
view, right-click the application and clickRun As
→Run on Server
. Alternatively, drag and drop the application from theProject Explorer
view to theJBoss EAP 1
server in theServers
view. The application opens in the default browser. -
Click
Customers
and then clickCreate
to create a new customer. -
In the
FirstName
and theLastName
fields, enter the first and last names and clickSave
. The customer is added to the application.
Use the Search for Customers
section to search for customers by their first and/or last names.
2.3.6. Creating Extensions or Add-ons
The add-ons/extensions run inside the IDE. After adding commands and features to the add-on, no further changes are required for the extensions or add-ons to run in another IDE.
To create an add-on:
- Press Ctrl+4 to open the JBoss Forge context menu.
-
Click
Project:New
. In the
Create a new project
window:-
In the
Project name
field, type a name for the add-on. -
In the
Project type
list, clickForge Addon (JAR)
.
-
In the
-
Click
Next
. -
In the
Furnace Addon Setup
window,Depend on these addons
section, Forge automatically selects the prerequisites. Review the dependencies and clickFinish
. - Press Ctrl+4 to open the Forge context menu.
-
Select
Java: New Class
to open theJava: New Class
window. -
In the
Type Name
field, typeCustomCommand
and clickFinish
. The CustomCommand.java file opens in the JBoss editor. To change this Java class into a Forge command:
- Press Ctrl+4 to open the Forge context menu.
-
Select
Addon: New UI Command
to open theGenerates a UICommand implementation
window. In the
Generates a UICommand implementation
window:-
In the
Type Name
field, typeCustomCommand
. -
In the
Command name
field, typecustom
.
-
In the
Click
Finish
.Figure 2.13. Add a Command
The command is listed in the CustomerCommand.java file.
- Press Ctrl+4 to open the Forge context menu.
-
Select
Build and Install an Addon
to open theBuild and install a Forge addon
window. -
Click
Finish
to install the add-on into the IDE. To execute the installed command:
- Press Ctrl+4 to open the Forge context menu.
-
Select
custom
. Add parameters to the method in order to add user input to the command. Copy and paste the following command in the CustomCommand.java file:
package org.jboss.forge.addon.commands; import org.jboss.forge.addon.configuration.Configuration; import org.jboss.forge.addon.resource.URLResource; import org.jboss.forge.addon.ui.command.AbstractUICommand; import org.jboss.forge.addon.ui.context.UIBuilder; import org.jboss.forge.addon.ui.context.UIContext; import org.jboss.forge.addon.ui.context.UIExecutionContext; import org.jboss.forge.addon.ui.input.UIInput; import org.jboss.forge.addon.ui.metadata.UICommandMetadata; import org.jboss.forge.addon.ui.metadata.WithAttributes; import org.jboss.forge.addon.ui.util.Metadata; import org.jboss.forge.addon.ui.util.Categories; import org.jboss.forge.addon.ui.result.Result; import org.jboss.forge.addon.ui.result.Results; import java.lang.Override; import java.lang.Exception; import javax.inject.Inject; public class JIRASetupCommand extends AbstractUICommand { @Inject @WithAttributes(label = "JIRA URL", required = true) private UIInput<URLResource> url; @Inject private Configuration config; @Override public UICommandMetadata getMetadata(UIContext context) { return Metadata.forCommand(getClass()) .name("JIRA: Setup") .description("Setup the JIRA Addon") .category(Categories.create("JIRA", "Setup")); } @Override public void initializeUI(UIBuilder builder) throws Exception { builder.add(url); } @Override public Result execute(UIExecutionContext context) { String targetUrl = url.getValue().getFullyQualifiedName(); Configuration subset = config.subset("jira"); subset.setProperty("url", targetUrl); return Results.success("JIRA URL set to: "+targetUrl); } }
To rebuild and install:
-
In the
Project Explorer
view, click the created add-on. - Press Ctrl+4 to open the Forge context menu.
-
Select
Build and Install an Addon
. -
Click
Finish
to install the add-on into the IDE. - Press Ctrl+4 to open the Forge context menu.
-
Click
JIRA: Setup
.
-
In the
Figure 2.14. Add-on Listed in the Forge Context Menu
Result: The add-on is created and listed in the Forge context menu.
2.3.7. Did You Know?
-
You can launch the Forge Console by clicking Window → Show view → Forge Console. The
Forge Console
view opens in an inactive state. - You can start JBoss Forge by clicking the `Start {JBoss Forge_version} ` button ).
-
To link the Forge Console output with the open editor, click the
Link with Editor
button ( ).
2.4. Developing Applications Using the Hibernate Tools
Hibernate Tools is a collection of tools for projects related to Hibernate version 5 and earlier. The tools provide Eclipse plugins for reverse engineering, code generation, visualization and interaction with Hibernate.
Use the Hibernate Tools to easily generate, test and prototype your Hibernate or JPA mapped projects. You can also use Hibernate to Run queries, browse mappings and generate code for your data projects.
2.4.1. Creating a JPA Project and Connect to the Sakila-h2 Database
2.4.1.1. Prerequisites
To connect to the sakila-h2 database:
- Download the sakila-h2 database from the h2 version of the Sakila database.
-
On the terminal, navigate to the directory where you have saved the
sakila-h2.jar
file and run the following command to start the database:$ ./runh2.sh
.
To create a JPA project and connect to the database:
-
In the workspace, click
File
→New
→Other
and then search forJPA Project
and double-click it to open theNew JPA Project
wizard. In the
New JPA Project
wizard:-
In the
Project name
field, type a name for the project. -
In the
Target runtime
field, click a runtime server that you wish to use. -
In the
JPA version
list, click2.1
.
-
In the
Click
Next
.Figure 2.15. Create a New JPA Project
-
In the
Java Configure project for building a Java application
window, select the source folder on the build path and clickNext
. -
In the
JPA Facet
window, clickAdd connection
. In the
New Connection Profile
window:-
Click
Generic JDBC
. -
In the
Name
field, typesakila
.
-
Click
-
Click
Next
. -
Click the
New Driver Definition
icon ( ) located next to theDrivers
field. -
Click the
Name/Type
tab, clickGeneric JBDC Driver
and then click theJAR list
tab. Click
Add JAR/Zip
and then select the previously downloadedsakila-h2.jar
file.Figure 2.16. Select sakila-h2.jar File
Click the
Properties
tab and enter the following details in theProperties
table:-
Click
Connection URL
and typejdbc:h2:tcp://localhost/sakila
. -
Click
Driver Class
, and then click the ellipsis icon . -
In the
Available Classes from Jar List
window, clickBrowse for class
. ClickOK
when the required driver is found. -
Click
User ID
, typesa
.
-
Click
-
In the
New Driver Definition
window, clickOK
. -
In the
New Connection Profile
window, clickFinish
to return to theJPA Facet
window. -
In the
Platform
list, clickHibernate (JPA 2.1)
. -
In the
JPA implementation
pane,Type
list, either clickUser Library
and then clickManage libraries
( ). In thePreferences (Filtered)
window add the libraries, OR clickDisable Library Configuration
. -
Click
Finish
.
Result:
The project is created and is listed in the Project Explorer
view.
2.4.1.2. Generating DDL and Entities
DDL, Data Definition Language, is a syntax to define data structures. Generate DDL and entities to enable Hibernate runtime support in an Eclipse JPA project.
To generate DDL and Entities:
-
In the
Project Explorer
view, right-click the {project_name}. -
Click
JPA Tools
→Generate Tables from Entities
orGenerate Entities from Tables
. TheGenerate Entities
window (or theGenerate Tables from Entities
window) appears. In the
Generate Entities
window:-
In the
Output directory
field, change the default directory, if required. -
Optionally, in the
Package
field, type the package name. -
Ensure that the
Use Console Configuration
check box is selected. -
In the
Console Configuration
list, ensure that the relevant configuration is shown.
-
In the
Click
Finish
.Figure 2.17. Generate Entities
2.4.1.3. Creating a Hibernate Mapping File
Hibernate mapping files specify how your objects relate to database tables. To create basic mappings for properties and associations, i. e. generate .hbm.xml
files:
Create a new Hibernate Mapping file:
-
Click
File
→New
. -
In the
New
wizard, locateHibernate
and then clickHibernate XML Mapping file (hbm.xml)
.
-
Click
-
Click
Next
. In the
New Hibernate XML Mapping files (hbm.xml)
window:-
Click
Add Class
to add classes or clickAdd Packages
to add packages. You can create an empty.hbm
file by not selecting any packages or classes. An empty .hbm file is created in the specified location. -
Click the
depth control
check box to define the dependency depth used when choosing classes. -
Click
Next
. - Select the target folder location.
-
In the
File name
field, type a name for the file and clickFinish
.
-
Click
Result:
The hibernate.hbm.xml
file opens in the default editor.
2.4.1.4. Creating a Hibernate Configuration File
For reverse engineering, prototype queries, or to simply use Hibernate Core, a hibernate.properties or hibernate.cfg.xml
file is needed. Hibernate Tools provides a wizard to generate the hibernate.cfg.xml
file if required.
To create a Hibernate Configuration file:
Create a new
cfg.xml
file:- Click File → New → Other.
-
In the
New
wizard, locateHibernate
and then clickHibernate Configuration File (cfg.xml)
.
-
Click
Next
. -
In the
Create Hibernate Configuration File (cfg.xml)
window, select the target folder for the file and then clickNext
. In the
Hibernate Configuration File (cfg.xml)
window:-
The
Container
field, by default, shows the container folder. -
The
File name
field, by default, shows the configuration file name. -
In the
Database dialect
list, click the relevant database. -
In the
Driver class
list, click the driver class depending on the database dialect that you just selected. -
In the
Connection URL
list, click the relevant URL. -
Click the
Create a console configuration
check box to use thehibernate.cfg.xml
file as the basis of the console configuration.
-
The
Click
Finish
.Figure 2.18. Create a New cfg.xml File
Result:
The new hibernate.cfg.xml
file opens in the default editor.
2.4.1.5. Creating a Hibernate Console Configuration
A Console configuration describes how the Hibernate plugin configures Hibernate. It also describes the configuration files and classpaths needed to load the POJOs, JDBC drivers, etc. It is required to make use of query prototyping, reverse engineering and code generation. You can have multiple console configurations per project, but for most requirements, one configuration is sufficient.
To create a Hibernate console configuration:
Create a
cfg.xml
file:- Click File → New → Other.
-
In the
New
wizard, locateHibernate
and then clickHibernate Configuration File (cfg.xml)
.
-
Click
Next
. In the
Create Hibernate Configuration
window,Main
tab:-
In the
Name
field, the generated name provided by default can be edited if required. -
In the
Type
field, clickCore
. -
In the
Hibernate Version
list, select the relevant version. -
In the
Project
field, type a project name or clickBrowse
to locate an existing project. -
In the
Database connection
field, clickNew
to configure a new database connection or leave as is to use the default connection. -
In the
Property file
field, clickSetup
to set the path to the firsthibernate.properties
file found in the selected project (refer to the Did You Know, Setup Property File section for detailed steps). Once created the path of the.properties
file displays in theProperty file
field. -
In the
Configuration file
field, clickSetup
to set the path to the firsthibernate.cfg.xml
file found in the selected project (refer to the Did you know, Setup Configuration File section for detailed steps). Once created, the path of thehibernate.cfg.xml
file displays in theConfiguration file
field.
-
In the
-
Click
Finish
.
Figure 2.19. Create Hibernate Console
2.4.1.6. Modifying the Hibernate Configurations
You can edit the Hibernate Configurations from the Hibernate Configurations
view.
To modify the Hibernate Configurations:
-
Click Window → Show View → Other and then click
Hibernate Configurations
. -
In the
Hibernate Configurations
view, right-click the {project_name} and clickEdit Configuration
. -
The
Edit launch configuration properties
window displays. Edit the fields. -
To close the
Hibernate Configurations
view, right-click the configuration and then clickClose Configuration
.
2.4.1.7. Generating Code and Reverse Engineering
Hibernate tools’ reverse engineering and code generation features allow you to generate a range of artifacts based on a database or an existing Hibernate configuration, like mapping files or annotated classes. Among others, these generated artifacts can be POJO Java source files, hibernate.hbm.xml
files, hibernate.cfg.xml
generation and schema documentation.
To generate code:
Configure Hibernate:
- Click Window → Perspective → Open Perspective → Other.
-
Search for
Hibernate
and double-click it. TheHibernate Configurations
view appears.
View the Hibernate Code Generation Configurations:
-
In the toolbar, next to the
Run
icon, click the down arrow. -
Click
Hibernate Code Generation Configurations
.
-
In the toolbar, next to the
-
Expand
Hibernate Code Generation
and then clickNew_configuration
. -
In the
Create, manage, and run configurations
window, in theName
field, type a logical name for the code generation launcher. If you do not specify a name, the default name,New_Generation
, is used. In the
Main
tab, enter the following details:NoteThe
At least one exporter option must be selected
warning indicates that for the launcher to work you must select an exporter on theExporter
tab. The warning disappears after you select an exporter.-
In the
Console Configuration
list, click the name of the console configuration to be used when generating code. -
In the
Output directory
field, clickBrowse
and select an output directory. This is the default location where all output will be written. You can enter absolute directory paths, for example: d:/temp. Note that existing files will be overwritten/ if the correct directory is not specified. - To reverse engineer the database defined in the connection information, click the Reverse engineering from JDBC connection check box. JBoss Developer Studio generates code based on the database schema when this option is used.If this option is not enabled, the code generation is based on the existing mappings specified in the Hibernate Console configuration.
-
In the
Package
field, add a default package name for any entities found when reverse engineering. In the
reveng.xml
field, clickSetup
to select an existingreveng.xml
file, or create a new one. This file controls certain aspects of the reverse engineering process, such as:- how JDBC types are mapped to Hibernate types
- which tables are included or excluded from the process
In the
reveng. strategy
field, clickBrowse
and provide an implementation of a ReverseEngineeringStrategy. this must be done if thereveng.xml
file does not provide enough customization; the class must be in the classpath of the Console Configuration because if not, you will get a class not found exception.NoteRefer to the Did You Know, Create, manage, and run configurations window, Main tab, Check Boxes section for details of the selected check boxes.
-
The
Exporter
tab specifies the type of code that is generated. Each selection represents an Exporter that generates the code. In the Exporter tab: Click the
Use Java 5 syntax
check box to use a Java 5 syntax for the Exporter-
Click the
Generate EJB3 annotations
check box to generate EJB 3 annotations Select the Exporters from the
Exporters
table. Refer to the Did You Know, Exporter section for details about the exporters.Each Exporter selected in the preceding step uses certain properties that can be set up in the
Properties
section. In theProperties
section, you can add and remove predefined or custom properties for each of the exporters.
-
Click the
-
In the
-
Click
Add
next to theProperties
table to add a property to the chosen Exporter. In the resulting dialog box, select the property from the proposed list and the appropriate value for it. For an explanation of the property and its value, refer to the Did You Know, Exporter Property and its Values section. Click the
Refresh
tab and enter the following:Click the
Refresh resources upon completion
check box to refresh the resources and click one of the following:-
The entire workspace
: To refresh the entire workspace. -
The selected resource
: To only refresh the selected resource -
The project containing the selected resource
: To refresh the project containing the selected resource -
The folder containing the selected resource
: To refresh the folder containing the selected resource -
Specific resources
: To refresh specific resources; then clickSpecify Resources
to open theEdit Working Set
window and select the working set.
-
-
Click the
Recursively include sub-folders
check box to refresh the sub-folders.
Click the Common tab and enter the following:
- In the Save as pane, click Local file to save the configuration as a local file, OR click Shared file and then select a shared file location.
- In the Display in favourites menu pane, click the menu to display the configuration.
- In the Encoding pane, click the format that you want the configuration to be encoded to.
- In the Standard Input and Output pane, click the Allocate console check box and optionally click the Input File and Output File check boxes and select the relevant options.
- Click the Launch in background check box to show the configuration launch progress in the background.
- Click Apply and then click Run.
2.4.2. Did You Know?
2.4.2.1. Setting Up the Property File
To set up the property file:
- In the Create Hibernate Configuration window, Main tab, click Setup.
- In the Setup property file window, click Create new to create a new property file (or click Use existing to choose an existing file as a property file).
- In the Create Hibernate Properties file (.properties) window, click the parent folder name and then click Finish.
2.4.2.2. Setting Up the Configuration File
To set up the configuration file:
- In the Create Hibernate Configuration window, Main tab, click Setup.
- In the Setup configuration file window, click Use existing to choose an existing file as a property file (or click Create new to create a new property file).
- In the Select hibernate.cfg.xml file window, expand the parent folder, choose the file to use as the hibernate.cfg.xml file, and then click OK.
2.4.2.3. Creating, Managing, and Running the Configurations Window, Main tab, Check Boxes
The following check boxes are selected by default in the Create, manage, and run configurations window, Main tab:
- Generate basic typed composite ids: When a table has a multi-column primary key, a <composite-id> mapping will always be created. If this option is enabled and there are matching foreign-keys, each key column is still considered a 'basic' scalar (string, long, etc.) instead of a reference to an entity. If you disable this option a <key-many-to-one> property is created instead. Note that a <many-to-one> property is still created, but is simply marked as non-updatable and non-insertable.
- Detect optimistic lock columns: Automatically detects optimistic lock columns. Controllable via reveng. strategy; the current default is to use columns named VERSION or TIMESTAMP.
- Detect many-to-many tables: Automatically detects many-to-many tables. Controllable via reveng. Strategy.
- Detect one-to-one associations: Reverse engineering detects one-to-one associations via primary key and both the hbm.xml file and annotation generation generates the proper code for it. The detection is enabled by default (except for Seam 1.2 and Seam 2.0) reverse engineering. For Hibernate Tools generation there is a check box to disable this feature if it is not required.
2.4.2.4. Exporter Property and Values
- jdj5: Generates Java 5 syntax
- ejb3: Generates EJB 3 annotations
- for_each: Specifies for which type of model elements the exporter should create a file and run through the templates. Possible values are: entity, component, configuration.
- template_path: Creates a custom template directory for this specific exporter. You can use Eclipse variables.
- template_name: Name for template relative to the template path.
- outputdir: Custom output directory for the specific exporter. You can use Eclipse variables.
- file_pattern: Pattern to use for the generated files, with a path relative to the output dir. Example: /.java.
- Dot.executable: Executable to run GraphViz (only relevant, but optional for Schema documentation).
- Drop: Output will contain drop statements for the tables, indices, and constraints.
- delimiter: Is used in the output file.
- create: Output will contain create statements for the tables, indices, and constraints.
- scriptToConsole: The script will be output to Console.
- exportToDatabase: Executes the generated statements against the database.
- outputFileName: If specified the statements will be dumped to this file.
- haltOnError: Halts the build process if an error occurs.
- Format: Applies basic formatting to the statements.
- schemaUpdate: Updates a schema.
- query: HQL Query template
2.4.2.5. Exporter
- Domain code (.java): Generates POJOs for all the persistent classes and components found in the given Hibernate configuration.
- Hibernate XML Mappings (.hbm.xml): Generate mapping (hbm.xml) files for each entity.
- DAO code (.java): Generates a set of DAOs for each entity found.
- Generic Exporter (<hbmtemplate>): Generates a fully customizable exporter that can be used to perform custom generation.
- Hibernate XML Configuration (.cfg.xml): Generates a hibernate.cfg.xml file; used to keep the hibernate.cfg.xml file updated with any newly discovered mapping files.
- Schema Documentation (.html): Generates a set of HTML pages that document the database schema and some of the mappings.
- Schema Export (.ddl): Generates the appropriate SQL DDL and allows you to store the result in a file or export it directly to the database.
- HQL Query Execution Exporter: Generates HQL Query according to given properties.
2.4.3. Troubleshooting
2.4.3.1. Problems While Loading Database Driverclass
Error message: Problems while loading database driverclass (org.h2.Driver)
Resolution: To avoid this error, you must select a predefined DTP connection profile in the Database Connection dropdown. Also, the jar can be added on the Classpath page of the Console Configuration wizard if you don’t want to have it on the project classpath.
- Right-click {project_name} → Properties → Java Build Path.
- Click the Libraries tab and then click Add External JARs.
- Navigate to the downloaded database JAR file and click OK.
- In the Properties for {project_name} window, click Apply and then click OK.
2.5. Creating Your First Mobile Web Application
Mobile Web Tools provides an HTML5 Project
wizard that enables you to create web applications optimized for mobile devices. The HTML5 Project
wizard is a useful starting point for creating all new HTML5 web applications in the IDE. The wizard generates a sample ready-to-deploy HTML5 mobile application with REST resources from a Maven archetype.
As demonstrated in this article, you can customize the application using the JBoss Tools HTML Editor
, deploy and view the application with the mobile browser simulator BrowserSim, and use LiveReload to refresh BrowserSim as the application source code is modified and saved in the IDE.
The instructions here demonstrate how to complete the following tasks:
This article guides you through each of these configuration requirements and must be completed in the order given.
2.5.1. Prerequisite: Configuring the IDE for an Available Server
The instructions in this article show you how to deploy your HTML5 web application to a server. The IDE must be configured for any servers to which you want to deploy applications, including the location and type of application server and any custom configuration or management settings. You can complete this configuration at the time of deploying the application but in this article it is assumed that you have completed the configuration beforehand.
For information on configuring a local runtime server and deploying applications to it, see Deploy Apps to a Local Server.
2.5.2. Creating an HTML5 Project
The HTML5 Project
wizard generates a sample project based on a Maven archetype and the project and application identifiers provided by you. The Maven archetype version is indicated in the Description
field of the wizard first page and you can change the version, and therefore the project look and dependencies, by selected either an enterprise or non-enterprise target runtime within the wizard.
To create a HTML5 project, complete the following steps:
-
In JBoss Central, under
Start from scratch
, clickHTML5 Project
. -
From the
Target Runtime
list, select an IDE-ready server and clickNext
. Complete the fields about the HTML5 project as follows:
-
In the
Project name
field, type a name for the project. -
In the
Package
field, type an alpha-numeric package for the project.
-
In the
-
Click
Finish
. -
When prompted with
'HTML5 Project' Project is now ready
, clickFinish
.
The project is generated and listed in the Project Explorer
view.
2.5.3. Building and Deploying the Application
After the HTML5 project is generated, it can immediately be built and deployed to an application server.
To build and deploy the application, complete the following steps:
-
In the
Project Explorer
view, right-click{project name}
and click Run As → Run on Server. -
Ensure
Choose an existing server
is selected. From the table of servers, expand
localhost
, select the server on which to deploy the application and clickFinish
.Figure 2.20. Selecting the server to run the application
The Console
view shows output from the server starting and deploying the application. When deployment is complete, an IDE default web browser opens and shows the deployed web application.
Figure 2.21. Enterprise HTML5 web application Viewed in Browser
Figure 2.22. Non-enterprise HTML5 web application Viewed in Browser
2.5.4. Viewing the Application with BrowserSim
The HTML5 web application has an interface optimized for mobile devices. You can view and test such web pages as they would be on mobile devices using BrowserSim. This mobile device web browser simulator provides skins for different mobile devices, making it easy to test and debug web applications for mobile devices.
To view the application with BrowserSim, complete the following steps:
-
Ensure
JBoss
is the perspective in use. To open theJBoss
perspective, click Window → Open Perspective → Other and double-clickJBoss
. -
In the
Servers
view, expand the server adapter to list the application. -
Right-click
{application name}
and click Show In → BrowserSim.
Figure 2.23. HTML5 Web Application Viewed with BrowserSim
2.5.5. Enabling LiveReload for BrowserSim
Mobile Web Tools supports the LiveReload protocol for automatic reloading of web pages in enabled browsers as the application source is modified and saved. LiveReload can be enabled for your system browsers and, as demonstrated here, BrowserSim. This provides an interactive web development experience.
To enable LiveReload for BrowserSim, complete the following steps:
- Close any open BrowserSim simulated devices.
-
In the
Servers
view, right-click an existing server to display the context menu and click New → Server. -
From the list, expand
Basic
, selectLiveReload Server
and clickFinish
. -
In the
Servers
view, right-clickLiveReload Server
and clickStart
. -
In the
Servers
view, right-click{application name}
and click Show In → BrowserSim.
LiveReload is automatically enabled for this BrowserSim simulated device and all subsequent devices opened while the LiveReload server is running.
2.5.6. Changing the Application
With LiveReload enabled for BrowserSim, you can make changes to your application source code and BrowserSim automatically reloads the application when changes are saved. This is demonstrated here by making a simple change to the project index.html
file, specifically changing the text in the application title banner.
To change your application, complete the following steps:
-
In the
Project Explorer
view, expand{project name} → src → main → webapp
. -
Double-click
index.html
to open it for editing with theJBoss Tools HTML Editor
. Locate the following line of code inside the
<body>
tags<h3>HTML5 Quickstart</h3>
and replace it with
<h3>My Quickstart</h3>
- Save the file by pressing Ctrl+S (or Cmd+S).
This code change modifies the heading displayed on the main application page. Notice that BrowserSim automatically reloads the web page when you save the changed file and the application modifications are immediately visible.
2.5.7. Did You Know?
-
You can also launch the
HTML5 Project
wizard from theJBoss
perspective by clicking File → New → HTML5 Project. -
You can test an undeployed
.html
file with BrowserSim by right-clicking the.html
file in theProject Explorer
view and clicking Open With → BrowserSim. -
To set BrowserSim as the IDE default web browser, in the
JBoss
perspective click Window → Web Browser → BrowserSim or click Window → Preferences → General → Web Browser and from theExternal web browsers
list selectBrowserSim
. -
You can also enable LiveReload for already opened BrowserSim simulated devices. After starting the LiveReload server, right-click the BrowserSim simulated device frame and click
Enable LiveReload
.
2.6. Generating a HTML5 Web Application Using the Mobile Web Palette
The IDE provides the Mobile Web
palette that allows the user to make interactive web applications. This palette offers a wide range of features including drag-and-drop widgets for adding common web interface framework features such as HTML5, jQuery Mobile, and Ionic tags to html files. It also contains widgets like Panels
, Pages
, Lists
, Buttons
to make the applications more user friendly and efficient.
Use the instructions to complete the following steps:
2.6.1. Adding a New HTML5 jQuery Mobile File to a Project
The HTML5 jQuery Mobile
file template consists of JavaScript and CSS library references that are inserted in the file’s HTML header. The template also inserts a skeleton of the jQuery Mobile
page and listview
widgets in the file’s HTML body. The following procedure details the steps to insert the template into your project.
To create a new HTML5 jQuery Mobile file in an existing project:
-
In the
Project Explorer
view, expand [project name] →src
→main
. -
Right-click
webapp
and click New → HTML File. Complete the fields about the html file as follows:
-
Ensure the parent folder field shows
[project name]/src/main/webapp
. -
In the
File name
field, type a name for the HTML5 file.
-
Ensure the parent folder field shows
-
Click
Next
. -
From the
Templates
table, selectHTML5 jQuery Mobile Page (1.4)
and clickFinish
.
Figure 2.24. Select HTML5 jQuery Mobile Page (1.4)
Result: The new file is listed in the Project Explorer
view under the project webapp
directory and the file opens in the editor.
2.6.2. Adding New Pages to the Web Application
Use the jQuery Mobile Page
widget to add pages to your mobile web application as follows:
-
In the
Project Explorer
view, expand [project name] →src
→main
→webapp
. - Right-click the new html file and click Open With → JBoss Tools HTML Editor.
-
In the
Palette
view, click thejQuery Mobile
tab to view the available widgets and clickPage
. Complete the fields about the page as follows:
-
In the
Header
field, type a name for the page header. -
In the
Footer
field, type a name for the page footer.
-
In the
Click
Finish
.Figure 2.25. Adding a New Page
-
Save the changes to the file by clicking the
Save
icon.
Result: A page is added to the html file. JS and CSS references are also automatically added to the file by the Page
widget wizard.
Figure 2.26. New Page Added to the HTML File
2.6.3. Customizing the Home Page of the Web Application
Use the widgets in the jQuery Mobile
palette to customize the page. Use the instructions to add a menu to the page. This menu links to three other pages: Home
, Search
, and the Add Contacts
page.
To create and add the menu to your application page:
2.6.4. Adding a Panel to the Page
- Place the cursor where you want the panel, in the html file.
-
In the
Palette
view, in thejQuery Mobile
tab, clickPanel
. Complete the fields about the Panel as follows:
-
In the
ID
field, typemy_panel_ID
. -
Clear the
Add Menu
check box.
-
In the
-
Click
Finish
. - Save the html file.
Figure 2.27. Adding a New Panel
Result: A corresponding code snippet, for the newly added panel, is added to the html file where you had placed the cursor.
2.6.5. Adding a List to the Panel
- Within the panel’s code snippet, place your cursor at the desired location for the new list.
-
In the
Palette
view, in thejQuery Mobile
tab, clickListView
. Complete the fields about the ListView as follows:
-
In the
Items
section,1
tab, in theLabel
field, type the name for the first list item on the page. -
In the
URL (href)
field, type a URL identifier for the label.
-
In the
Figure 2.28. New Listitem Added to the Panel
-
Click
Finish
. - Save the html file.
Result: The new list item name appears in the code snippet.
Figure 2.29. Code for the New Listitem in the Panel Added
2.6.6. Adding a Button in the Header of the Page to Display the List
- Place the cursor within the header at the desired location for the new button.
-
In the
Palette
view, in thejQuery Mobile
tab, clickButton
. Complete the fields about the button as follows:
-
In the
Label
field, typeMenu
. -
In the
URL (href)
field, type#
followed by the panel ID (#my_panel_ID
, in this case). -
In the
Icon
list, select an icon. -
In the
Icon position
list, select a desired value. -
Select the
Icon only
check-box.
-
In the
-
Click
Finish
. - Save the html file.
Figure 2.30. Adding a Button
Result: The following code is added to the body of the html file.
<div data-role="page" id="page-1"> <div data-role="panel" id="my_panel_ID"> <ul data-role="listview" id="listview-1"> <li><a href="1st_item.html">1st_item</a></li> <li><a href="item2.html">Item 2</a></li> <li><a href="item3.html">Item 3</a></li> </ul> </div> <div data-role="header"> <h1>This is the Page Header</h1> <a href="#my_panel_ID" id="button-1" class="ui-btn ui-icon-plus ui-btn-icon-notext ui-corner-all">Menu</a> </div> <div data-role="content"> <p>Page content goes here.</p> </div> <div data-role="footer"> <h4>This is the Page Footer</h4> </div> </div>
2.6.7. Running and Testing the HTML5 Mobile Application Using BrowserSim
Test the newly added elements to the application by navigating to the interface on BrowserSim as follows:
-
In the
Project Explore
view, expand [project name] →src
→main
→webapp
. - Right-click the changed html file and click Open With → BrowserSim.
Result: A simulated device appears and displays the application.
Figure 2.31. The Changes Made to the HTML File Displayed on BrowserSim
2.6.8. Did You Know?
-
To access the
jQuery Mobile
palette when thePalette
view is not visible, click Window → Show View → Other, expandGeneral
and selectPalette
. -
Add BrowserSim in the toolbar by clicking Window → Customize Perspective and select
BrowserSim
underCommand Groups Availability
. It appears as a Phone icon in the toolbar. -
Use the
Panel
widget to create menus, collapsible columns, drawers, and more. TheList View
widget is an unordered list containing links to list items. jQuery Mobile applies the necessary styles to make the listview mobile friendly. -
Add contacts to the
Add Contacts
page by following the above listed procedure. You can addName
,Email
,Phone Number
fields to theAdd Contacts
page by using theText Input
icon in theMobile Web
palette.
2.7. Creating Your First Hybrid Mobile Application
Mobile Hybrid Tools enables you to quickly create Cordova-based hybrid mobile applications using the Hybrid Mobile Project
wizard. This wizard is a useful starting point for creating all new Cordova-based mobile applications in the IDE.
As illustrated in this article, from this foundation you can customize the application by adding a range of Cordova plug-ins for accessing device hardware with the Cordova Plug-in Discovery
wizard. You can also test your Cordova-based hybrid mobile applications without leaving the IDE using CordovaSim, a mobile application simulator. The IDE also allows you to deploy your Hybrid Mobile project on the FeedHenry server.
The Hybrid Mobile Project
wizard is also an ideal starting point for new users to Hybrid Mobile Tools and CordovaSim, guiding you through the necessary steps to set up the IDE and your system for developing Cordova applications before generating a basic Cordova project.
Before attempting to install or create a hybrid mobile project with JBoss Tools, ensure that the Android SDK is installed and up to date. Creating or installing hybrid mobile projects without a working and updated installation of Android SDK can result in unexpected errors.
The instructions here demonstrate how to complete the following tasks:
- Section 2.7.1, “Prerequisites”
- Section 2.7.4, “Creating a Hybrid Mobile Project”
- Section 2.7.5, “Customizing the Hybrid Mobile Project”
- Section 2.7.6, “Testing the Hybrid Mobile Application using CordovaSim”
- Section 2.7.7, “Deploying the Hybrid Mobile Project on the FeedHenry Server”
- Section 2.7.10, “Modifying the Icon for a Mobile Application”
- Section 2.7.11, “Editing an Application Splash Screen”
2.7.1. Prerequisites
Ensure that the following prerequisites are met to create a hybrid mobile project:
2.7.2. Enabling the JBoss Hybrid Mobile Tools + CordovaSim Feature
To enable the JBoss Hybrid Mobile Tools + CordovaSim feature:
-
In JBoss Central, click the
Software/Update
tab. In the
Features Available
list, select theJBoss Hybrid Mobile Tools + CordovaSim
check box and then clickInstall/Update
.Figure 2.32. Hybrid Mobile Tools + CordovaSim Check Box Selected
- Follow the on-screen instructions to complete the installation.
During the installation process you may receive warnings about installing unsigned content. If this is the case, review the details of the content and if satisfied click OK
to continue with the installation.
Once installation is complete, you are prompted to restart Eclipse. Click Yes
to restart immediately and No
if you need to save any unsaved changes to open projects. Note that IDE changes do not take effect until the IDE is restarted.
2.7.3. Installing Android SDK
To install Android SDK:
- Download Android SDK and then unzip the file at a desired location.
-
In the IDE, click
Window
→Preferences
. -
In the
Preferences
window,type filter text
field, typeHybrid Mobile
. -
In the
Hybrid Mobile
category, clickAndroid
. Click
Browse
to locate and select the Android SDK directory on your machine.Figure 2.33. Select the Android SDK Location
-
Click
Apply
and then clickOK
.
2.7.4. Creating a Hybrid Mobile Project
After the project wizard requirements are installed, you can restart the Hybrid Mobile Project wizard and follow it through to completion to create a template-based project. Within the wizard you must specify identifiers for the project and application and select the Cordova engine version to be used for building the project.
To create a Hybrid Mobile project, complete the following steps:
-
In JBoss Central, under
Start from scratch
, clickHybrid Mobile Project
. Complete the fields about the project and application as follows:
-
In the
Project name
field, type a name for the project. -
In the
Name
field, type a name for the application In the
ID
field, type an alpha-numeric package name for the application; IDs are akin to Java package names and must begin with an alpha character and contain at least one dot.Figure 2.34. Provide the Project and Application Information
-
In the
-
Click
Next
. -
From the
Available Engines
table, select the latest Apache Cordova version. If theAvailable Engines
table is empty, first clickDownload
and follow the instructions to install the latest Cordova engine version on your system. -
Click
Finish
.
Result: The project is created and listed in the Project Explorer
view.
2.7.5. Customizing the Hybrid Mobile Project
Before building and running the Hybrid Mobile application, instructions are given here for customizing the project by adding the Cordova Device Motion plug-in and modifying the source code to make use of it. The plug-in gives access to the mobile device accelerometer and the code snippets added to this project check for data every one second and display the X, Y, Z acceleration values on the front page of the application. This plug-in is just one of a catalog of plug-ins available to add to your Hybrid Mobile project.
To customize the Hybrid Mobile project with the Cordova Device Motion plug-in, complete the following steps:
-
In the
Project Explorer
view, right-click{project name}
and clickInstall Cordova Plug-in
. -
In the
Find
field, entermotion
. -
From the filtered list of plug-ins, select
org.apache.cordova.device-motion
and clickFinish
. -
In the
Project Explorer
view, expand{project name} → www
. -
Double-click
index.html
to open it in the JBoss Tools HTML Editor. Edit
index.html
as follows:Before the closing
</head>
tag, add the following lines<script type="text/javascript" charset="utf-8" src="cordova.js"></script> <script type="text/javascript" charset="utf-8" src="js/index.js"></script>
Replace the code inside the
<body></body>
tags with the following lines<div class="app"> <h1>My Cordova Accelerometer App</h1> <div id="accelerometer">Waiting for accelerometer...</div> </div>
Figure 2.35. The Modified index.html File
-
Save the
index.html
file by pressing Ctrl+S (or Cmd+S). -
In the
Project Explorer
view, expand{project name} → www → js
. -
Double-click
index.js
to open it in the IDE JavaScript Editor. Replace the code in
index.js
with the following lines// The watch id references the current `watchAcceleration` var watchID = null; // Wait for device API libraries to load document.addEventListener("deviceready", onDeviceReady, false); // device APIs are available function onDeviceReady() { console.log("deviceready"); startWatch(); } // Start watching the acceleration function startWatch() { // Update acceleration every 1 seconds var options = { frequency: 1000 }; watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options); } // Stop watching the acceleration function stopWatch() { if (watchID) { navigator.accelerometer.clearWatch(watchID); watchID = null; } } // onSuccess: Get a snapshot of the current acceleration function onSuccess(acceleration) { var element = document.getElementById('accelerometer'); element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' + 'Acceleration Y: ' + acceleration.y + '<br />' + 'Acceleration Z: ' + acceleration.z; } // onError: Failed to get the acceleration function onError() { alert('onError!'); }
-
Save the
index.js
file.
Result: Your Hybrid Mobile Project is now customized and saved.
2.7.6. Testing the Hybrid Mobile Application using CordovaSim
You can build and test the Hybrid Mobile application within the IDE using CordovaSim. CordovaSim is a mobile device simulator specifically for testing Cordova-based hybrid mobile applications. Using the CordovaSim control panel you can input sample data for mobile device hardware, as illustrated here for a device accelerometer.
To run and test your Hybrid Mobile application using CordovaSim, complete the following steps:
-
In the
Project Explorer
view, right-click{project name}
and click Run → Run with CordovaSim. In the CordovaSim control panel, expand
Accelerometer
and drag the 3D device representation to generate device accelerometer data.Figure 2.36. Generated Device Accelerometer Data Displayed in Application
Result: Your Hybrid Mobile application is running for testing.
2.7.7. Deploying the Hybrid Mobile Project on the FeedHenry Server
The IDE allows users to quickly and easily publish a Mobile Hybrid (Cordova) application, developed in the IDE, on the FeedHenry server.
The instructions here demonstrate to complete the following tasks:
2.7.8. Connecting the Cordova Application to the FeedHenry Server
To connect the Cordova application to the FeedHenry server:
In the
Project Explorer
view, right-click the{project name}
and New → Other.NoteRefer to the Create a Hybrid Mobile Project section to create the Hybrid Mobile (Cordova) application.
-
In the search field, type
FeedHenry
and then selectNew FeedHenry Application
and clickNext
. In the
Create FeedHenry Application
window, enter the following details:-
Ensure that the
Source project
field displays the name of the master Cordova project -
In the
Select FeedHenry project
field, select the FeedHenry project name -
In the
Git remote name
field, type a Git remote name for the FeedHenry repository
-
Ensure that the
-
Click
Finish
.
Result: The Almost Done
window confirms that the project is created on the platform. The project structure in the Project Explorer
view, shows the feedhenry.js
and the fhconfig.json
files.
Figure 2.37. Almost done Window Confirms the Application Creation
2.7.9. Pushing the Cordova Application to the FeedHenry Server
To push the application to the FeedHenry server:
-
In the
Project Explorer
view, right-click the{project name}
and click Team → Push Branch “master”. -
If you are prompted for a confirmation to connect, click
Yes
. In the
Push Branch master
window, enter the following details:-
In the
Remote
field, enter the location for the remote Git repository. -
In the
Branch
field, typemaster
.
-
In the
Click
Next
.Figure 2.38. Details of the Push Added in the Push Branch master Window
-
Confirm the details in the
Push Confirmation
window and clickFinish
. -
The
Pushed to git
window confirms the push. ClickOK
. -
Log into FeedHenry at
https://[your-studio-domain].feedhenry.com
. -
Click
Projects
and then click the relevant application.
Result: The Cordova application is visible in the FeedHenry instance.
Figure 2.39. Cordova Application Published on the FeedHenry Server
2.7.10. Modifying the Icon for a Mobile Application
Define the icons for the Mobile Hybrid application using the icon tag in the config.xml
file. If an icon is not specified, the Apache Cordova logo is used as the default icon.
To change the application icon:
-
Save the icon in the <workspace>
/www/res/icon
directory of your project. In the IDE, in the
Project Explorer
view, locate theconfig.xml
file.NoteIf you are using Cordova 4.0.0 or lower, the
config.xml
file is located in the →www
directory. For Cordova versions higher than 4.0.0 theconfig.xml
file is located, a level higher, in the project directory.-
Double-click
config.xml
to open it in the config.xml editor. -
Click the
config.xml
tab to edit the file. To define a single default icon for all platforms, add the following code anywhere withing the widget tag in the
config.xml
file:<icon src="www/res/icon[image name].png" />
Figure 2.40. Icon Tag Added to the config.xml File
Alternatively,
-
To define a pixel-perfect icon for Android, add the following code in the
config.xml
file:
<platform name="android"> <icon src="www/res/android/[image name].png" density="ldpi" /> <icon src="www/res/android/[image name].png" density="mdpi" /> <icon src="www/res/android/[image name].png"density="hdpi" /> <icon src="www/res/android/[image name].png" density="xhdpi" /> </platform>
-
To define a pixel-perfect icon for iOS, add the following code in the
config.xml
file:
<platform name="ios"> <icon src="www/res/ios/[image name].png" width="180" height="180" > </platform>
-
To define a pixel-perfect icon for Android, add the following code in the
-
Save the
config.xml
file. - Right-click the application and click Run As → Run on Android Emulator.
-
On the emulator, click the
Home
button and then click theApplications
button to view the modified icon for the application.
Result: The icon for the application is modified.
Figure 2.41. Modified Icon for the Application Displayed on the Android Emulator
2.7.11. Editing an Application Splash Screen
You can edit the splash screen associated with your application using the splash tag within the platform tag in the config.xml
file. If you are using Cordova 4.0.0 or higher, you must first install the new cordova-plugin-splashscreen to continue to use the splash screen and then use the steps below to edit the splash screen. For Cordova versions lower than 4.0.0, simply follow the steps below to edit the splash screen.
To change the application splash screen:
-
Save the image for the splash screen in the <workspace>
/www/res
directory of your project. In the IDE, in the
Project Explorer
view, locate theconfig.xml
file.NoteIf you are using Cordova 4.0.0 or lower, the
config.xml
file is located in the >www
directory. For Cordova versions higher than 4.0.0, theconfig.xml
file is located, a level higher, in the project directory.-
Double-click
config.xml
to open it in the config.xml editor. -
Click the
config.xml
tab to edit the file. To define the splash screen add the following code within the widget tag in the
config.xml
file:NoteYou can use any density that exists in the Android project.
<platform name="android"> <splash src="www/res/[image name].png" density="land-hdpi"/> <splash src="www/res/[image name].png" density="land-ldpi"/> <splash src="www/res/[image name].png" density="land-mdpi"/> <splash src="www/res/[image name].png" density="land-xhdpi"/> <splash src="www/res/[image name].png" density="port-hdpi"/> <splash src="www/res/[image name].png" density="port-ldpi"/> <splash src="www/res/[image name].png" density="port-mdpi"/> <splash src="www/res/[image name].png" density="port-xhdpi"/> </platform> <preference name="SplashScreenDelay" value="10000" />
-
Save the
config.xml
file. - Right-click the application and click Run As → Run on Android Emulator.
Result: The edited splash screen appears while the application is starting.
2.7.12. Did You Know?
-
You can manually initiate installation of JBoss Hybrid Mobile Tools and CordovaSim by locating them in the JBoss Central
Software/Update
tab or by dragging the following link into JBoss Central: https://devstudio.jboss.com/central/install?connectors=org.jboss.tools.aerogear.hybrid -
You can change the Cordova engine associated with the project after it is created. In the
Project Explorer
view, right-click the project and clickProperties
. ClickHybrid Mobile Engine
and select the engine you want to use. ClickOK
to save the engine change and close theProperties
window. -
You can download multiple Cordova engines to your system with which to build your projects. The
Download
wizard can be accessed from theHybrid Mobile Engine
pane in the projectProperties
window, in addition to theHybrid Mobile Project
wizard. - From the IDE you can also initiate testing of Cordova projects with a connected Android device, system Android Emulator, and system iOS Simulator. The project is built in the necessary native format during the process.
- With the CordovaSim control panel, you can generate simulated data for a range of device hardware, including geolocation and battery status. CordovaSim also manages camera actions, enabling you to upload system images to simulate receiving camera data.
-
A
Shake
button underAccelerometer
in the CordovaSim control panel enables you to simulate a hardware-shake gesture and test the impact on your application.
2.8. Importing and Developing an Existing FeedHenry Application
The IDE includes an Import
wizard to allow users to quickly and easily import previously created FeedHenry applications. Once the application is imported, you can change or enhance the application, test the changes, and then push it back to the FeedHenry server.
Before attempting to install or create a hybrid mobile project with JBoss Tools, ensure that the Android SDK is installed and up to date. Creating or installing hybrid mobile projects without a working and updated installation of Android SDK can result in unexpected errors.
Follow the provided steps to import and make changes to a FeedHenry application in your workspace:
2.8.1. Prerequisites
Ensure that the following prerequisites are met to enable the FeedHenry feature:
2.8.2. Installing Android SDK
To install Android SDK:
- Download Android SDK and then unzip the file at a desired location.
-
In the IDE, click
Window
→Preferences
. -
In the
Preferences
window,type filter text
field, typeHybrid Mobile
. -
In the
Hybrid Mobile
category, clickAndroid
. Click
Browse
to locate and select the Android SDK directory on your machine.Figure 2.42. Select the Android SDK Location
-
Click
Apply
and then clickOK
.
2.8.3. Enabling the FeedHenry Feature
To enable the FeedHenry feature:
-
In JBoss Central, click the
Software/Update
tab. In the
Features Available
list, select theHybrid Mobile Tools + CordovaSim
check box and then clickInstall/Update
.Figure 2.43. Hybrid Mobile Tools + CordovaSim Check Box Selected
- Follow the on-screen instructions to complete the installation.
2.8.4. Setting the Preferences for Your Application Import
To set the preferences:
-
Click
Window
→Preferences
. -
In the
Preferences
window, in the search field type,FeedHenry
and press Enter. Complete the following fields in the
Preferences
window:-
Ensure that the
Target URL
field displays the URL to your FeedHenry server. The URL to your FeedHenry server should be something like:https://[your-studio-domain].feedhenry.com
. In the
API Key
field, copy and paste the API key from the FeedHenry website.Figure 2.44. Setting Preferences for FeedHenry
NoteThe user can either use an existing API key or generate a new one to set the preferences. To obtain the API key from the FeedHenry website click
Settings
→API Key Management
. To generate a new API key, clickSettings
→API Key Management
, and then clickAdd New Key
.
-
Ensure that the
-
Click
Apply
and then clickOK
to close thePreferences
window.
2.8.5. Importing Your FeedHenry Application
Ensure that your Preferences are set before importing a FeedHenry application. If not set yet, you are prompted to set the preferences. These preferences are set once when importing an application for the first time and the configured preferences are used for all imports in the future.
To import your FeedHenry application:
-
Click
File
→Import
. -
Expand
FeedHenry
, click Import Cordova Application, and clickNext
. -
The
Import
wizard displays the projects that you can import. Expand the project to import an application from and select the FeedHenry application to be imported. -
In the
Directory
field, enter the location where you want to clone the application locally. -
Click
Finish
.
Figure 2.45. Selecting an Application to be Imported
If you have set a password for the SSH keys, you are prompted to enter the password so that it can import the application.
Result: The FeedHenry project is successfully imported and appears in the Project Explorer
view. The Cordova config.xml
file for this project opens in the Editor.
2.8.6. Testing the Application Import
To test the application import:
In the
Project Explorer
view, right-click the application and then clickRun As
→Run w/remote FeedHenry server
. A CordovaSim simulated device displaying the application appears.Figure 2.46. Simulated Device Displaying the Imported Application
-
In the
Enter Your Name Here
field on the simulated device, type your name. -
Click
Say Hello From The Cloud
.
Result: The simulated device displays the “Hello [Your Name]”
string.
2.8.7. Changing the Application
After successfully importing the FeedHenry application, follow the instructions to change the application:
-
In the
Project Explorer
view, expand[application name]
→www
and then double-clickindex.html
to open it using the Editor. In the code, locate and delete the following line:
This is a basic Cordova App that can take in your name, send it to a cloud app and display the response.
Replace the deleted text with the following line:
Hello from Hybrid Mobile Tools!
-
Save the
index.html
file by pressing Ctrl+S. Alternatively, to save clickFile
→Save
or click theSave
icon.
Figure 2.47. The Edited index.html File
2.8.8. Testing the Application
To test the imported application, right-click the application and then click Run As → Run w/remote FeedHenry server.
Figure 2.48. The Edited FeedHenry Application
The changes made to the index.html
file are reflected on the simulated device. Click a corner of the displayed device to rotate it in that direction. Alternatively, right-click the simulated device and click Rotate Right
or Rotate Left
as to rotate it in the desired direction. To view the application on a different CordovaSim simulated device, right-click the device and click Skin
. From the list of skins, select a skin to view the application.
2.8.9. Pushing the Changes Back to the FeedHenry Server
Use the following instructions to push changes to the application back to the FeedHenry server:
-
In the
Project Explorer
view, right-click the application name. -
Click
Team
→Commit
. -
In the
Commit Changes
window,Commit message
field, type a message for the commit. -
In the
Files
field, select the files that you have edited and want to push to the server and then clickCommit and Push
. -
In the
Push Results [application name]
window, ensure all the details are correct and clickOK
. -
Log into FeedHenry at
https://[your-studio-domain].feedhenry.com
. -
Click
Projects
. -
Click the
Project Title
under which your application is located and then click the application.
Result: The simulated device in the App Preview
section displays the change that you have just pushed to the FeedHenry server.
Figure 2.49. FeedHenry Application Edited and Displayed on the FeedHenry Server
2.8.10. Did You Know?
-
Add a new API key to your FeedHenry account by clicking
Add New Key
and then following the on-screen instructions. -
Set up your SSH key in the FeedHenry account by clicking
Settings
→SSH Key Management
and then following the on-screen instructions.
2.8.11. Troubleshooting
2.8.11.1. Git Communication Error
Figure 2.50. Git Communication Error
Error Message
Problem when cloning the application. This can be due to a network problem or missing security credentials. Refer to error log for details.
Issue
When a FeedHenry account is set up, the user’s API Keys are configured by default, but the SSH Public key must be manually configured. Importing a FeedHenry application means that the application repository is accessed via Git. Without a Public SSH key, the tools are unable to complete the action and this error appears.
Resolution
-
Click
OK
to close theGit Communication Error
window. -
Log into FeedHenry at:
https://[your-studio-domain].feedhenry.com
. - Click the icon located in the uppermost right-side corner of the screen to display the context menu.
-
Click
Settings
→SSH Key Management
and then clickAdd New Key
. In the
Public Key
field, enter your SSH Public key. An existing Public SSH key is available at~/.ssh/id_rsa.pub
. Alternatively, generate a new Public SSH key with the following command:$ ssh-keygen -t rsa -C "username@example.com"
2.8.11.2. Invalid Preferences
Figure 2.51. Invalid Preferences
Issue
When the user logs into FeedHenry for the first time, the Invalid Preferences
dialog box appears informing the user that the FeedHenry connection preferences are unidentified or invalid and that the user must correct the preferences. Refer to the Set the Preferences section for details to set the connection preferences.
Chapter 3. Deploying Your Applications
3.1. Deploying Applications to a Local Server
In order to deploy applications to a server from within the IDE, you must configure the IDE with information about the server. For a local server this information includes the following:
- a server runtime environment with details about the server location, runtime JRE, and configuration files
- a server adapter with management settings for the server runtime environment, including access parameters, launch arguments, and publishing options
JBoss Server Tools enables you to efficiently configure a local server ready for use with the IDE using Runtime Detection. As demonstrated here, this feature is useful for quickly configuring a server for deploying and testing an application.
Instructions are provided here for completing the following tasks:
3.1.1. Configuring the IDE for a Local Runtime Server
Runtime Detection searches a given local system path to locate certain types of runtime servers. For any servers found, Runtime Detection automatically generates both a default server runtime environment and a default server adapter. These items can be used as they are for immediate application deployment or customized to meet your requirements.
To configure the IDE for a local runtime server, complete the following steps:
- Click Window → Preferences → JBoss Tools → JBoss Runtime Detection.
-
Click
Add
. -
Locate the directory containing the runtime server and click
OK
. -
In the table of located runtimes, ensure the runtime is selected and click
OK
. -
Click
Apply
and clickOK
to close thePreferences
window.
A default runtime environment and server adapter are generated for the server, with the server adapter listed in the Servers
view.
3.1.2. Deploying an Application
When you have configured the IDE for the server, you can deploy applications to the server from the IDE using the server adapter. The server adapter enables runtime communication between the server and IDE for easy deployment of applications and server management.
To deploy an application to the server, complete the following steps:
-
In the
Project Explorer
view, right-click{project name}
and click Run As → Run on Server. -
Ensure
Choose an existing server
is selected. -
From the table of servers, expand
localhost
, select the server on which to deploy the application and clickFinish
.
The Console
view shows output from the server starting and deploying the application. When deployment is complete, an IDE default web browser opens and shows the deployed web application.
3.1.3. Changing and Republishing the Application
By default, the server adapter configures the server for automatic publishing when changed resources are saved. This automatic publishing action applies to application resources that can be interchanged in the dedicated deployment location of the server without requiring the application to stop and restart, such as .html
files. For other changed resources, such as .java
files, you need to republish the application such that it forces a rebuild of the application.
To republish the application to the server after changes that cannot be automatically published, complete the following steps:
-
In the
Servers
view, expand the server adapter to list the applications allocated to the server. -
Right-click
{application name}
and clickFull Publish
.
The Console
view shows output from the server replacing the deploying application. Unless LiveReload is enabled in the web browser, you must manually reload the web browser to see the changed application.
3.1.4. Did You Know?
-
You can also configure servers by right-clicking the
Servers
view and selecting New → Server or by clickingManually define a new server
in theRun on Server
wizard. -
Paths previously searched by Runtime Detection can be automatically searched on every workspace start. Click Window → Preferences → JBoss Tools → JBoss Runtime Detection and from the
Paths
table select the check boxes of the appropriate paths. ClickApply
and clickOK
to close thePreferences
window. -
You can customize the server adapter and server runtime environment with the
Server Editor
. In theServers
view, double-click the server adapter to open theServer Editor
. -
You can initiate download and installation of runtime servers from the IDE. Click Window → Preferences → JBoss Tools → JBoss Runtime Detection. Click
Download
and from the table of runtime servers select the one to install and clickNext
. Follow the on-screen instructions to complete the download and installation process.
3.2. Configuring a Remote Server
Remote servers allow developers to access and deploy to a JBoss instance that is not a local machine. Developers can use remote servers to set up multiple environments for development and testing purposes and share them with other developers. Another reason to use a remote server with Red Hat JBoss Developer Studio is to allow developers to share and deploy automated tests to run in a non-local environment.
The following instructions are used to set up a remote server for JBoss Enterprise Middleware application servers. A complete server definition requires a server adapter (or server) that allows the IDE to communicate with and manage the remote server.
-
Click the
Servers
view. If theServers
view is not visible, click Window → Show View → Server. Use the appropriate instructions depending on the number of existing servers listed in the
Servers
tab:-
If there are no existing servers, click
No servers are available. Click this link to create a new server…
. - If there are one or more existing servers, right-click an existing server and click New → Server.
-
If there are no existing servers, click
In the
New Server
wizard, add the relevant information for the following fields:-
From the
Select the server type
list, select a JBoss Enterprise Middleware application server. -
The
Server’s host name
andServer name
fields are completed by default. In theServer name
field, you can type a custom name by which to identify the server in theServers
view. Click
Next >
to continue.Figure 3.1. Define a New Remote Server
-
From the
Configure the required
Server Adapter
details:-
For the
The server is
field, click theRemote
radio button option. For the
Controlled by
field, select either theFilesystem and shell operations
orManagement Operations
radio button option depending on your requirements.NoteIf you select
Management Operations
for theControlled by
field, you must set up an admin user on the server by using the$SERVER_HOME/bin/add-users.sh
script (for Linux, or the$SERVER_HOME\bin\add-users.bat
file for Windows) and enter the same credentials in the server editor or during the server start.-
The
Server is externally managed. Assume server is started
field is used when the user wants to deploy the server but does not want the IDE to stop or start the server for them. Depending on the requirements, select this check box or leave it unchecked, as is default. A remote server can now be created without assigning a runtime to it. Depending on the requirements, select the Assign a runtime to this server check box (and select an existing runtime or create a new one) or leave the box unselected.
NoteCreating a Remote Server without a runtime results in limitations. For example, the JMX connection does not work because it requires libraries from the runtime to connect via JMX. Additionally, automatic port detection occurs using the
standalone.xml
file, which is not available if a runtime is not specified. These and other minor issues related to hard-coded minor fixes in maintenance releases may occur if no runtime is specified for the Remote Server.Figure 3.2. Create a New Server Adapter
-
For the
Add the remote system integration details as follows:
In the drop-down menu, select the appropriate host type in the
Host
field.-
The default host is
Local
. If required, use the
New Host
button to create a new host, which may be remote or local. Supported connection types for remote hosts areFTP Only
orSSH Only
.Figure 3.3. New Host Options
-
The default host is
Add the
Remote Runtime Details
as follows:- Specify a path to the directory that contains the remote server in the Remote Server Home field.
-
Specify the remote server’s base directory (the default value for this is the standalone directory within server home directory) in the
Remote Server Base Directory field
. This location is within theRemote Server Home
directory (specifically in the$SERVER_HOME/BASE_DIRECTORY/configuration/
directory). -
Specify the file to use for the remote server’s configuration (the default value for this is the standalone.xml file) in the
Remote Server Configuration File
field. This location is within theRemote Server Home
directory (specifically in the$SERVER_HOME/BASE_DIRECTORY/configuration/
directory). Either click
Next >
to continue to the (optional) next step to add or remove server resources or clickFinish
to conclude the new remote server configuration.Figure 3.4. Connect to a Remote System
Optional: Add or remove resources configured on the server as follows:
-
To add a resource, select the appropriate resource in the
Available
pane and clickAdd >
. To add all available resources, clickAdd All >>
. -
To remove a resource, select the appropriate resource in the
Configured
pane and click< Remove
. To remove all configured resources, click<< Remove All
. Click
Finish
to complete the server configuration.Figure 3.5. Add and Remove Server Resources
Result: You have successfully configured a remote server. The new server is listed in the
Servers
tab. Right click the server to view operations, includingStart
to start the server.
-
To add a resource, select the appropriate resource in the
If the Server is externally managed. Assume server is started
check box was selected in step 4, clicking Start
does not start the server. Instead, it marks the server to indicate that it has started and the web poller checks whether the server is running.