Font size:

JBoss

JBoss application server module

Overview
Design
Constraints
Attributes
- Exported Attributes
Commands
- Configure
  - Workflow
- Docs-Generate
  - Options
- killService
  - Options
- packages-code-install
  - Options
- packages-config-install
  - Options
- Packages-Install
  - Workflow
- Start
  - Workflow
  - Error Handler
- assertServiceIsUp
  - Options
- startServiceWrapper
  - Workflow
- startService
  - Options
- waitforStartEvent
- Stop
  - Workflow
  - Error Handler
- assertServiceIsDown
  - Options
- stopServiceWrapper
  - Workflow
  - Error Handler
- stopService
  - Options
- waitforStopEvent
  - Options
- Update
  - Workflow
Related Types
- JBossSetting
- JBossJavaHome
- JBBindAddr
- JBConfiguration
- JBJnpPort
- JBJrmpRmiObjectPort
- JBNamingRmiPort
- JBPooledServerBindPort
- JBTcAjpPort
- JBTcHttpPort
- JBUIL2ServerBindPort
- JBWSPort
- JBossDocumentRoot
- DataDir
- DynamoModules

Overview

JBoss: JBoss application server module

Design

Super Type: Service

Role	Concrete. (Objects can be created.)
Instance Names	Unique
Notification	false
Template Directory	${modules.dir}/JBoss/templates
Data View	Children, proximity: 1
Logger Name	JBoss

Constraints

Allowed Parent Dependencies

AppServerCollection
Node
Site

Allowed Property Values

Property	Allowed Values	Default	Enforced
deployment-basedir	${entity.attribute.jboss_install_root}/server/atg	${entity.attribute.jboss_install_root}/server/atg	false
deployment-install-root	${user.home}/jboss/jboss-4.0.3SP1	${user.home}/jboss/jboss-4.0.3SP1	false

Attributes

Exported Attributes

Name	Property
jboss_basedir	deployment-basedir
jboss_install_root	deployment-install-root

Commands

Note

Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.

Configure

Configures the jboss server instance

Usage: Configure

Workflow

Docs-Generate

Docs-Generate

creates directories required for jboss operation

Usage: Docs-Generate [-ajpPort <>] [-basedir <>] [-bindAddr <>] [-httpPort <>] [-install_root <>] [-jboss_version <>] [-jnpPort <>] [-jrmp_rmi_object_port <>] [-naming_rmi_port <>] [-overwrite <false>] [-pooled_server_bind_port <>] [-uil2_server_bind_port <>] [-ws_port <>]

Options

Option	Description
ajpPort	embedded tomcat ajp port
basedir	base directory of the jboss server instance
bindAddr	address jboss server binds to
httpPort	jboss http server port
install_root	installation root of the jboss server
jboss_version	version of the jboss server package
jnpPort	jboss naming service port
jrmp_rmi_object_port	RMI server socket listening port number
naming_rmi_port	naming rmi port
overwrite	overwrite the configuration if true
pooled_server_bind_port	jboss pooled server bind port
uil2_server_bind_port	jboss uil2 server bind port
ws_port	jboss web services port

killService

kills the jboss server process

Usage: killService [-basedir <>]

Execution	bash
Arguments	ps auxww \|grep java \|grep `basename ${opts.basedir}` \|grep -v grep \|awk '{print $2}' \|xargs kill -9

Options

Option	Description
basedir	base directory of the jboss server instance

packages-code-install

installs all the code package dependencies

Usage: packages-code-install [-packagetype <[^.]*(?:(?!Configuration))[^.]*>]

Options

Option	Description
packagetype	regular expression of packages to include

packages-config-install

installs all the Configuration package dependencies

Usage: packages-config-install [-packagetype <[^.]*Configuration[^.]*>]

Options

Option	Description
packagetype	regular expression of packages to include

Packages-Install

Installs all package dependencies

Usage: Packages-Install

Workflow

packages-code-install
packages-config-install

Start

Conditionally starts the JBoss Server

Usage: Start

Workflow

assertServiceIsUp

Error Handler

Command

startServiceWrapper

