Plug-in Documentation

JBoss Application Server

Overview

The JBoss Application Server plug-in includes steps that manage JBoss Application Server, including application-related tasks and configuration tasks.

This plug-in requires JBoss Application Server.

The plug-in includes steps that are related to installing, configuring, and uninstalling applications, such as the following steps:

  • Deploy Application
  • Deploy JDBC Driver
  • Add Data Source

The plug-in also includes steps that are related to configuring and maintaining JBoss Application Server and checking the status of applications, such as the following steps:

  • Run Script
  • Check Deployment Status
  • Restart Server Group

Compatibility

This plug-in requires version 6.0.1 of IBM UrbanCode Deploy.

This plug-in supports JBoss Application Server version 6.1 or later.

The steps in this plug-in do not run on IBM z/OS agents. This plug-in runs on all other operating systems that are supported by both IBM UrbanCode Deploy and by the JBoss Application Server jboss-cli tool.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

History

Version 22

  • Fixed APAR PH20233 No such property: helper for class: enable.

Version 19

Version 19 adds:
RFE 106319 Added controller port configuration argument to the Stop Server step.

Version 18

Version 18 adds:
Fixed APAR PI88903 Additional Arguments have updated to descriptions that describe their modification of the generated JBoss script, not JBoss CLI.
Renamed Administrative Port to Management Port to better reflect JBoss documentation.
Fixed APAR PI88920 Admin Host field on Check Deployment Status and Create Server step not being used properly.

Version 17

Version 17 adds:
Fixed Start JBoss step to work properly when a server configuration file is specified in Windows.
Fixed Start JBoss step to print command line output and errors.

Version 16

Version 16 adds:
APAR PI85106: Start JBoss step now runs as a background process so that it doesnt timeout.
Adds hidden Shell property to the Start JBoss step.

Version 15

Version 15 adds support for property file encryption.

Version 14

Version 14 adds:
APAR PI71167: Restart Server step will correctly use the Administrative Port property.
Restart Server step can restart a Domain Hostname.
All steps print their script contents to the standard output log.

Version 13

Version 13 adds new Additional Arguments property to all steps.

Version 12

Version 12 fixes management port value in deploy application step.

Version 11

Version 11 adds ability to pass hostname and administrative port to all steps.

Version 10.694887

Version 10.694887 includes a Restart Server step and a fix for a defect related to the runtime name in the Deploy Application step.

Version 9.596950

Version 9.596950 includes additional output for the Deploy Application and Deploy JDBC Driver steps.

Version 9.554208

Version 9.554208 supports IBM UrbanCode Deploy version 6.0.1 and later. This release includes support for username/password authentication.

Steps

Process steps in the JBoss plug-in

Add Data Source

Add a new Data Source to JBoss

Input properties for the Add Data Source step
Name Type Description Required
Add as XA Source Boolean Check to create this data source as an XA Data Source. No
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Additional Properties String Additional properties to pass to the CLI, new-line separated. No
Administrative Port String Jboss server administrative port. Default is 9999. No
Connection URL String For use with non-XA Data Sources. The connection URL to the database to be used. No
Controller Name String The controller name of the JBoss instance to connect to. No
Data Source Name String Name of the Data Source to be created. Yes
Database Name String For use with XA Data Sources. The name of the database for the XA Data Source. No
Driver Name String Name of the driver to be used for this connection. Yes
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss Startup Path String The path to the JBoss startup executable. Yes
JNDI Name String The JNDI name for the Data Source. Must begin with java:/ or java:jboss/. Yes
Password Password The password to the database to be used. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Port Number String For use with XA Data Sources. The port number of the server. No
Server Name String For use with XA Data Sources. The name of the server for the XA data source. No
Start enabled Boolean Check to enable on creation. Leave clear to enable manually later. No
User Name String The user name to the database to be used. Yes
Username String The username to authenticate with. No

Add JMS Connection Factory

Add a JMS Connection Factory to JBoss

Input properties for the Add JMS Connection Factory step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Connector String The connector to be used, comma separated. The first will be the default, the rest
will be backups.
Yes
Controller Name String The controller name of the JBoss instance to connect to. No
Entries String The JNDI names the Factory will be bound to, comma separated, must end with the name
of the Factory.
Yes
Factory Name String The name of the Factory to be created. Yes
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss Startup Path String The path to the JBoss startup executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Profile String The profile to add the Factory to. Required if JBoss is in Domain Mode. No
Username String The username to authenticate with. No

