AtgJBossServer

An ATG JBoss application server

Overview
Design
Constraints
Attributes
- Exported Attributes
- Defaults for Imported Attributes
Commands
Related Types
- AtgJBossSetting
  - Overview
  - Design
  - Constraints
- AtgJBossPidfile
  - Overview
  - Design
  - Attributes
- AtgJBossTransactionTimeout
  - Overview
  - Design
  - Attributes
- AtgJBossEngineLocalhostConfig
  - Overview
  - Design
  - Attributes
- AtgJBossStartupTimeout
  - Overview
  - Design
  - Attributes
- AtgJBossShutdownTimeout
  - Overview
  - Design
  - Attributes
- AtgJBossJvmRoute
  - Overview
  - Design
  - Attributes
- AtgCopyFromJBossDefaultInstance
  - Overview
  - Design
  - Attributes
- AtgJBossDirCreateList
  - Overview
  - Design
  - Attributes
- AtgJBossDirRemoveList
  - Overview
  - Design
  - Attributes
- AtgJBossLiveConfig
  - Overview
  - Design
  - Attributes
- AtgJBossExtractEar
  - Overview
  - Design
  - Attributes
- AtgJBossJavaHome
  - Overview
  - Design
  - Attributes
- AtgJBossPortConfig
  - Overview
  - Design
  - Attributes
- AtgJBBindAddr
  - Overview
  - Design
  - Attributes
- AtgJBJnpPort
  - Overview
  - Design
  - Attributes
- AtgJBJrmpRmiObjectPort
  - Overview
  - Design
  - Attributes
- AtgJBNamingRmiPort
  - Overview
  - Design
  - Attributes
- AtgJBPooledServerBindPort
  - Overview
  - Design
  - Attributes
- AtgJBTcAjpPort
  - Overview
  - Design
  - Attributes
- AtgJBTcHttpPort
  - Overview
  - Design
  - Attributes
- AtgJBUIL2ServerBindPort
  - Overview
  - Design
  - Attributes
- AtgJBWSPort
  - Overview
  - Design
  - Attributes
- AtgJBossDocumentRoot
  - Overview
  - Design
  - Attributes
- AtgDataDir
  - Overview
  - Design
  - Attributes
- AtgDynamoModules
  - Overview
  - Design
  - Attributes
- AtgDynamoServerName
  - Overview
  - Design
  - Attributes
- AtgJBossJavaOpts
  - Overview
  - Design
  - Attributes
- AtgRmiPort
  - Overview
  - Design
  - Attributes

Overview

AtgJBossServer: An ATG JBoss application server

Design

Super Type: AtgAppServer

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

Constraints

Allowed Child Dependencies

AtgAppTimezone
AtgCopyFromJBossDefaultInstance ¹
AtgEar
AtgJBossEngineLocalhostConfig
AtgJBossJvmRoute ¹
AtgJBossLocalConfig
AtgJBossServerConfig ¹
AtgJBossSetting
AtgJBossShutdownTimeout ¹
AtgJBossStartupTimeout ¹
AtgJBossTransactionTimeout ¹
AtgLicenseZip
AtgLocalConfig
AtgRdb
AtgRmiHost¹
AtgRmiPort ¹
DefaultAllowMultiplePackageMatches¹
DefaultFailIfPackageNotReplaced¹
DefaultPackageName¹
DefaultPackageType¹
JavaBin¹
JBossMSjdbc
JBossOjdbc
JBossZip¹

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

Allowed Parent Dependencies

AtgAppServerCollection
Node
Site

Allowed Property Values

Property	Allowed Values	Default	Enforced
deployment-basedir	${entity.attribute.atgJBossHome}/server/atg	${entity.attribute.atgJBossHome}/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
atgJBossBase	deployment-basedir
atgJBossHome	deployment-install-root

Defaults for Imported Attributes

Name	Default
atg_data_dir	${entity.attribute.atgJBossBase}/ATG-Data
atgJavaHome	/usr
atgJBossJavaOpts	-Xms1024m -Xmx1024m -XX:MaxPermSize=256m -XX:PermSize=256m -XX:NewSize=256m -XX:MaxNewSize=256m -XX:SurvivorRatio=7 -XX:+DisableExplicitGC -XX:+UseParallelGC -Dsun.rmi.dgc.client.gcInterval=3600000
atgLocalConfig	${entity.attribute.atgJBossBase}/ATG-Data/localconfig
atgRmiPort	8860
copyFromJBossDefaultInstance	true
defaultAllowMultiplePackageMatches	false
defaultFailIfPackageNotReplaced	true
defaultPackageName	^$
defaultPackageType	AtgEar
documentRoot	${entity.attribute.atgJBossBase}/deploy/jbossweb-tomcat55.sar/ROOT.war
dynamo_liveconfig	false
engineLocalhostConfig
jboss_extract_ear	false
jbossPidFile	${entity.attribute.atgJBossBase}/conf/jboss.pid
jvmRoute	node1
port_config	ports-default
rmihost
shutdownTimeout	30
startupTimeout	900
timezone
transactionTimeout	300

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

