JBoss Community Documentation Page of 1 660
Admin Guide
Exported from JBoss Community Documentation Editor at 2012-07-30 05:22:52 EDT Copyright 2012 JBoss Community contributors.
Table of Contents
1 Target audience ___________________________________________________________________ 19 1.1 Prerequisites __________________________________________________________________ 19 1.2 Examples in this guide __________________________________________________________ 19 2 Management clients ________________________________________________________________ 20 2.1 Web Management Interface ______________________________________________________ 20 2.1.1 HTTP Management Endpoint ________________________________________________ 20 2.1.2 Accessing the web console _________________________________________________ 21 2.1.3 Default HTTP Management Interface Security __________________________________ 21 2.2 Command Line Interface _________________________________________________________ 23 2.2.1 Native Management Endpoint _______________________________________________ 23 2.2.2 Running the CLI __________________________________________________________ 23 2.2.3 Non-interactive Mode ______________________________________________________ 25 2.2.4 Operation Requests _______________________________________________________ 25 2.2.5 Command History ________________________________________________________ 29 2.2.6 Batch Processing _________________________________________________________ 30 2.2.7 Default HTTP Management Interface Security __________________________________ 31 2.3 Configuration Files _____________________________________________________________ 31 3 Core management concepts __________________________________________________________ 32 3.1 Operating modes _______________________________________________________________ 32 3.1.1 Standalone Server ________________________________________________________ 32 3.1.2 Managed Domain _________________________________________________________ 32 3.1.3 Deciding between running standalone servers or a managed domain ________________ 36 3.2 General configuration concepts ____________________________________________________ 36 3.2.1 Extensions ______________________________________________________________ 37 3.2.2 Profiles and Subsystems ___________________________________________________ 37 3.2.3 Paths __________________________________________________________________ 37 3.2.4 Interfaces _______________________________________________________________ 39 3.2.5 Socket Bindings and Socket Binding Groups ____________________________________ 40 3.2.6 System Properties ________________________________________________________ 40 3.3 Management resources __________________________________________________________ 40 3.3.1 Address ________________________________________________________________ 41 3.3.2 Operations ______________________________________________________________ 41 3.3.3 Attributes _______________________________________________________________ 44 3.3.4 Children ________________________________________________________________ 46 3.3.5 Descriptions _____________________________________________________________ 46 3.3.6 Comparison to JMX MBeans ________________________________________________ 48 3.3.7 Basic structure of the management resource trees _______________________________ 48 4 Management tasks _________________________________________________________________ 52 4.1 Interfaces and ports _____________________________________________________________ 52 4.1.1 Interface declarations ______________________________________________________ 52 4.1.2 Socket Binding Groups ____________________________________________________ 54 4.1.3 IPv4 versus IPv6 _________________________________________________________ 54
JBoss Community Documentation Page of 3 660 4.2 Configure Security Realms _______________________________________________________ 56 4.2.1 General Structure _________________________________________________________ 57 4.2.2 Enabling a Realm _________________________________________________________ 57 4.2.3 Authentication ___________________________________________________________ 59 4.2.4 Authorization ____________________________________________________________ 61 4.3 Out Of The Box Configuration _____________________________________________________ 61 4.3.1 Management Realm _______________________________________________________ 62 4.3.2 Application Realm ________________________________________________________ 62 4.3.3 add-user.sh _____________________________________________________________ 65 4.3.4 JMX ___________________________________________________________________ 72 4.4 Detailed Configuration ___________________________________________________________ 72 4.4.1 <server-identities /> _______________________________________________________ 73 4.4.2 <authentication /> _________________________________________________________ 74 4.4.3 <authorization /> _________________________________________________________ 79 4.4.4 <outbound-connection /> ___________________________________________________ 80 4.5 Plug Ins ______________________________________________________________________ 80 4.5.1 AuthenticationPlugIn ______________________________________________________ 81 4.5.2 AuthorizationPlugIn _______________________________________________________ 83 4.5.3 PlugInConfigurationSupport _________________________________________________ 83 4.5.4 Installing and Configuring a Plug-In ___________________________________________ 83 4.6 Example Configurations _________________________________________________________ 88 4.6.1 LDAP Authentication ______________________________________________________ 89 4.6.2 Enable SSL _____________________________________________________________ 90 4.6.3 Add Client-Cert to SSL _____________________________________________________ 91 4.7 JVM settings __________________________________________________________________ 91 4.7.1 Managed Domain _________________________________________________________ 91 4.7.2 Standalone Server ________________________________________________________ 93 4.8 Command line parameters _______________________________________________________ 93 4.8.1 System properties ________________________________________________________ 93 4.8.2 Other command line parameters _____________________________________________ 95 4.8.3 Controlling the Bind Address with -b __________________________________________ 97 4.8.4 Controlling the Default Multicast Address with -u ________________________________ 100 4.9 Subsystem configuration ________________________________________________________ 100 4.9.1 Data sources ___________________________________________________________ 101 4.9.2 Messaging _____________________________________________________________ 104 4.9.3 Web __________________________________________________________________ 111 4.9.4 Web services ___________________________________________________________ 118 4.10 Domain management __________________________________________________________ 118 4.10.1 Structure of the webservices subsystem ______________________________________ 119 4.11 Runtime information ___________________________________________________________ 123 4.12 Component Reference _________________________________________________________ 123 4.12.1 Logging _______________________________________________________________ 124 4.12.2 Overview ______________________________________________________________ 125 4.12.3 Default Log File Locations _________________________________________________ 126 4.12.4 Logging Subsystem Descriptions ____________________________________________ 126 4.12.5 JMX __________________________________________________________________ 137
4.12.6 OSGi _________________________________________________________________ 139 4.12.7 Deployment Scanner _____________________________________________________ 139 4.12.8 Simple configuration subsystems ____________________________________________ 142 4.13 Configuration file history ________________________________________________________ 142 4.13.1 Snapshots _____________________________________________________________ 143 4.13.2 Subsequent Starts _______________________________________________________ 145 4.14 Starting & stopping Servers in a Managed Domain ___________________________________ 145 4.15 Application deployment _________________________________________________________ 146 4.15.1 Managed Domain ________________________________________________________ 147 4.15.2 Standalone Server _______________________________________________________ 148 5 Domain setup ____________________________________________________________________ 154 5.1 Domain Controller Configuration __________________________________________________ 154 5.2 Host Controller Configuration ____________________________________________________ 155 5.3 Server groups ________________________________________________________________ 156 5.4 Servers _____________________________________________________________________ 158 5.4.1 JVM __________________________________________________________________ 159 6 Management API reference _________________________________________________________ 160 6.1 Global operations _____________________________________________________________ 160 6.1.1 The read-resource operation _______________________________________________ 160 6.1.2 The read-attribute operation ________________________________________________ 160 6.1.3 The write-attribute operation _______________________________________________ 161 6.1.4 The unset-attribute operation _______________________________________________ 161 6.1.5 The read-resource-description operation ______________________________________ 161 6.1.6 The read-operation-names operation _________________________________________ 161 6.1.7 The read-operation-description operation _____________________________________ 162 6.1.8 The read-children-types operation ___________________________________________ 162 6.1.9 The read-children-names operation __________________________________________ 162 6.1.10 The read-children-resources operation _______________________________________ 162 6.1.11 Standard Operations _____________________________________________________ 163 6.2 Detyped management and the jboss-dmr library _____________________________________ 163 6.2.1 ModelNode and ModelType ________________________________________________ 164 6.3 Description of the Management Model _____________________________________________ 175 6.3.1 Description of the JBoss Application Server Managed Resources __________________ 175 6.4 The native management API _____________________________________________________ 184 6.4.1 Native Management Client Dependencies _____________________________________ 185 6.4.2 Working with a ModelControllerClient ________________________________________ 185 6.4.3 Format of a Detyped Operation Request ______________________________________ 189 6.4.4 Format of a Detyped Operation Response ____________________________________ 195 7 CLI Recipes ______________________________________________________________________ 204 7.1 Properties ___________________________________________________________________ 204 7.1.1 Adding, reading and removing system property using CLI ________________________ 205 7.1.2 Overview of all system properties ___________________________________________ 206 7.2 Configuration _________________________________________________________________ 206 7.2.1 List Subsystems _________________________________________________________ 207 7.2.2 List description of available attributes and childs ________________________________ 207 7.2.3 View configuration as XML for domain model or host model _______________________ 209
JBoss Community Documentation Page of 5 660 7.2.4 Take a snapshot of what the current domain is _________________________________ 209 7.2.5 Take the latest snapshot of the host.xml for a particular host ______________________ 209 7.2.6 How to get interface address _______________________________________________ 210 7.3 Runtime _____________________________________________________________________ 211 7.3.1 Get all configuration and runtime details from CLI _______________________________ 211 7.4 Scripting ____________________________________________________________________ 211 7.4.1 Windows and "Press any key to continue ..." issue ______________________________ 211 7.5 Statistics ____________________________________________________________________ 211 7.5.1 Read statistics of active datasources _________________________________________ 211 8 All JBoss AS 7 documentation _______________________________________________________ 212 9 CLI Recipes ______________________________________________________________________ 213 9.1 Properties ___________________________________________________________________ 213 9.1.1 Adding, reading and removing system property using CLI ________________________ 214 9.1.2 Overview of all system properties ___________________________________________ 215 9.2 Configuration _________________________________________________________________ 215 9.2.1 List Subsystems _________________________________________________________ 216 9.2.2 List description of available attributes and childs ________________________________ 216 9.2.3 View configuration as XML for domain model or host model _______________________ 218 9.2.4 Take a snapshot of what the current domain is _________________________________ 218 9.2.5 Take the latest snapshot of the host.xml for a particular host ______________________ 218 9.2.6 How to get interface address _______________________________________________ 219 9.3 Runtime _____________________________________________________________________ 220 9.3.1 Get all configuration and runtime details from CLI _______________________________ 220 9.4 Scripting ____________________________________________________________________ 220 9.4.1 Windows and "Press any key to continue ..." issue ______________________________ 220 9.5 Statistics ____________________________________________________________________ 220 9.5.1 Read statistics of active datasources _________________________________________ 220 10 Core management concepts _________________________________________________________ 221 10.1 Operating modes ______________________________________________________________ 221 10.1.1 Standalone Server _______________________________________________________ 221 10.1.2 Managed Domain ________________________________________________________ 221 10.1.3 Deciding between running standalone servers or a managed domain _______________ 225 10.2 General configuration concepts ___________________________________________________ 225 10.2.1 Extensions _____________________________________________________________ 226 10.2.2 Profiles and Subsystems __________________________________________________ 226 10.2.3 Paths _________________________________________________________________ 226 10.2.4 Interfaces ______________________________________________________________ 228 10.2.5 Socket Bindings and Socket Binding Groups ___________________________________ 229 10.2.6 System Properties _______________________________________________________ 229 10.3 Management resources _________________________________________________________ 229 10.3.1 Address _______________________________________________________________ 230 10.3.2 Operations _____________________________________________________________ 230 10.3.3 Attributes ______________________________________________________________ 233 10.3.4 Children _______________________________________________________________ 235 10.3.5 Descriptions ____________________________________________________________ 235 10.3.6 Comparison to JMX MBeans _______________________________________________ 237
10.3.7 Basic structure of the management resource trees ______________________________ 237 10.4 General configuration concepts ___________________________________________________ 240 10.4.1 Extensions _____________________________________________________________ 240 10.4.2 Profiles and Subsystems __________________________________________________ 240 10.4.3 Paths _________________________________________________________________ 240 10.4.4 Interfaces ______________________________________________________________ 242 10.4.5 Socket Bindings and Socket Binding Groups ___________________________________ 243 10.4.6 System Properties _______________________________________________________ 243 10.5 Management resources _________________________________________________________ 243 10.5.1 Address _______________________________________________________________ 244 10.5.2 Operations _____________________________________________________________ 244 10.5.3 Attributes ______________________________________________________________ 247 10.5.4 Children _______________________________________________________________ 249 10.5.5 Descriptions ____________________________________________________________ 249 10.5.6 Comparison to JMX MBeans _______________________________________________ 251 10.5.7 Basic structure of the management resource trees ______________________________ 251 10.6 Operating modes ______________________________________________________________ 254 10.6.1 Standalone Server _______________________________________________________ 254 10.6.2 Managed Domain ________________________________________________________ 254 10.6.3 Deciding between running standalone servers or a managed domain _______________ 258 11 Domain Setup ____________________________________________________________________ 259 11.1 Domain Controller Configuration __________________________________________________ 259 11.2 Host Controller Configuration ____________________________________________________ 260 11.3 Server groups ________________________________________________________________ 261 11.4 Servers _____________________________________________________________________ 263 11.4.1 JVM __________________________________________________________________ 264 12 Management API reference _________________________________________________________ 265 12.1 Global operations _____________________________________________________________ 265 12.1.1 The read-resource operation _______________________________________________ 265 12.1.2 The read-attribute operation ________________________________________________ 265 12.1.3 The write-attribute operation _______________________________________________ 266 12.1.4 The unset-attribute operation _______________________________________________ 266 12.1.5 The read-resource-description operation ______________________________________ 266 12.1.6 The read-operation-names operation _________________________________________ 266 12.1.7 The read-operation-description operation _____________________________________ 267 12.1.8 The read-children-types operation ___________________________________________ 267 12.1.9 The read-children-names operation __________________________________________ 267 12.1.10The read-children-resources operation _______________________________________ 267 12.1.11Standard Operations _____________________________________________________ 268 12.2 Detyped management and the jboss-dmr library _____________________________________ 268 12.2.1 ModelNode and ModelType ________________________________________________ 269 12.3 Description of the Management Model _____________________________________________ 280 12.3.1 Description of the JBoss Application Server Managed Resources __________________ 280 12.4 The native management API _____________________________________________________ 289 12.4.1 Native Management Client Dependencies _____________________________________ 290 12.4.2 Working with a ModelControllerClient ________________________________________ 290
JBoss Community Documentation Page of 7 660 12.4.3 Format of a Detyped Operation Request ______________________________________ 294 12.4.4 Format of a Detyped Operation Response ____________________________________ 300 12.5 Description of the Management Model _____________________________________________ 308 12.5.1 Description of the JBoss Application Server Managed Resources __________________ 309 12.6 Detyped management and the jboss-dmr library _____________________________________ 317 12.6.1 ModelNode and ModelType ________________________________________________ 318 12.7 Global operations _____________________________________________________________ 330 12.7.1 The read-resource operation _______________________________________________ 331 12.7.2 The read-attribute operation ________________________________________________ 331 12.7.3 The write-attribute operation _______________________________________________ 331 12.7.4 The unset-attribute operation _______________________________________________ 332 12.7.5 The read-resource-description operation ______________________________________ 332 12.7.6 The read-operation-names operation _________________________________________ 332 12.7.7 The read-operation-description operation _____________________________________ 332 12.7.8 The read-children-types operation ___________________________________________ 332 12.7.9 The read-children-names operation __________________________________________ 333 12.7.10The read-children-resources operation _______________________________________ 333 12.7.11Standard Operations _____________________________________________________ 334 12.8 The HTTP management API _____________________________________________________ 334 12.9 The native management API _____________________________________________________ 336 12.9.1 Native Management Client Dependencies _____________________________________ 337 12.9.2 Working with a ModelControllerClient ________________________________________ 337 12.9.3 Format of a Detyped Operation Request ______________________________________ 340 12.9.4 Format of a Detyped Operation Response ____________________________________ 346 13 Management Clients _______________________________________________________________ 355 13.1 Web Management Interface _____________________________________________________ 355 13.1.1 HTTP Management Endpoint _______________________________________________ 355 13.1.2 Accessing the web console ________________________________________________ 356 13.1.3 Default HTTP Management Interface Security _________________________________ 356 13.2 Command Line Interface ________________________________________________________ 358 13.2.1 Native Management Endpoint ______________________________________________ 358 13.2.2 Running the CLI _________________________________________________________ 358 13.2.3 Non-interactive Mode _____________________________________________________ 360 13.2.4 Operation Requests ______________________________________________________ 360 13.2.5 Command History _______________________________________________________ 364 13.2.6 Batch Processing ________________________________________________________ 365 13.2.7 Default HTTP Management Interface Security _________________________________ 366 13.3 Configuration Files ____________________________________________________________ 366 13.4 Default HTTP Interface Security __________________________________________________ 366 13.5 Default Native Interface Security __________________________________________________ 369 14 Management tasks ________________________________________________________________ 370 14.1 Interfaces and ports ____________________________________________________________ 370 14.1.1 Interface declarations _____________________________________________________ 370 14.1.2 Socket Binding Groups ___________________________________________________ 372 14.1.3 IPv4 versus IPv6 ________________________________________________________ 372 14.2 Configure Security Realms ______________________________________________________ 374
14.2.1 General Structure ________________________________________________________ 375 14.2.2 Enabling a Realm ________________________________________________________ 375 14.2.3 Authentication __________________________________________________________ 377 14.2.4 Authorization ___________________________________________________________ 379 14.3 Out Of The Box Configuration ____________________________________________________ 379 14.3.1 Management Realm ______________________________________________________ 380 14.3.2 Application Realm _______________________________________________________ 380 14.3.3 add-user.sh ____________________________________________________________ 383 14.3.4 JMX __________________________________________________________________ 390 14.4 Detailed Configuration __________________________________________________________ 390 14.4.1 <server-identities /> ______________________________________________________ 391 14.4.2 <authentication /> ________________________________________________________ 392 14.4.3 <authorization /> ________________________________________________________ 397 14.4.4 <outbound-connection /> __________________________________________________ 398 14.5 Plug Ins _____________________________________________________________________ 398 14.5.1 AuthenticationPlugIn _____________________________________________________ 399 14.5.2 AuthorizationPlugIn ______________________________________________________ 401 14.5.3 PlugInConfigurationSupport ________________________________________________ 401 14.5.4 Installing and Configuring a Plug-In __________________________________________ 401 14.6 Example Configurations ________________________________________________________ 406 14.6.1 LDAP Authentication _____________________________________________________ 407 14.6.2 Enable SSL ____________________________________________________________ 408 14.6.3 Add Client-Cert to SSL ____________________________________________________ 409 14.7 JVM settings _________________________________________________________________ 409 14.7.1 Managed Domain ________________________________________________________ 409 14.7.2 Standalone Server _______________________________________________________ 411 14.8 Command line parameters ______________________________________________________ 411 14.8.1 System properties _______________________________________________________ 411 14.8.2 Other command line parameters ____________________________________________ 413 14.8.3 Controlling the Bind Address with -b _________________________________________ 415 14.8.4 Controlling the Default Multicast Address with -u ________________________________ 418 14.9 Subsystem configuration ________________________________________________________ 418 14.9.1 Data sources ___________________________________________________________ 419 14.9.2 Messaging _____________________________________________________________ 422 14.9.3 Web __________________________________________________________________ 429 14.9.4 Web services ___________________________________________________________ 436 14.10Domain management __________________________________________________________ 436 14.10.1Structure of the webservices subsystem ______________________________________ 437 14.11Runtime information ___________________________________________________________ 441 14.12Component Reference _________________________________________________________ 441 14.12.1Logging _______________________________________________________________ 442 14.12.2Overview ______________________________________________________________ 443 14.12.3Default Log File Locations _________________________________________________ 444 14.12.4Logging Subsystem Descriptions ___________________________________________ 444 14.12.5JMX __________________________________________________________________ 455 14.12.6OSGi _________________________________________________________________ 457
JBoss Community Documentation Page of 9 660 14.12.7Deployment Scanner _____________________________________________________ 457 14.12.8Simple configuration subsystems ___________________________________________ 460 14.13Configuration file history ________________________________________________________ 460 14.13.1Snapshots _____________________________________________________________ 461 14.13.2Subsequent Starts _______________________________________________________ 463 14.14Starting & stopping Servers in a Managed Domain ___________________________________ 463 14.15Application deployment ________________________________________________________ 464 14.15.1Managed Domain _______________________________________________________ 465 14.15.2Standalone Server _______________________________________________________ 466 14.16Application deployment ________________________________________________________ 471 14.16.1Managed Domain _______________________________________________________ 471 14.16.2Standalone Server _______________________________________________________ 473 14.17Command line parameters ______________________________________________________ 478 14.17.1System properties _______________________________________________________ 478 14.17.2Other command line parameters ____________________________________________ 480 14.17.3Controlling the Bind Address with -b _________________________________________ 482 14.17.4Controlling the Default Multicast Address with -u _______________________________ 485 14.18Configuration file history ________________________________________________________ 485 14.18.1Snapshots _____________________________________________________________ 486 14.18.2Subsequent Starts _______________________________________________________ 488 14.19Interfaces and ports ___________________________________________________________ 488 14.19.1Interface declarations ____________________________________________________ 489 14.19.2Socket Binding Groups ___________________________________________________ 491 14.19.3IPv4 versus IPv6 ________________________________________________________ 491 14.20JVM settings _________________________________________________________________ 493 14.20.1Managed Domain _______________________________________________________ 493 14.20.2Standalone Server _______________________________________________________ 495 14.21Security Realms ______________________________________________________________ 495 14.21.1General Structure _______________________________________________________ 496 14.21.2Enabling a Realm _______________________________________________________ 496 14.21.3Authentication __________________________________________________________ 498 14.21.4Authorization ___________________________________________________________ 500 14.21.5Out Of The Box Configuration ______________________________________________ 500 14.21.6Detailed Configuration ____________________________________________________ 510 14.21.7Plug Ins _______________________________________________________________ 518 14.21.8Example Configurations __________________________________________________ 525 14.21.9add-user utility __________________________________________________________ 528 14.21.10Detailed Configuration ___________________________________________________ 533 14.21.11Examples _____________________________________________________________ 541 14.21.12Plug Ins ______________________________________________________________ 544 14.22Starting & stopping Servers in a Managed Domain ___________________________________ 551 14.23Subsystem configuration _______________________________________________________ 553 14.23.1Data sources ___________________________________________________________ 553 14.23.2Messaging _____________________________________________________________ 557 14.23.3Web __________________________________________________________________ 564 14.23.4Web services ___________________________________________________________ 571
14.23.5Domain management ____________________________________________________ 571 14.23.6Runtime information _____________________________________________________ 576 14.23.7Component Reference ___________________________________________________ 576 14.23.8DataSource configuration _________________________________________________ 595 14.23.9Deployment Scanner configuration __________________________________________ 599 14.23.10JMX subsystem configuration _____________________________________________ 602 14.23.11Logging Configuration ___________________________________________________ 604 14.23.12Messaging configuration _________________________________________________ 619 14.23.13OSGi subsystem configuration ____________________________________________ 626 14.23.14Resource adapters _____________________________________________________ 626 14.23.15Security subsystem configuration __________________________________________ 628 14.23.16Simple configuration subsystems __________________________________________ 640 14.23.17Web services configuration _______________________________________________ 640 14.23.18Web subsystem configuration _____________________________________________ 645 15 Target Audience __________________________________________________________________ 660 15.1 Prerequisites _________________________________________________________________ 660 15.2 Examples in this guide _________________________________________________________ 660
JBoss Community Documentation Page 11 of 660 Target audience
Prerequisites
Examples in this guide Management clients
Web Management Interface
HTTP Management Endpoint Accessing the web console
Default HTTP Management Interface Security Command Line Interface
Native Management Endpoint Running the CLI
Non-interactive Mode Operation Requests
Addressing resources
Available Operation Types and Descriptions Command History
Batch Processing
Default HTTP Management Interface Security Configuration Files
Core management concepts Operating modes Standalone Server Managed Domain Host Host Controller Domain Controller Server Group Server
Deciding between running standalone servers or a managed domain
General configuration concepts Extensions
Profiles and Subsystems Paths
Interfaces
Socket Bindings and Socket Binding Groups System Properties Management resources Address Operations Attributes Children Descriptions Comparison to JMX MBeans
Basic structure of the management resource trees Standalone server
Managed domain Management tasks
Interfaces and ports
Interface declarations Socket Binding Groups IPv4 versus IPv6
Stack and address preference IP address literals
Configure Security Realms General Structure Enabling a Realm Inbound Connections Management Interfaces Remoting Subsystem Outbound Connections Remoting Subsystem Slave Domain Controller Authentication
JBoss Community Documentation Page 13 of 660 Out Of The Box Configuration
Management Realm Application Realm
Authentication Authorization
other security domain add-user.sh Adding a User A Management User Interactive Mode Non-Interactive Mode An Application User Interactive Mode Non-Interactive Mode Updating a User A Management User Interactive Mode Non-Interactive Mode An Application User Interactive Mode Non-Interactive Mode Community Contributions JMX Detailed Configuration <server-identities /> <ssl /> <secret /> <authentication /> <truststore /> <local /> <jaas /> <ldap /> <username-filter /> <advanced-filter /> <properties /> <users /> <authorization /> <properties /> <outbound-connection /> <ldap />
Plug Ins AuthenticationPlugIn PasswordCredential DigestCredential ValidatePasswordCredential AuthorizationPlugIn PlugInConfigurationSupport Installing and Configuring a Plug-In
PlugInProvider Package as a Module The AuthenticationPlugIn The AuthorizationPlugIn
Forcing Plain Text Authentication Example Configurations LDAP Authentication Enable SSL Add Client-Cert to SSL JVM settings Managed Domain Standalone Server Command line parameters
System properties Standalone Managed Domain
Other command line parameters Standalone
Managed Domain Common parameters
Controlling the Bind Address with -b
JBoss Community Documentation Page 15 of 660 Subsystem configuration
Data sources
JDBC Driver Installation Datasource Definitions Using security domains Deployment of -ds.xml files Component Reference Messaging
Connection Factories JMS Queues and Topics Dead Letter & Redelivery Security Settings Deployment of -jms.xml files Component Reference Web Container configuration JSP Configuration Connector configuration HTTP Connectors HTTPS Connectors AJP Connectors Native Connectors Virtual-Server configuration Component Reference Web services Domain management
Structure of the webservices subsystem Published endpoint address Predefined endpoint configurations
Endpoint configs Handler chains Handlers Runtime information
Component Reference Logging
Overview
Why is there a logging.properties file? Default Log File Locations
Managed Domain Standalone Server Logging Subsystem Descriptions
root-logger logger async-handler console-handler file-handler periodic-rotating-file-handler size-rotating-file-handler custom-handler JMX OSGi Deployment Scanner
Simple configuration subsystems Configuration file history
Snapshots
Subsequent Starts
Starting & stopping Servers in a Managed Domain Application deployment Managed Domain Deployment Commands Content Repository Standalone Server Deployment Commands File System Deployments
Deployment Modes Marker Files Domain setup
Domain Controller Configuration Host Controller Configuration Server groups
Servers JVM
JBoss Community Documentation Page 17 of 660 Global operations
The read-resource operation The read-attribute operation The write-attribute operation The unset-attribute operation
The read-resource-description operation The read-operation-names operation
The read-operation-description operation The read-children-types operation
The read-children-names operation The read-children-resources operation Standard Operations
The add operation The remove operation
Detyped management and the jboss-dmr library ModelNode and ModelType
Basic ModelNode manipulation Lists
Properties
ModelType.OBJECT ModelType.EXPRESSION ModelType.TYPE
Full list of ModelNode types
Text representation of a ModelNode
JSON representation of a ModelNode
Description of the Management Model
Description of the JBoss Application Server Managed Resources Description of an Attribute
Description of an Operation
Description of an Operation Parameter or Return Value Arbitrary Descriptors
Description of Parent/Child Relationships Applying Updates to Runtime Services
The native management API
Native Management Client Dependencies Working with a ModelControllerClient
Creating the ModelControllerClient
Creating an operation request object
Execute the operation and manipulate the result: Close the ModelControllerClient
Format of a Detyped Operation Request Simple Operations
Operation Headers Composite Operations
Operations with a Rollout Plan Default Rollout Plan
Format of a Detyped Operation Response Simple Responses
Response Headers
Basic Composite Operation Responses Multi-Server Responses
CLI Recipes Properties
Adding, reading and removing system property using CLI Overview of all system properties
Configuration
List Subsystems
List description of available attributes and childs
View configuration as XML for domain model or host model Take a snapshot of what the current domain is
Take the latest snapshot of the host.xml for a particular host How to get interface address
Runtime
Get all configuration and runtime details from CLI Scripting
Windows and "Press any key to continue ..." issue Statistics
Read statistics of active datasources All JBoss AS 7 documentation
JBoss Community Documentation Page 19 of 660
1 Target audience
This document is intended for people who need to setup and configure JBoss Application Server (AS) 7.
1.1 Prerequisites
You should know how to download, install and run JBoss Application Server 7. If not please consult the " ".
Getting Started Guide
1.2 Examples in this guide
Most of the examples in this guide are being expressed as excerpts of the XML configuration files or by using a representation of the de-typed management model.
2 Management clients
JBoss AS 7 offers three different approaches to configure and manage servers: A web interface, a command line client and a set of XML configuration files. No matter what approach you chose, the configuration is always synchronized across the different views and finally persisted to the XML files.
2.1 Web Management Interface
The web interface is a GWT application that uses the HTTP management API to configure a management domain or standalone server.
2.1.1 HTTP Management Endpoint
The HTTP API endpoint is the entry point for management clients that rely on the HTTP protocol to integrate with the management layer. It uses a JSON encoded protocol and a de-typed, RPC style API to describe and execute management operations against a managed domain or standalone server. It's used by the web console, but offers integration capabilities for a wide range of other clients too.
The HTTP API endpoint is co-located with either the domain controller or a standalone server. By default, it runs on port 9990: <management-interfaces> [...] <http-interface security-realm="ManagementRealm"> <socket-binding http="management-http"/> </http-interface> <management-interfaces>
(See standalone/configuration/standalone.xml or domain/configuration/host.xml)
The HTTP API Endpoint serves two different contexts. One for executing management operations and another one that allows you to access the web interface:
Domain API: http://<host>:9990/management Web Console: http://<host>:9990/console
JBoss Community Documentation Page 21 of 660
2.1.2 Accessing the web console
The web console is served through the same port as the HTTP management API. It can be accessed by pointing your browser to:
http://<host>:9990/console
Default URL
By default the web interface can be accessed here: http://localhost:9990/console.
2.1.3 Default HTTP Management Interface Security
By default JBoss AS 7.1.x is now distributed secured by default, the default security mechanism is username / password based making use of HTTP Digest for the authentication process.
The reason for securing the server by default is so that if the management interfaces are accidentally
exposed on a public IP address authentication is required to connect - for this reason there is no default user in the distribution.
If you attempt to connect to the admin console before you have added a user to the server you will be presented with the following screen.
The user are stored in a properties file called mgmt-users.properties under standalone/configuration and domain/configuration depending on the running mode of the server, these files contain the users username along with a pre-prepared hash of the username along with the name of the realm and the users password.
Although the properties files do not contain the plain text passwords they should still be guarded as the pre-prepared hashes could be used to gain access to any server with the same realm if the same user has used the same password.
To manipulate the files and add users we provide a utility add-user.sh and add-user.bat to add the users and generate the hashes, to add a user you should execute the script and follow the guided process.
The full details of the add-user utility are described later but for the purpose of accessing the management interface you need to enter the following values:
-Type of user - This will be a 'Management User' to selection option a.
Realm - This MUST match the realm name used in the configuration so unless you have changed the configuration to use a different realm name leave this set as 'ManagementRealm'.
Username - The username of the user you are adding. Password - The users password.
Provided the validation passes you will then be asked to confirm you want to add the user and the properties files will be updated.
For the final question, as this is a user that is going to be accessing the admin console just answer 'n' - this option will be described later for adding slave host controllers that authenticate against a master domain controller but that is a later topic.
JBoss Community Documentation Page 23 of 660 Updates to the properties file are picked up in real time so either click 'Try Again' on the error page that was displayed in the browser or navigate to the console again and you should then be prompted to enter the username and password to connect to the server.
2.2 Command Line Interface
The Command Line Interface (CLI) is a management tool for a managed domain or standalone server. It allows a user to connect to the domain controller or a standalone server and execute management operations available through the de-typed management model.
2.2.1 Native Management Endpoint
The native API endpoint is the entry point for management clients that rely on the AS's native protocol to integrate with the management layer. It uses an open binary protocol and an RPC style API based on a very small number of Java types to describe and execute management operations against a managed domain or standalone server. It's used by the CLI management tool, but offers integration capabilities for a wide range of other clients too.
The native API endpoint is co-located with either the a host controller or a standalone server. To use the CLI it must be enabled. By default, it runs on port 9999:
<management-interfaces> <native-interface security-realm="ManagementRealm"> <socket-binding native="management-native"/> </native-interface> </native-interf [...] <management-interfaces>
(See standalone/configuration/standalone.xml or domain/configuration/host.xml)
2.2.2 Running the CLI
Depending on the operating system, the CLI is launched using jboss-cli.sh or jboss-cli.bat located in the JBoss AS 7 bin directory. For further information on the default directory structure, please consult the "Getting Started Guide"
The first thing to do after the CLI has started is to connect to a managed JBoss AS 7 instance. This is done using the command connect, e.g.
./bin/jboss-cli.sh
You are disconnected at the moment. Type 'connect' to connect to the server or 'help' for the list of supported commands.
[disconnected /]
[disconnected /] connect
Connected to domain controller at localhost:9999
[domain@localhost:9999 /] quit Closed connection to localhost:9999
is the default host and port combination for the JBoss AS 7 domain controller client. localhost:9999
The host and the port of the server can be provided as an optional parameter, if the server is not listening on localhost:9999.
./bin/jboss-cli.sh
You are disconnected at the moment. Type 'connect' to connect to the server [disconnected /] connect 192.168.0.10:9999
Connected to standalone controller at 192.168.0.1:9999
The :9999 is not required as the CLI will use port 9999 by default. The port needs to be provided if the server is listening on some other port.
To terminate the session type quit.
The jboss-cli script accepts a --connect parameter: ./jboss-cli.sh --connect
The --controller parameter can be used to specify the host and port of the server: ./jboss-cli.sh --connect --controller=192.168.0.1:9999
JBoss Community Documentation Page 25 of 660 [domain@localhost:9999 /] help
Supported commands:
cn (or cd) - change the current node path to the argument; connect - connect to the specified host and port; deploy - deploy an application;
help (or h) - print this message;
history - print or disable/enable/clear the history expansion. ls - list the contents of the node path;
pwn (or pwd) - prints the current working node; quit (or q) - quit the command line interface; undeploy - undeploy an application;
version - prints the version and environment information.
add-jms-queue - creates a new JMS queue remove-jms-queue - removes an existing JMS queue add-jms-topic - creates a new JMS topic remove-jms-topic - removes an existing JMS topic
add-jms-cf - creates a new JMS connection factory remove-jms-cf - removes an existing JMS connection factory
data-source - allows to add new, modify and remove existing data sources xa-data-source - allows to add new, modify and remove existing XA data sources
For a more detailed description of a specific command, execute the command with '--help' as the argument.
2.2.3 interactive Mode
The CLI can also be run in non-interactive mode to support scripts and other types of command line or batch processing. The --command and --commands arguments can be used to pass a command or a list of commands to execute. Additionally a --file argument is supported which enables CLI commands to be provided from a text file.
For example the following command can be used to list all the current deployments
$ ./bin/jboss-cli.sh --connect --commands=ls\ deployment sample.war
osgi-bundle.jar
The output can be combined with other shell commands for further processing, for example to find out what .war files are deployed:
$ ./bin/jboss-cli.sh --connect --commands=ls\ deployment | grep war sample.war
2.2.4 Operation Requests
Operation requests allow for low level interaction with the management model. They are different from the high level commands (i.e. create-jms-queue) in that they allow you to read and modify the server
configuration as if you were editing the XML configuration files directly. The configuration is represented as a tree of addressable resources, where each node in the tree (aka resource) offers a set of operations to execute.
An operation request basically consists of three parts: The address, an operation name and an optional set of parameters.
The formal specification for an operation request is:
[/node-type=node-name (/node-type=node-name)*] : operation-name [( [parameter-name=parameter-value (,parameter-name=parameter-value)*] )]
For example:
/profile=production/subsystem=threads/bounded-queue-thread-pool=pool1:write-core-threads (count=0, per-cpu=20)
Tab Completion
Tab-completion is supported for all commands and options, i.e. node-types and node-names, operation names and parameter names. We are also considering adding aliases that are less verbose for the user, and will translate into the corresponding operation requests in the background.
JBoss Community Documentation Page 27 of 660
Addressing resources
Operation requests might not always have the address part or the parameters. E.g.
:read-resource
which will list all the node types for the current node.
To syntactically disambiguate between the commands and operations, operations require one of the following prefixes:
To execute an operation against the current node, e.g.
cd subsystem=web
:read-resource(recursive="true")
To execute an operation against a child node of the current node, e.g.
cd subsystem=web
./connector=http:read-resource
To execute an operation against the root node, e.g.
/subsystem=threads:read-resource
Available Operation Types and Descriptions
The operation types can be distinguished between common operations that exist on any node and specific operations that belong to a particular configuration resource (i.e. subsystem). The common operations are:
add read-attribute read-children-names read-children-resources read-children-types read-operation-description read-operation-names read-resource read-resource-description remove validate-address write-attribute
For a list of specific operations (e.g. operations that relate to the logging subsystem) you can always query the model itself. For example, to read the operations supported by the logging subsystem resource on a standalone server: [[standalone@localhost:9999 /] /subsystem=logging:read-operation-names { "outcome" => "success", "result" => [ "add", "change-root-log-level", "read-attribute", "read-children-names", "read-children-resources", "read-children-types", "read-operation-description", "read-operation-names", "read-resource", "read-resource-description", "remove-root-logger", "root-logger-assign-handler", "root-logger-unassign-handler", "set-root-logger", "validate-address", "write-attribute" ] }
As you can see, the logging resource offers four additional operations, namely root-logger-assign-handler,
, and .
root-logger-unassign-handler set-root-logger remove-root-logger
Further documentation about a resource or operation can be retrieved through the description:
[standalone@localhost:9999 /] /subsystem=logging:read-operation-description(name=change-root-log-level) { "outcome" => "success", "result" => { "operation-name" => "change-root-log-level", "description" => "Change the root logger level.", "request-properties" => {"level" => {
"type" => STRING,
"description" => "The log level specifying which message levels will be logged by this logger.
Message levels lower than this value will be discarded.", "required" => true
}} } }
JBoss Community Documentation Page 29 of 660
Full model
To see the full model enter :read-resource(recursive=true).
2.2.5 Command History
Command (and operation request) history is enabled by default. The history is kept both in-memory and in a file on the disk, i.e. it is preserved between the command line sessions. The history file name is
.jboss-cli-history and is automatically created in the user's home directory. When the command line interface is launched this file is read and the in-memory history is initialized with its content.
While in the command line session, you can use the arrow keys to go back and forth in the history of commands and operations.
To manipulate the history you can use history command. If executed without any arguments, it will print all the recorded commands and operations (up to the configured maximum, which defaults to 500) from the in-memory history.
supports three optional arguments:
history
- will disable history expansion (but will not clear the previously recorded history);
disable
- will re-enable history expansion (starting from the last recorded command before the history
enabled
expansion was disabled);
- will clear the in-memory history (but not the file one).
2.2.6 Batch Processing
The batch mode allows one to group commands and operations and execute them together as an atomic unit. If at least one of the commands or operations fails, all the other successfully executed commands and operations in the batch are rolled back.
Not all of the commands are allowed in the batch. For example, commands like cd ls help, , , etc. are not allowed in the batch since they don't translate into operation requests. Only the commands that translate into operation requests are allowed in the batch. The batch, actually, is executed as a composite operation request.
The batch mode is entered by executing command batch.
[standalone@localhost:9999 /] batch
[standalone@localhost:9999 / #] /subsystem=datasources/data-source="java\:\/H2DS":enable [standalone@localhost:9999 / #] /subsystem=messaging/jms-queue="newQueue":add
You can execute a batch using the run-batch command:
[standalone@localhost:9999 / #] run-batch The batch executed successfully.
Exit the batch edit mode without losing your changes:
[standalone@localhost:9999 / #] holdback-batch [standalone@localhost:9999 /]
Then activate it later on again:
[standalone@localhost:9999 /] batch Re-activated batch
#1 /subsystem=datasources/data-source=java:/H2DS:\/H2DS:enable
There are several other notable batch commands available as well (tab complete to see the list):
clear-batch
(e.g. )
edit-batch-line edit-batch line 3 create-jms-topic name=mytopic
(e.g. )
remove-batch-line remove-batch-line 3
(e.g. )
move-batch-line move-batch-line 3 1 discard-batch
JBoss Community Documentation Page 31 of 660
2.2.7 Default HTTP Management Interface Security
The native interface shares the same security configuration as the http interface, however we also support a local authentication mechanism which means that the CLI can authenticate against the local AS instance without prompting the user for a username and password. This mechanism only works if the user running the CLI has read access to the standalone/tmp/auth folder or domain/tmp/auth folder under the respective AS installation - if the local mechanism fails then the CLI will fallback to prompting for a username and password for a user configured as in Default HTTP Interface Security.
Establishing a CLI connection to a remote server will require a username and password by default.
2.3 Configuration Files
The XML configuration for a management domain and a standalone server can be found in the subdirectory:
configuration
domain/configuration/domain.xml domain/configuration/host.xml
standalone/configuration/standalone.xml
A managed domain actually ships with two different configuration types: One for the domain as a whole ( ) and and another for each host that joins the domain ( ). A detailed explanation how
domain.xml host.xml
to setup a domain topology can be found in the chapter "Domain Setup".
The XML configuration files act as a central, authoritative source of configuration. Any configuration changes made via the web interface or the CLI are persisted back to the XML configuration files. If a domain or standalone server is offline, the XML configuration files can be hand edited as well, and any changes will be picked up when the domain or standalone server is next started. However, users are encouraged to use the web interface or the CLI in preference to making offline edits to the configuration files. External changes made to the configuration files while processes are running will not be detected, and may be overwritten.
3 Core management concepts
3.1 Operating modes
JBoss Application Server 7 can be booted in two different modes. A managed domain allows you to run and manage a multi-server topology. Alternatively, you can run a standalone server instance.
3.1.1 Standalone Server
For many use cases, the centralized management capability available via a managed domain is not
necessary. For these use cases, a JBoss Application Server 7 instance can be run as a "standalone server". A standalone server instance is an independent process, much like an JBoss Application Server 3, 4, 5, or 6 instance is. Standalone instances can be launched via the standalone.sh or standalone.bat launch scripts.
If more than one standalone instance is launched and multi-server management is desired, it is the user's responsibility to coordinate management across the servers. For example, to deploy an application across all of the standalone servers, the user would need to individually deploy the application on each server.
It is perfectly possible to launch multiple standalone server instances and have them form an HA cluster, just like it was possible with JBoss Application Server 3, 4, 5 and 6.
3.1.2 Managed Domain
One of the primary new features of JBoss Application Server 7 is the ability to manage multiple JBoss Application Server 7 instances from a single control point. A collection of such servers is referred to as the members of a "domain" with a single Domain Controller process acting as the central management control point. All of the JBoss Application Server 7 instances in the domain share a common management policy, with the Domain Controller acting to ensure that each server is configured according to that policy. Domains can span multiple physical (or virtual) machines, with all JBoss Application Server 7 instances on a given host under the control of a special Host Controller process. One Host Controller instance is configured to act as the central Domain Controller. The Host Controller on each host interacts with the Domain Controller to control the lifecycle of the application server instances running on its host and to assist the Domain Controller in managing them.
When you launch a JBoss Application Server 7 managed domain on a host (via the domain.sh or launch scripts) your intent is to launch a Host Controller and usually at least one JBoss domain.bat
Application Server 7 instance. On one of the hosts the Host Controller should be configured to act as the Domain Controller. See Domain Setup for details.
JBoss Community Documentation Page 33 of 660
Host
Each "Host" box in the above diagram represents a physical or virtual host. A physical host can contain zero, one or more server instances.
Host Controller
When the domain.sh or domain.bat script is run on a host, a process known as a Host Controller is launched. The Host Controller is solely concerned with server management; it does not itself handle application server workloads. The Host Controller is responsible for starting and stopping the individual application server processes that run on its host, and interacts with the Domain Controller to help manage them.
Each Host Controller by default reads its configuration from the domain/configuration/host.xml file located in the unzipped JBoss Application Server 7 installation on its host's filesystem. The host.xml file contains configuration information that is specific to the particular host. Primarily:
the listing of the names of the actual JBoss Application Server 7 instances that are meant to run off of this installation.
configuration of how the Host Controller is to contact the Domain Controller to register itself and access the domain configuration. This may either be configuration of how to find and contact a remote Domain Controller, or a configuration telling the Host Controller to itself act as the Domain Controller. configuration of items that are specific to the local physical installation. For example, named interface definitions declared in domain.xml (see below) can be mapped to an actual machine-specific IP address in host.xml. Abstract path names in domain.xml can be mapped to actual filesystem paths in host.xml.
Domain Controller
One Host Controller instance is configured to act as the central management point for the entire domain, i.e. to be the Domain Controller. The primary responsibility of the Domain Controller is to maintain the domain's central management policy, to ensure all Host Controllers are aware of its current contents, and to assist the Host Controllers in ensuring any running application server instances are configured in accordance with this policy. This central management policy is stored by default in the domain/configuration/domain.xml file in the unzipped JBoss Application Server 7 installation on Domain Controller's host's filesystem.
A domain.xml file must be located in the domain/configuration directory of an installation that's meant to run the Domain Controller. It does not need to be present in installations that are not meant to run a Domain Controller; i.e. those whose Host Controller is configured to contact a remote Domain Controller. The presence of a domain.xml file on such a server does no harm.
The domain.xml file includes, among other things, the configuration of the various "profiles" that JBoss Application Server 7 instances in the domain can be configured to run. A profile configuration includes the detailed configuration of the various subsystems that comprise that profile (e.g. an embedded JBoss Web instance is a subsystem; a JBoss TS transaction manager is a subsystem, etc). The domain configuration also includes the definition of groups of sockets that those subsystems may open. The domain configuration also includes the definition of "server groups":
JBoss Community Documentation Page 35 of 660
Server Group
A server group is set of server instances that will be managed and configured as one. In a managed domain each application server instance is a member of a server group. (Even if the group only has a single server, the server is still a member of a group.) It is the responsibility of the Domain Controller and the Host
Controllers to ensure that all servers in a server group have a consistent configuration. They should all be configured with the same profile and they should have the same deployment content deployed.
The domain can have multiple server groups. The above diagram shows two server groups, "ServerGroupA" and "ServerGroupB". Different server groups can be configured with different profiles and deployments; for example in a domain with different tiers of servers providing different services. Different server groups can also run the same profile and have the same deployments; for example to support rolling application upgrade scenarios where a complete service outage is avoided by first upgrading the application on one server group and then upgrading a second server group.
An example server group definition is as follows:
<server-group name="main-server-group" profile="default"> <socket-binding-group ref="standard-sockets"/>
<deployments>
<deployment name="foo.war_v1" runtime-name="foo.war" /> <deployment name="bar.ear" runtime-name="bar.ear" /> </deployments>
</server-group>
A server-group configuration includes the following required attributes: name -- the name of the server group
profile -- the name of the profile the servers in the group should run In addition, the following optional elements are available:
socket-binding-group -- specifies the name of the default socket binding group to use on servers in the group. Can be overridden on a per-server basis in host.xml. If not provided in the
element, it must be provided for each server in .
server-group host.xml
deployments -- the deployment content that should be deployed on the servers in the group. system-properties -- system properties that should be set on all servers in the group
jvm -- default jvm settings for all servers in the group. The Host Controller will merge these settings with any provided in host.xml to derive the settings to use to launch the server's JVM. See JVM
for further details. settings
Server
Each "Server" in the above diagram represents an actual application server instance. The server runs in a separate JVM process from the Host Controller. The Host Controller is responsible for launching that process. (In a managed domain the end user cannot directly launch a server process from the command line.)
The Host Controller synthesizes the server's configuration by combining elements from the domain wide configuration (from domain.xml) and the host-specific configuration (from host.xml).
3.1.3 Deciding between running standalone servers or a
managed domain
Which use cases are appropriate for managed domain and which are appropriate for standalone servers? A managed domain is all about coordinated multi-server management -- with it JBoss AS 7 provides a central point through which users can manage multiple servers, with rich capabilities to keep those servers' configurations consistent and the ability to roll out configuration changes (including deployments) to the servers in a coordinated fashion.
It's important to understand that the choice between a managed domain and standalone servers is all about how your servers are managed, not what capabilities they have to service end user requests. This distinction is particularly important when it comes to high availability clusters. It's important to understand that HA functionality is orthogonal to running standalone servers or a managed domain. That is, a group of
standalone servers can be configured to form an HA cluster. The domain and standalone modes determine how the servers are managed, not what capabilities they provide.
So, given all that:
A single server installation gains nothing from running in a managed domain, so running a standalone server is a better choice.
For multi-server production environments, the choice of running a managed domain versus standalone servers comes down to whether the user wants to use the centralized management capabilities a managed domain provides. Some enterprises have developed their own sophisticated multi-server management capabilities and are comfortable coordinating changes across a number of independent JBoss AS 7 instances. For these enterprises, a multi-server architecture comprised of individual standalone servers is a good option.
Running a standalone server is better suited for most development scenarios. Any individual server configuration that can be achieved in a managed domain can also be achieved in a standalone server, so even if the application being developed will eventually run in production on a managed domain installation, much (probably most) development can be done using a standalone server. Running a managed domain mode can be helpful in some advanced development scenarios; i.e. those involving interaction between multiple JBoss AS 7 instances. Developers may find that setting up various servers as members of a domain is an efficient way to launch a multi-server cluster.
JBoss Community Documentation Page 37 of 660
3.2 General configuration concepts
For both a managed domain or a standalone server, a number of common configuration concepts apply:
3.2.1 Extensions
An extension is a module that extends the core capabilities of the server. The JBoss Application Server 7 core is very simple and lightweight; most of the capabilities people associate with an application server are provided via extensions. An extension is packaged as a module in the modules folder. The user indicates that they want a particular extension to be available by including an <extension/> element naming its module in the domain.xml or standalone.xml file.
<extensions> [...] <extension module="org.jboss.as.transactions"/> <extension module="org.jboss.as.web" /> <extension module="org.jboss.as.webservices" /> <extension module="org.jboss.as.weld" /> </extensions>
3.2.2 Profiles and Subsystems
The most significant part of the configuration in domain.xml and standalone.xml is the configuration of one (in standalone.xml) or more (in domain.xml) "profiles". A profile is a named set of subsystem configurations. A subsystem is an added set of capabilities added to the core server by an extension (see "Extensions" above). A subsystem provides servlet handling capabilities; a subsystem provides an EJB container; a subsystem provides JTA, etc. A profile is a named list of subsystems, along with the details of each subsystem's configuration. A profile with a large number of subsystems results in a server with a large set of capabilities. A profile with a small, focused set of subsystems will have fewer capabilities but a smaller footprint.
The content of an individual profile configuration looks largely the same in domain.xml and
. The only difference is is only allowed to have a single profile element
standalone.xml standalone.xml
(the profile the server will run), while domain.xml can have many profiles, each of which can be mapped to one or more groups of servers.
The contents of individual subsystem configurations look exactly the same between domain.xml and .