Add JMS Queue

Add a JMS Queue to JBoss

Input properties for the Add JMS Queue step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Controller Name String The controller name of the JBoss instance to connect to. No
Entries String The JNDI names the Queue will be bound to, comma separated. Yes
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss Startup Path String The path to the JBoss startup executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Profile String The profile to add the Queue to. Required in Domain Mode. No
Queue Name String The name of the Queue to be created. Yes
Username String The username to authenticate with. No

Add JMS Topic

Add a JMS Topic to JBoss

Input properties for the Add JMS Topic step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Controller Name String The controller name of the JBoss instance to connect to. No
Entries String The JNDI names the Topic will be bound to, comma separated. Yes
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss Startup Path String The path to the JBoss startup executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Profile String The profile to add the Topic to. Required if JBoss is in Domain Mode. No
Topic Name String The name of the Topic to be created. Yes
Username String The username to authenticate with. No

Check Deployment Status

Get the status information on a deployment

Input properties for the Check Deployment Status step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Controller Name String The controller name of the JBoss instance to connect to. No
Deployment Name String The name of the deployment to check. Yes
Host Name String Required in Domain Mode. The name of the host the deployment is on. No
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss CLI Path String The path to the JBoss Command Line Interface executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Server Name String Required in Domain mode. The Name of the server the deployment is on. No
Username String The username to authenticate with. No

Create Server

Create a server and add it to a server group

Input properties for the Create Server step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Auto-Start Boolean Check to set auto-start to true. No
Controller Name String The controller name of the JBoss instance to connect to. No
Group Name String The server group to add this server to. Yes
Host Name String The name of the server host. Yes
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss CLI Path String The path to the JBoss Command Line Interface executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Server Name String The name to give the server to be created. Yes
Socket Offset String The socket offset for this server. Yes
Username String The username to authenticate with. No

Create Server Group

Create Server Group on a JBoss Domain instance

Input properties for the Create Server Group step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Controller Name String The controller name of the JBoss instance to connect to. No
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss CLI Path String The path to the JBoss Command Line Interface executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Profile String The profile to create this server group under. Yes
Server Group Name String The name of the server group to be created. Yes
Socket Binding Group String The name of the socket binding group to use for the server group. Yes
Username String The username to authenticate with. No

Deploy Application

Deploy application to JBoss.

