JBossServer
A JBoss application server
- Overview
- Design
- Constraints
- Attributes
- Commands
-
Related Types
- AppTimezone
- JBBindAddr
- JBConfiguration
- JBJnpPort
- JBJrmpRmiObjectPort
- JBNamingRmiPort
- JBossDefaultInstance
- JBossDocumentRoot
- JBossExtractEar
- JBossHashDataSourcePasswords
- JBossHost
- JBossJavaHome
- JBossJavaOpts
- JBossPidfile
- JBossPortConfig
- JBossSetting
- JBPooledServerBindPort
- JBTcAjpPort
- JBTcHttpPort
- JBUIL2ServerBindPort
- JBWSPort
- JVMMaxHeap
- JVMMaxPermSize
- JVMMinHeap
- JVMPermSize
Overview
JBossServer: A JBoss application server
This type manages an instance of a JBoss Server.
A JavaZip object should be added as a child dependency to automate deployment of the jboss package distribution.
An example of managing JBoss server instances is here: JBoss Library.
See: JBoss Community.
Design
- 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 |
Constraints
Allowed Child Dependencies
- AppTimezone 1
- DefaultAllowMultiplePackageMatches
- JBBindAddr 1
- JBConfiguration 1
- JBJnpPort 1
- JBJrmpRmiObjectPort 1
- JBNamingRmiPort 1
- JBossDefaultInstance 1
- JBossDocumentRoot 1
- JBossEar
- JBossExtractEar 1
- JBossHashDataSourcePasswords 1
- JBossHost 1
- JBossJavaHome 1
- JBossJavaOpts 1
- JBossPidfile 1
- JBossPortConfig 1
- JBossZip 1
- JBPooledServerBindPort 1
- JBTcAjpPort 1
- JBTcHttpPort 1
- JBUIL2ServerBindPort 1
- JBWSPort 1
- JVMMaxHeap 1
- JVMMaxPermSize 1
- JVMMinHeap 1
- JVMPermSize 1
-
Rdb
Support datasource generation within the jboss server instance's deploy directory.
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Restrict JBossServer resources to JBossZip platform package, JBossEar packages, arbitrary jboss settings, and Rdb objects.
Allowed Parent Dependencies
-
JavaServiceWrapper
In support of windows java service capability.
- Node
- Site
Restrict JBossServer to Node, Site, and optionally a JavaServiceWrapper. for java/windows service support.
Allowed Property Values
| Property | Allowed Values | Default | Enforced |
|---|---|---|---|
| deployment-basedir |
|
|
false |
| deployment-install-root |
|
|
false |
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| jboss_basedir | deployment-basedir | associate the jboss_basedir attribute property with the standard deployment-basedir property. |
| jboss_install_root | deployment-install-root | associate the jboss_install_root attribute property with the standard deployment-install-root property. |
Defaults for Imported Attributes
| Name | Default | Description |
|---|---|---|
| defaultAllowMultiplePackageMatches | true | Default is true which allows us to assign more than one ear during Change-Dependencies operation. |
| deployDir | ${opts.basedir}/deploy | defaults to typical deploy directory |
| documentRoot | ${entity.attribute.jboss_basedir}/deploy/jbossweb-tomcat55.sar/ROOT.war | identify the DocumentRoot based on the integrated jboss tomcat webapp for potential deployable static content. |
| hashDataSourcePasswords | false | default to not hashing passwords |
| java_home | ${env.JAVA_HOME} | set a reasonable JAVA_HOME by using the user's environment. |
| javaOpts | optional JAVA_OPTS to be passed to the java runtime at startup | |
| jboss_extract_ear | false | set ear extraction behavior to false within the jboss instance deploy directory. |
| jboss_host | 0.0.0.0 | sets the jboss bind address to all interfaces as a resonable operational default. As of JBoss 4.2, the default behavior changes which is the loopback unless specified. |
| jbossDefaultInstance | default | set the jboss reference instance to the "default" instance. |
| jbossPidFile | ${entity.attribute.jboss_basedir}/conf/jboss.pid | Default location of the JBoss process-identifier file. |
| jvm_maxheap | -Xmx512m | use a small maximum heap setting in order not to break modest virtual machines, etc |
| jvm_minheap | -Xms256m | use a small minimum heap setting. |
| port_config | ports-default | use the default port configuration in the jboss service bindings configuration. |
| timezone | US/Pacific | set the jboss timezone to US Pacific time |
Commands
View the available commands in the User Reference.
Related Types
The following types are defined for use with JBossServer.
AppTimezone
Overview
AppTimezone: A appserver timezone
if set, applies the -Duser.timezone=<value> java runtime property at Configure time.
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
attribute containing the java runtime user.timezone property value
Exported Attributes
| Name | Property |
|---|---|
| timezone | settingValue |
JBBindAddr
Overview
JBBindAddr: JBoss Bind Address
Deprecated, see #JBossPortConfig
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 a 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 a JBoss Configuration
Deprecated, see #JBossPortConfig
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
Deprecated, see #JBossPortConfig
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
Deprecated, see #JBossPortConfig
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| jboss_naming_rmi_port | settingValue |
JBossDefaultInstance
Overview
JBossDefaultInstance: configure new jboss instance from a reference instance
The jboss instance directory, i.e. the JBossServer object's basedir, is configured from scratch based on a reference jboss instance. By default, this reference instance is the "default" instance residing under the JBOSS_HOME/server directory. At Deploy time, the Configure workflow will auto generate this server instance from the reference instance using recursive copy and filtering techniques. This assumes that the JBossServer base directory is not the same as the reference instance, otherwise this will not occur since we cannot copy a directory onto itself and in this case the server instance will be untouched. If the jboss "default" instance is not the desired reference instance, this can be overridden by this setting object. For example, this settingValue can be another instance such as "all" or "minimal".
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
attribute setting identifying the jboss reference instance to copy from when provisioning at Configure time.
Exported Attributes
| Name | Property |
|---|---|
| jbossDefaultInstance | 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 |
JBossExtractEar
Overview
JBossExtractEar: modify ear deployment behavior for the JBossServer to explode or not explode the ear within the jboss deploy directory
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| jboss_extract_ear | settingValue | "true" or "false" to respectively explode or not explode the ear |
JBossHashDataSourcePasswords
Overview
JBossHashDataSourcePasswords: determines if we hash database passwords into the login_config.xml or generate clear text passwords directly into datasource file
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| hashDataSourcePasswords | settingValue | true/false value determining whether datasources should be hashed or not |
JBossHost
Overview
JBossHost: Defines which interface jboss will bind to. 0.0.0.0 will bind to all interfaces
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| jboss_host | settingValue | specifies interface jboss will bind to. JBoss will bind to the loopback unless specified. This configuration will override this behavior to specify all interfaces via "0.0.0.0". |
JBossJavaHome
Overview
JBossJavaHome: JAVA_HOME for JBoss
Identifies the location of the java (jdk or jre) installation root typically referred to as JAVA_HOME.
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| java_home | settingValue | attribute setting containing the fully qualified path to the java installation root (i.e. JAVA_HOME). |
JBossJavaOpts
Overview
JBossJavaOpts: JAVA_OPTS for JBoss
To manage the allowed options (standard and non standard) that need to be passed to the java runtime when starting the jboss server.
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| javaOpts | settingValue | attribute setting containing the allowed java runtime options when starting jboss. |
JBossPidfile
Overview
JBossPidfile: jboss pid file location
Used to set the location of the JBoss process identifier file used to manage JBoss on Linux/Unix systems.
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| jbossPidFile | settingValue |
JBossPortConfig
Overview
JBossPortConfig: JBoss service bindings port configuration
Intent
Since JBoss has many different configuration files that refer to the various ports required to run a jboss server instance, ControlTier automates the JBossServer port configuration via the Service Binding Manager. This approach allows centralized management of the ports (which there are many of them) that conform to a standard port numbering convention. This unique set of ports is then indexed by a configuration name (i.e ports-default, ports-01, etc).
Discussion
For example, the "ports-default" configuration setting refers to the standard JBoss HTTP Listen port, 8080, HTTPS Listen Port, 8443, and the AJP Port, 8009, etc.
Another example, the "ports-01" configuration setting refers to JBoss HTTP Listen port, 8180, HTTPS Listen Port, 8543, and the AJP Port, 8109, etc.
Therefore, by accepting the conventions that JBoss encourages via the use of their Service Binding Manager, managing sets of ports through a single setting is achieved.
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| port_config | settingValue | attribute containing the desired port configuration within the Service Binding Manager. |
JBossSetting
Overview
JBossSetting: A JBoss Setting
Intent
Supertype to encapsulate related subtypes to support JBossServer service.
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Restrict setting objects of this type to be referred to by a JBossServer object.
JBPooledServerBindPort
Overview
JBPooledServerBindPort: JBoss Pooled Server Bind Port
Deprecated, see #JBossPortConfig
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
Deprecated, see #JBossPortConfig
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
Deprecated, see #JBossPortConfig
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
Deprecated, see #JBossPortConfig
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
Deprecated, see #JBossPortConfig
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| jboss_ws_port | settingValue |
JVMMaxHeap
Overview
JVMMaxHeap: JVM maximum heap size
If set, the java runtime maximum heap, i.e. -Xmx512m, will be applied at Configure time
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
attribute containing the java runtime maximum heap parameter.
Exported Attributes
| Name | Property |
|---|---|
| jvm_maxheap | settingValue |
JVMMaxPermSize
Overview
JVMMaxPermSize: JVM Max Perm Size memory setting
If set, the java runtime "Max Perm Size" setting is applied, i.e. -XX:MaxPermSize=256m, at Configure time
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
attribute containing the java runtime max permsize parameter
Exported Attributes
| Name | Property |
|---|---|
| jvm_max_perm_size | settingValue |
JVMMinHeap
Overview
JVMMinHeap: JVM minimum heap size
If set, the java runtime minimum heap, i.e. -Xms256m, will be applied at Configure time
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
attribute containing the java runtime mimimum heap parameter.
Exported Attributes
| Name | Property |
|---|---|
| jvm_minheap | settingValue |
JVMPermSize
Overview
JVMPermSize: JVM Perm Size memory setting
If set, the java runtime "Perm Size" setting is applied, i.e. -XX:PermSize=256m, at Configure time
Design
- Super Type
- JBossSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
attribute containing the java runtime permsize parameter
Exported Attributes
| Name | Property |
|---|---|
| jvm_perm_size | settingValue |