-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat JBoss Developer Studio
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.