creates directories required for jboss operation

Usage: Docs-Generate [-atg_data_dir <>] [-basedir <>] [-copyFromJBossDefaultInstance <true>] [-dynamo_liveconfig <>] [-dynamo_modules <>] [-dynamo_server_name <>] [-engineLocalhostConfig <>] [-install_root <>] [-java_home <>] [-java_opts <>] [-jboss_server_config <>] [-jboss_version <>] [-jbossDefaultInstance <default>] [-jvmroute <>] [-overwrite <false>] [-port_config <>] [-rmihost <>] [-timezone <>] [-transactionTimeout <>]

Options

Option	Description
atg_data_dir	ATG-Data directory
basedir	base directory of the jboss server instance
copyFromJBossDefaultInstance	if true will configure new instance from default
dynamo_liveconfig	Dynamo live configuration
dynamo_modules	dynamo server name java property
dynamo_server_name	dynamo server name java property
engineLocalhostConfig	tomcat engine localhost config
install_root	installation root of the jboss server
java_home	JAVA_HOME
java_opts	JAVA_OPTS
jboss_server_config	jboss server config
jboss_version	version of the jboss server package
jbossDefaultInstance
jvmroute	tomcat/ajp jvmroute
overwrite	overwrite the configuration if true
port_config	jboss binding port configuration
rmihost	RMI host
timezone	Timezone
transactionTimeout	transaction timeout

configureDirectories

creates/removes directories within the jboss instance per defined lists

Usage: configureDirectories [-jboss_dir_create_list <>] [-jboss_dir_remove_list <>]

Options

Option	Description
jboss_dir_create_list	comma separated list of directory paths
jboss_dir_remove_list	comma separated list of directory paths

configureDataSources

executes AtgRdb generateDSXml

Usage: configureDataSources [-basedir <>] [-jboss_install_root <>] [-jboss_version <>] [-resourcename <.*>] [-resourcetype <Atg[^.]*Rdb[^.]*>]

Options

Option	Description
basedir	base directory of the jboss server instance
jboss_install_root	installroot of jboss server
jboss_version	version of jboss server
resourcename	object regex to apply configureDataSources execution to
resourcetype	type regex to apply configureDataSources execution to

killService

kills the jboss server process

Usage: killService [-basedir <>] [-install_root <>]

Execution	bash
Arguments	if [ "${os.name}" = SunOS ]; then PS=/usr/ucb/ps; else PS=ps; fi ; $PS auxww \|grep "jboss.${opts.install_root}.`basename ${opts.basedir}`" \|grep -v grep \|awk '{print $2}' \|xargs kill -9

Options

Option	Description
basedir	base directory of the jboss instance
install_root

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

assertServiceIsUp

Error Handler

Command

startServiceWrapper

assertServiceIsDown

Usage: assertServiceIsDown [-basedir <>] [-install_root <>] [-pidfile <>]

Execution	bash
Arguments	ps -fp `cat ${opts.pidfile}` && exit 1 \|\| exit 0

Options

Option	Description
basedir	base directory of the running jboss instance
install_root
pidfile

assertServiceIsUp

Usage: assertServiceIsUp [-basedir <>] [-install_root <>] [-pidfile <>]

Execution	bash
Arguments	ps -fp `cat ${opts.pidfile}` && exit 0 \|\| exit 1

Options

Option	Description
basedir	base directory of the running jboss instance
install_root
pidfile

startServiceWrapper

wraps the jboss start procedure and waits for start event

Usage: startServiceWrapper

Workflow

startService

asynchronously executes the jboss start command

Usage: startService [-basedir <>] [-install_root <>] [-pidfile <>]

Options

Option	Description
basedir
install_root
pidfile

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

assertServiceIsDown

Error Handler

Command

stopServiceWrapper

wraps the jboss stop procedure and waits for stop event

Usage: stopServiceWrapper

Workflow

Error Handler

Command

killService

stopService

executes the jboss stop command

Usage: stopService [-basedir <>] [-install_root <>] [-maxwait <120>] [-pidfile <>] [-port_config <>]

Options

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

waitforStopEvent

waits for a stop event of a jboss service