Input properties for the Deploy Application step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Application name String The name of the application to be deployed. If no source is specified, the named application
will be enabled instead. If no application name is supplied, the file name will be
used.
No
Controller Name String The controller name of the JBoss instance to connect to. No
Deploy To All Server Groups Boolean Only applicable in Domain Mode. Check to deploy to all servers. No
Deploy To Server Groups String Only applicable in Domain Mode. List the servers youd like to deploy to, comma separated. No
Exclude Files String A new line separated list of file patterns for files to exclude. No
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
Include Files String A new line separated list of file patterns for included files. **/* includes all files
and files in subdirectories.
Yes
JBoss CLI Path String The path to the JBoss Command Line Interface executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Runtime name String The runtime name of the application to be deployed. Should end with the file ending
of the deployment source.
No
Username String The username to authenticate with. No

Deploy JDBC Driver

Deploy JDBC Driver to JBoss.

Input properties for the Deploy JDBC Driver step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Deploy To All Server Groups Boolean Only applicable in Domain Mode. Check to deploy to all servers. No
Deploy To Server Groups String Only applicable in Domain Mode. List the servers youd like to deploy to, comma separated. No
Driver name String The name of the driver. If no name is specified, the file name (including .jar) will
be the name.
No
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss CLI Path String The path to the JBoss Command Line Interface executable. Yes
JDBC Driver Path String Path to the JDBC Driver jar. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Username String The username to authenticate with. No

Disable Application

Disable an application that has been deployed to JBoss, Standalone Only.

Input properties for the Disable Application step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Application name String The name of the application to be deployed. If no source is specified, the named application
will be enabled instead.
Yes
Controller Name String The controller name of the JBoss instance to connect to. No
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss CLI Path String The path to the JBoss Command Line Interface executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Username String The username to authenticate with. No

Enable Application

Enable an application that has been deployed to JBoss, Standalone Only.

Input properties for the Enable Application step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Application name String The name of the application to be deployed. If no source is specified, the named application
will be enabled instead.
Yes
Controller Name String The controller name of the JBoss instance to connect to. No
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss CLI Path String The path to the JBoss Command Line Interface executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Username String The username to authenticate with. No

Remove JMS Connection Factory

Remove a JMS Connection Factory from JBoss

Input properties for the Remove JMS Connection Factory step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Controller Name String The controller name of the JBoss instance to connect to. No
Factory Name String The name of the Factory to be removed. Yes
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss Startup Path String The path to the JBoss startup executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Profile String The profile to remove the Factory from. Required if JBoss is in Domain Mode. No
Username String The username to authenticate with. No

Restart Server

Restart a JBoss Server.

Input properties for the Restart Server step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Controller Name String The controller name of the Jboss instance to connect to. No
Domain Hostname String If in domain mode, specify the Jboss domain hostname. No
Hostname String Hostname to connect to the administration console of the JBoss server. Defaults to
localhost.
No
JBoss CLI Path String The path to the JBoss Command Line executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Timeout String How long to wait (in milliseconds) to bring the server up before failing. No
Username String The username to authenticate with. No

Restart Server Group

Restart a JBoss Server Group.

Input properties for the Restart Server Group step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Controller Name String The controller name of the JBoss instance to connect to. No
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss Startup Path String The path to the JBoss startup executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Server Groups String List of JBoss server groups to be restarted. Comma-separated, no spaces. Yes
Timeout String How long to wait (in milliseconds) to bring the server up before failing. No
Username String The username to authenticate with. No

Run Script

Run a custom script on JBoss using the CLI

Input properties for the Run Script step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Controller Name String The controller name of the JBoss instance to connect to. No
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss CLI Path String The path to the JBoss Command Line Interface executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Script Data String The script to be executed. Yes
Username String The username to authenticate with. No

Start JBoss

Start JBoss in either Standalone or Domain mode.

Input properties for the Start JBoss step
Name Type Description Required
Host Name String The host name of the server to be started. Yes
JBoss Startup Path String The path to the JBoss startup executable. Yes
Port Number String The port number of the server to be started. Yes
Server Configuration String Provide a file name to start the server with a specfic configuration No
Server Start Wait Timeout String The amount of time (in milliseconds) to wait for the server to start before declaring
timeout.
Yes
Startup Mode Enumeration:

  • standalone
  • domain
Choose whether to start in Standalone or Domain mode. Yes

Stop JBoss

Stop JBoss in either standalone or domain mode.

Input properties for the Stop JBoss step
Name Type Description Required
Domain Mode Host Name String The name of your host. Only required when your server is in Domain mode. No
JBoss Startup Path String The path to the JBoss startup executable. Yes
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Server Mode Enumeration:

  • standalone
  • domain
Choose whether your server is in Standalone or Domain mode. Yes
Username String The username to authenticate with. No
Management Hostname String The JBoss management hostname for connecting to a standalone server. No
Management Port String The JBoss management port for connecting to a standalone server. No

Undeploy Application

Undeploy application in JBoss.

Input properties for the Undeploy Application step
Name Type Description Required
Additional Arguments String Any additional arguments to pass to the Jboss CLI. (example: force) No
Administrative Port String Jboss server administrative port. Default is 9999. No
Application Name String The name of the file to be undeployed. Yes
Controller Name String The controller name of the JBoss instance to connect to. No
Hostname String Hostname to connect to the administration console of the Jboss server. Defaults to
localhost.
No
JBoss CLI Path String The path to the JBoss Command Line Interface executable. Yes
Keep Content Boolean Check to keep the content on your JBoss server. This will deactivate the application,
but will not delete anything.
No
Password Password The password to authenticate with. Default value is ${p?:resource/JBoss.password}. No
Undeploy From All Server Groups Boolean Only applicable in Domain Mode. Check to undeploy to all relevant servers. No
Uneploy From Server Groups String Only applicable in Domain Mode. List the servers youd like to undeploy from, comma
separated.
No
Username String The username to authenticate with. No

Usage

Example: Deploying an application on JBoss Application Server

Typically, when you deploy an application by using the JBoss Application Server plug-in, you only need to use the Deploy Application step:

deployjboss