assertServiceIsUp

Checks if jboss is running

Usage: assertServiceIsUp [-basedir <base directory of the jboss server instance>] [-httpPort <jboss http server port>]

Options

Option	Description
basedir	server base dir
httpPort	http port number to check

startServiceWrapper

wraps the jboss start procedure and waits for start event

Usage: startServiceWrapper

Workflow

startService
waitforStartEvent

startService

asynchronously executes the jboss start command

Usage: startService [-atg_data_dir <>] [-basedir <>] [-dynamo_modules <>] [-javaHome <>]

Options

Option	Description
atg_data_dir	jboss atg data directory path
basedir	base directory of the jboss server instance
dynamo_modules	comma separated list of atg dynamo modules to load
javaHome	JAVA_HOME

waitforStartEvent

waits for a startup even of an asynchronously started jboss service

Usage: waitforStartEvent

Stop

Conditionally stops the JBoss Server

Usage: Stop

Workflow

assertServiceIsDown

Error Handler

Command

stopServiceWrapper

assertServiceIsDown

Checks if jboss is not running

Usage: assertServiceIsDown [-httpPort <jboss http server port>]

Options

Option	Description
httpPort	http port number to check

stopServiceWrapper

wraps the jboss stop procedure and waits for stop event

Usage: stopServiceWrapper

Workflow

stopService
waitforStopEvent

Error Handler

Command

killService

stopService

executes the jboss stop command

Usage: stopService [-install_root <>] [-javaHome <>] [-jnpPort <>]

Options

Option	Description
install_root	installation root of the jboss server
javaHome	JAVA_HOME
jnpPort	jboss naming service port

waitforStopEvent

waits for a stop event of a jboss service

Usage: waitforStopEvent [-httpPort <>] [-maxwait <60>]

Options

Option	Description
httpPort	boss http server port
maxwait	maximum time in seconds to wait for stop event

Update

Executes the JBoss Server Update procedure

Usage: Update

Workflow

Stop
Packages-Install
Start

Related Types

The following types are defined for use with JBoss.

JBossSetting

Overview

JBossSetting: A JBoss Setting

Design

Super Type: Setting

Role	Abstract. (Objects cannot be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

JBoss

JBossJavaHome

Overview

JBossJavaHome: JAVA_HOME for JBoss

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
java_home	settingValue

JBBindAddr

Overview

JBBindAddr: JBoss Bind Address

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
bindAddr	settingValue

JBConfiguration

Overview

JBConfiguration: The name of an JBoss Configuration

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
jboss_configuration	settingValue

JBJnpPort

Overview

JBJnpPort: The name of an JBoss Configuration

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
jnpPort	settingValue

JBJrmpRmiObjectPort

Overview

JBJrmpRmiObjectPort: JBoss JRMP RMI Object Port

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
jboss_jrmp_rmi_object_port	settingValue

JBNamingRmiPort

Overview

JBNamingRmiPort: JBoss Naming RMI Object Port

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
jboss_naming_rmi_port	settingValue

JBPooledServerBindPort

Overview

JBPooledServerBindPort: JBoss Pooled Server Bind Port

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
jboss_pooled_server_bind_port	settingValue

JBTcAjpPort

Overview

JBTcAjpPort: Embedded Tomcat/JBoss AJP Port

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
ajpPort	settingValue

JBTcHttpPort

Overview

JBTcHttpPort: JBoss HTTP Port

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
httpPort	settingValue

JBUIL2ServerBindPort

Overview

JBUIL2ServerBindPort: JBoss UIL2 ServerBind Port

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
jboss_uil2_server_bind_port	settingValue

JBWSPort

Overview

JBWSPort: JBoss WebServices Port

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
jboss_ws_port	settingValue

JBossDocumentRoot

Overview

JBossDocumentRoot: JBoss Document Root

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
documentRoot	settingValue

DataDir

Overview

DataDir: Directory path to Data dir

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
atg_data_dir	settingValue

DynamoModules

Overview

DynamoModules: Directory path to Data dir

Design

Super Type: JBossSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
atg_dynamo_modules	settingValue