JBossServer

JBossServer: An ATG JBoss application server

Super Type

Service

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

Allowed Child Dependencies

• JBossEar ¹
• JBossSetting
• JBossZip ¹
• Rdb ¹

¹: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

• 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

Exported Attributes

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

Defaults for Imported Attributes

Name	Default
atg_jvm_maxheap	-Xmx256m
atg_jvm_minheap	-Xms256m
documentRoot	${entity.attribute.jboss_basedir}/deploy/jbossweb-tomcat55.sar/ROOT.war
java_home	${env.JAVA_HOME}
javaOpts
jboss_extract_ear	false
port_config	ports-default
timezone	US/Pacific

Docs-Generate

creates directories required for jboss operation

Usage

Docs-Generate [-atg_data_dir <>] [-basedir <>] [-install_root <>] [-java_home <>] [-javaopts <>] [-jboss_version <>] [-jvm_max_perm_size <>] [-jvm_maxheap <>] [-jvm_minheap <>] [-jvm_perm_size <>] [-overwrite <false>] [-port_config <>] [-timezone <>]

Options

Option	Description
atg_data_dir	ATG-Data directory
basedir	base directory of the jboss instance
install_root
java_home	JAVA_HOME
javaopts	the java options
jboss_version	version of the jboss server package
jvm_max_perm_size	jre max_perm_size setting
jvm_maxheap	JAVA_HOME
jvm_minheap	jre minheap setting
jvm_perm_size	jre perm_size setting
overwrite	overwrite the configuration if true
port_config	jboss binding port configuration
timezone	the time zone

Docs-Register

Experimental: registers configuration documents required for jboss operation

Usage

Docs-Register [-basedir <>] [-install_root <>] [-jboss_version <>]

Options

Option	Description
basedir	base directory of the jboss instance
install_root
jboss_version	version of the jboss server package

Docs-Baseline

Experimental: Creates a baseline for the configuration documents required for jboss operation

Usage

Docs-Baseline [-basedir <>] [-install_root <>] [-overwrite]

Options

Option	Description
basedir	base directory of the jboss instance
install_root	the jboss installation root directory
overwrite	Overwrite existing baseline copies

Docs-Verify

Experimental: Verifies the configuration documents required for jboss operation

Usage

Docs-Verify [-basedir <>] [-install_root <>]

Options

Option	Description
basedir	base directory of the jboss instance
install_root	the jboss installation root directory

Configure

Run the configuration cycle for the deployment.

Usage

Configure

Workflow

1. Docs-Generate
2. Docs-Baseline

killService

kills the jboss server process

Usage

killService [-basedir <>] [-install_root <>] [-killwait <2>]

Options

Option	Description
basedir	base directory of the jboss instance
install_root	installation root of the jboss server
killwait	number of seconds to wait to check if PIDs still exist after kill

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

Start

Conditionally starts the JBoss Server

Usage

Start

Workflow

1. assertServiceIsUp

Error Handler

Command

startServiceWrapper

assertServiceIsDown

Check whether JBoss is down

Usage

assertServiceIsDown [-basedir <>] [-install_root <>] [-port_config <>]

Options

Option	Description
basedir	base directory of the jboss instance
install_root
port_config	jboss binding port configuration

assertServiceIsUp

Check whether JBoss is up

Usage

assertServiceIsUp [-basedir <>] [-install_root <>] [-port_config <>]

Options

Option	Description
basedir	base directory of the jboss instance
install_root
port_config	jboss binding port configuration

startServiceWrapper

wraps the jboss start procedure and waits for start event

Usage

startServiceWrapper

Workflow

1. startService
2. waitforStartEvent

startService

asynchronously executes the jboss start command

Usage

startService [-atg_data_dir <>] [-atg_jvm_maxheap <>] [-atg_jvm_minheap <>] [-basedir <>] [-install_root <>] [-java_home <>] [-spawn <true>]

Options

Option	Description
atg_data_dir	jboss atg data directory path
atg_jvm_maxheap	max heap jvm arg
atg_jvm_minheap	min heap jvm arg
basedir	base directory of the jboss instance
install_root
java_home	JAVA_HOME
spawn	Whether or not to run in background

waitforStartEvent

waits for a startup even of an asynchronously started jboss service

Usage

waitforStartEvent [-basedir <>] [-maxwait <900>]

Options

Option	Description
basedir	base directory of the jboss instance
maxwait	maximum time in seconds to wait for start event

Stop

Conditionally stops the JBoss Server

Usage

Stop

Workflow

1. assertServiceIsDown

Error Handler

Command

stopServiceWrapper

stopServiceWrapper

wraps the jboss stop procedure and waits for stop event

Usage

stopServiceWrapper

Workflow

1. stopService
2. waitforStopEvent

Error Handler

Command

killService

stopService

executes the jboss stop command

Usage

stopService [-basedir <>] [-install_root <>] [-maxwait <120>] [-port_config <>]

Options

Option	Description
basedir
install_root
maxwait	timeout in seconds for standard jboss shutdown to complete
port_config	jboss port configuration

waitforStopEvent

waits for a stop event of a jboss service

Usage

waitforStopEvent [-basedir <>] [-maxwait <60>] [-port_config <>]

Options

Option	Description
basedir	base directory of jboss instance
maxwait	maximum time in seconds to wait for stop event
port_config	jboss service bindings port config

The following types are defined for use with JBossServer.

JBossSetting

Overview

JBossSetting: A JBoss Setting

Design

Super Type

Setting

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

Constraints

Allowed Parent Dependencies

• JBossServer

JBossExtractEar

Overview

JBossExtractEar: JAVA_HOME for JBoss

Design

Super Type

JBossSetting

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

Attributes

Exported Attributes

Name	Property
jboss_extract_ear	settingValue

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

JBossJavaOpts

Overview

JBossJavaOpts: JAVA_OPTS for JBoss

Design

Super Type

JBossSetting

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

Attributes

Exported Attributes

Name	Property
javaOpts	settingValue

JBossPortConfig

Overview

JBossPortConfig: JBoss service bindings port configuration

Design

Super Type

JBossSetting

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

Attributes

Exported Attributes

Name	Property
port_config	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 ATG 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 ATG 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

JVMMinHeap

Overview

JVMMinHeap: JVM minimum heap size

Design

Super Type

JBossSetting

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

Attributes

Exported Attributes

Name	Property
atg_jvm_minheap	settingValue

JVMMaxHeap

Overview

JVMMaxHeap: JVM maximum heap size

Design

Super Type

JBossSetting

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

Attributes

Exported Attributes

Name	Property
atg_jvm_maxheap	settingValue

JVMPermSize

Overview

JVMPermSize: JVM Perm Size memory setting

Design

Super Type

JBossSetting

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

Attributes

Exported Attributes

Name	Property
jvm_perm_size	settingValue

JVMMaxPermSize

Overview

JVMMaxPermSize: JVM Max Perm Size memory setting

Design

Super Type

JBossSetting

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

Attributes

Exported Attributes

Name	Property
jvm_max_perm_size	settingValue

AppTimezone

Overview

AppTimezone: A appserver timezone

Design

Super Type

JBossSetting

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

Attributes

Exported Attributes

Name	Property
timezone	settingValue