Usage: waitforStopEvent [-basedir <>] [-maxwait <30>] [-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

Restart

Executes the JBoss Server Restart procedure

Usage: Restart

Workflow

Stop
Start

Related Types

The following types are defined for use with AtgJBossServer.

AtgJBossSetting

Overview

AtgJBossSetting: A JBoss Setting

Design

Super Type: Setting

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

Constraints

Allowed Parent Dependencies

AtgJBossServer

AtgJBossPidfile

Overview

AtgJBossPidfile: jboss transaction timeout

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jbossPidFile	settingValue

AtgJBossTransactionTimeout

Overview

AtgJBossTransactionTimeout: jboss transaction timeout

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
transactionTimeout	settingValue

AtgJBossEngineLocalhostConfig

Overview

AtgJBossEngineLocalhostConfig: arbitrary tomcat engine/localhost configuration

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
engineLocalhostConfig	settingValue

AtgJBossStartupTimeout

Overview

AtgJBossStartupTimeout: time to wait for startup before timimg out

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
startupTimeout	settingValue

AtgJBossShutdownTimeout

Overview

AtgJBossShutdownTimeout: time to wait for shutdown before timing out

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
shutdownTimeout	settingValue

AtgJBossJvmRoute

Overview

AtgJBossJvmRoute: time to wait for startup before timimg out

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jvmRoute	settingValue

AtgCopyFromJBossDefaultInstance

Overview

AtgCopyFromJBossDefaultInstance: configure new jboss instance from default if true

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
copyFromJBossDefaultInstance	settingValue

AtgJBossDirCreateList

Overview

AtgJBossDirCreateList: ATG Dynamo Live Config Directory Creation List setting

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jboss_dir_create_list	settingValue

AtgJBossDirRemoveList

Overview

AtgJBossDirRemoveList: ATG Dynamo Live Config Directory Removal List setting

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jboss_dir_remove_list	settingValue

AtgJBossLiveConfig

Overview

AtgJBossLiveConfig: ATG Dynamo Live Config setting

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
dynamo_liveconfig	settingValue

AtgJBossExtractEar

Overview

AtgJBossExtractEar: JAVA_HOME for JBoss

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jboss_extract_ear	settingValue

AtgJBossJavaHome

Overview

AtgJBossJavaHome: JAVA_HOME for JBoss

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
atgJavaHome	settingValue

AtgJBossPortConfig

Overview

AtgJBossPortConfig: JBoss service bindings port configuration

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
port_config	settingValue

AtgJBBindAddr

Overview

AtgJBBindAddr: JBoss Bind Address

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
bindAddr	settingValue

AtgJBJnpPort

Overview

AtgJBJnpPort: The name of an ATG JBoss Configuration

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jnpPort	settingValue

AtgJBJrmpRmiObjectPort

Overview

AtgJBJrmpRmiObjectPort: JBoss JRMP RMI Object Port

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jboss_jrmp_rmi_object_port	settingValue

AtgJBNamingRmiPort

Overview

AtgJBNamingRmiPort: JBoss Naming RMI Object Port

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jboss_naming_rmi_port	settingValue

AtgJBPooledServerBindPort

Overview

AtgJBPooledServerBindPort: JBoss Pooled Server Bind Port

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jboss_pooled_server_bind_port	settingValue

AtgJBTcAjpPort

Overview

AtgJBTcAjpPort: Embedded Tomcat/JBoss AJP Port

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
ajpPort	settingValue

AtgJBTcHttpPort

Overview

AtgJBTcHttpPort: JBoss HTTP Port

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
httpPort	settingValue

AtgJBUIL2ServerBindPort

Overview

AtgJBUIL2ServerBindPort: JBoss UIL2 ServerBind Port

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jboss_uil2_server_bind_port	settingValue

AtgJBWSPort

Overview

AtgJBWSPort: JBoss WebServices Port

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
jboss_ws_port	settingValue

AtgJBossDocumentRoot

Overview

AtgJBossDocumentRoot: JBoss Document Root

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
documentRoot	settingValue

AtgDataDir

Overview

AtgDataDir: Directory path to ATG-Data dir

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
atg_data_dir	settingValue

AtgDynamoModules

Overview

AtgDynamoModules: Directory path to ATG-Data dir

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
atg_dynamo_modules	settingValue

AtgDynamoServerName

Overview

AtgDynamoServerName:

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
dynamo_server_name	settingValue

AtgJBossJavaOpts

Overview

AtgJBossJavaOpts: Set of Java options to include in the JBoss run.conf file

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
atgJBossJavaOpts	settingValue

AtgRmiPort

Overview

AtgRmiPort: Dynamo server RMI port value used in "localconfig/atg/dynamo/Configuration.properties".

Design

Super Type: AtgJBossSetting

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

Attributes

Exported Attributes

Name	Property
atgRmiPort	settingValue