Filters

Search Results ()

Search Results ()

    All Plugins (150)

    Quick Info

    Product
    HCL Launch
    Type
    plugin
    Compatibility
    Created by
    HCL Software
    Website
    Published Date
    March 12th, 2021
    Last Updated
    November 15th, 2022

    Description

    JBoss Application Server is an open-source application server for Java EE. This plug-in interacts with the JBoss-CLI command-line tool to provide access to JBoss operational and configuration tasks through the HCL Launch process designer.

    Quick Info

    Product
    HCL Launch
    Type
    plugin
    Compatibility
    Created by
    HCL Software
    Website
    Published Date
    March 12th, 2021
    Last Updated
    November 15th, 2022

    launch-jboss-23.1108451.zip

    Uploaded: 18-Jun-2021 12:49

    launch-jboss-22.1095836.zip

    Uploaded: 12-Mar-2021 12:09

    Summary

    The JBoss Application Server plugin includes steps that manage JBoss Application Server, including application-related tasks and configuration tasks. The plugin includes steps that are related to installing, configuring, and uninstalling applications, such as the following steps:

    • HCL Launch Application
    • HCL Launch JDBC Driver
    • Add Data Source

    The plugin 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

    This plugin includes one or more steps, click Steps for step details and properties.

    Compatibility

    This plugin requires version 6.0.1 of HCL Launch.

    This plugin requires JBoss Application Server version 6.1 or later.

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

    Installation

    See Installing plugins in HCL Launch for installing and removing plugins.

    History

    The following table describes the changes made in each plugin version.

    Plugin history details
    Version Description
    22 Fixed APAR PH20233 No such property: helper for class: enable.

    Usage

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

    Steps

    The following process steps are available in the JBoss plugin.

    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 is enabled instead. If no application name is supplied, the file name is 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) is 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 is 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 is 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 Choose whether to start in Standalone or Domain mode. Valid values are standalone and domain. 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 Choose whether your server is in Standalone or Domain mode. Valid values are standalone and domain. 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