Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.AddApplicationUserTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Add Application User Task

Description

This task creates an application user entry in the server configuration 'application-users.properties' and 'application-roles.properties files.

Usage

This task uses the defined username and password to create the entry.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.AddManagementUserTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Add Management User Task

Description

This task creates a management user entry in the server configuration 'mgmt-users.properties' file. Find more about adding management user in JBoss documentation: https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6/html/Installation_Guide/chap-Getting_Started_with_JBoss_Enterprise_Application_Platform_6.html Find more about "realm": https://docs.jboss.org/jbossweb/3.0.x/realm-howto.html

Usage

This task uses the defined username and password to create the entry.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.CheckResourceExistTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Check Resource Exists Task

Description

This test if a parameter exists in the JBoss Server configuration. If the parameter does exist then this task will trough an exception. The intention is this task can be used in an orchestration to stop the orchestration or highlight that the parameter is already configured on the server. This task reads a parameter (non-recursive) at the address defined by the property name and value. If this address returns a node, then the we get the result type node from the returned node and test if a property of the given name is on that node. If it does exist this task will throw an exception.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.CreateDataSourceTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Create Data Source Task

Description

This task creates a Data Source parameter in the JBoss server. Throws an exception if the data source has not been created or does not exist.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.CreateJdbcDriverTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Create JDBC Driver Task

Description

This task creates a JDBC Driver parameter in the JBoss server. Throws an exception if the driver has not been created or does not exist.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.DeployModulesTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Deploy Modules Task

Description

This task copies the specified modules directory into the JBoss servers modules directory. If a modules directory cannot be found this task then looks for a zip file to unpack and copy the modules directory from that file.

Usage

This task uses the JBoss home and JBoss modules directory settings to work out which directory to copy the custom modules to.
Before using this task make sure that there is a module directory (projectModulesDir) OR compressed file (projectZipFile) containing module directory (zipFileRelativeModulesDir) set. You can find more info about JBoss modules here: https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Development_Guide/chap-Class_Loading_and_Modules.html#Modules1

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.DeployApplicationTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Deploy Application Task

Description

This task deploys an application into the JBoss server.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.ExecuteCommandsTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Execute CLI Commands Task

Description

This task executes commands specified in a file, on the JBoss server. Values in the commmands can be substituted with data dictionary items.

Example CLI Commands

/subsystem=datasources/jdbc-driver=OracleDriver:add(driver-name=OracleDriver,driver-module-name=com.oracle,driver-xa-datasource-class-name=oracle.jdbc.xa.client.OracleXADataSource)
/subsystem=datasources/data-source=myAppDataSource/:add(connection-url=jdbc:oracle:thin:@localhost:1521:xe,jndi-name=java:jboss/jdbc/myAppDataSource,driver-name=OracleDriver,xa-datasource-class=oracle.jdbc.xa.client.OracleXADataSource,user-name=myAppDsUserName,password=myAppDsPassword,use-java-context=false,pool-prefill=false,pool-use-strict-min=false,interleaving=false,no-tx-separate-pool=false,pad-xid=false,same-rm-override=false,wrap-xa-resource=false,allow-multiple-users=false,share-prepared-statements=false,set-tx-query-timeout=false,background-validation=false,use-fast-fail=false,validate-on-match=false,spy=false,use-ccm=false,no-recovery=false,jta=false)
/subsystem=datasources/data-source=myAppDataSource/:enable(persistent=true)
/subsystem=datasources/data-source=myAppDataSource/:test-connection-in-pool
/subsystem=logging/size-rotating-file-handler=FILE_BY_SIZE:add(level=INFO,formatter="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n",max-backup-index=3,rotate-size=1024,file={"path"=>"production-server.log","relative-to"=>"jboss.server.log.dir"})
/subsystem=logging/logger=com.jboss.logtest:add(level=INFO,handlers=["FILE_BY_SIZE"])

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.InstallJBossTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Install Task

Description

This task uncompresses the JBoss binaries ZIP file into the specified installation directory. If the task is executed on a non-Windows server, chmod is used on the installation directory to make the necessary files executable.
Note that RapidDeploy expects that ZIP file with Jboss binaries has a standard structure. For example:

 			
                     			jboss-eap-6.4.0Final/
                     			.../bin
                     			.../bundles
                     			.../domain
                     			.../modules
                     			.
                     			.
                     			.
                     			

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.InstallJBossWebServerTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Web Server Install Task

Description

This task uncompresses the package ZIP file into the specified JBoss home. If the task is executed on a non-Windows server, chmod is used on the installation directory to make the necessary files executable.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.SnapshotTask
Category	JBoss EAP 6.4.0

Create a snapshot of a JBoss EAP 6.4.0 server

Description

This task creates a snapshot ZIP file of a JBoss EAP 6.4.0 instance consisting on the specified included and excluded configuration files of the JBoss installation location.

Usage

Using ANT fileset patterns set the included and excluded configuration files you want to be into the snapshot ZIP file.
By default the snapshot file will be saved in the RapidDeploy server in the location specified in the field 'Snapshots Path' of the environment configuration panel. If you want to use a different location (not recommended) you can set it using the 'snapshotDirectory' parameter.
If you select to save the snapshot file in the target server ('saveOnTarget') you need to specify the 'snapshotDirectory' parameter with the location in the target server where you want to save the snapshot file.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.StartServerTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Start Server Task

Description

This task starts up the JBoss server. The task trys to connect to the server using the remoting connection settings and if it cannot establish a connection, it assumes JBoss is not running and it starts JBoss.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.StopServerTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Stop Server Task

Description

This task stops the JBoss server. The task trys to connect to the server using the remoting connection settings and if it can establish a connection, it issues the shutdown command to stop the server.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.TestDataSourceTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Test Data Source Task

Description

This task tests a Data Source parameter in the JBoss server. Throws an exception if the data source test fails.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.UnDeployApplicationTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Undeploy Application Task

Description

This task undeploys an application from the JBoss server. Specify the application file by setting applicationPath or applicationName. If you leave both parameters empty the configuration name of the current deployment is used to look for a file in the package with the extension of [ear,war,jar].

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.UnInstallJBossTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Uninstall Task

Description

This task stops the JBoss server, then deletes every file and directory under the JBoss home directroy.

Parameters

The following parameters may be set on this task:

Class Name	com.midvision.rapiddeploy.plugins.products.rh.jboss.all.task.WriteAttributeTask
Category	JBoss EAP 6.4.0

RedHat JBoss EAP 6.4.0 Write Attribute Task

Description

This task writes an attribute in the JBoss server. Throws an exception if the attribute is not written. The property and name combinations are used to navigate to node address of the property attribute to write.

Example, to emulate this CLI operation to enable the http console:

/core-service=management/management-interface=http-interface/:write-attribute(name=console-enabled,value=true)

Set these property values and property names, which are used to create the address to the node to value to write

propNameLevel1=core-service
propValueLevel1=management
propNameLevel2=management-interface
propValueLevel2=http-interface
propNameLevel3=console-enabled
propValueLevel3=true

Parameters

The following parameters may be set on this task: