Getting Started Guide - JBoss AS 7.0 (2024)

Standalone Directory Structure

In "standalone" mode each JBoss Application Server 7 instance is an independent process (similar to previous JBoss AS versions; e.g., 3, 4, 5, or 6). The configuration files, deployment content and writable areas used by the single standalone server run from a JBoss Application Server installation are found in the following subdirectories under the top level "standalone" directory:

Domain Directory Structure

A key feature of AS 7 is the managing multiple servers from a single control point. A collection of multiple servers are referred to as a "domain". Domains can span multiple physical (or virtual) machines with all JBoss Application Server 7 instances on a given host under the control of a Host Controller process. The Host Controllers interact with the Domain Controller to control the lifecycle of the JBoss Application Server 7 instances running on that host and to assist the Domain Controller in managing them. The configuration files, deployment content and writeable areas used by domain mode processes run from a JBoss Application Server 7 installation are found in the following subdirectories under the top level "domain" directory:

Standalone Server Configurations

• standalone.xml (default)

  • Java Enterprise Edition 6 certified web profile configuration which includes the technologies required by the Web Profile specification plus Java Connector 1.6 Architecture, Java XML API for RESTFul Web Services, and OSGi

• standalone-preview.xml

  • referred to as our Java Enterprise Edition 6 full profile preview, this configuration contains all the technologies in the default configuration with additional technology previews of Java API for XML-Based Web Services (JAX-WS) 2.2 and Java Message Service 1.1.

• standalone-ha.xml

  • default profile with Clustering capabilities

• standalone-preview-ha.xml

  • EE 6 full profile preview with Clustering capabilities

Domain Server Configurations

• domain.xml (default)

  • Java EE 6 certified Web Profile (include configuration for the technologies required by the Web Profile specification plus Java Connector 1.6 Architecture, Java XML API for RESTFul Web Services, and OSGi

• domain-preview.xml

  • Includes configuration for default plus technology previews of JAX-WS and Java Message Service

Important to note is that the domain and standalone modes determine how the servers are managed not what capabilities they provide.
NOTE: The *-preview.xml configurations are only available in the Full Profile preview distributions.

Test Your Installation

After executing one of the above commands, you should see output similar to what's shown below.

========================================================================= JBoss Bootstrap Environment JBOSS_HOME: /work/jboss-as-7.0.0.Final JAVA: /usr/jdk1.6/bin/java JAVA_OPTS: -server -Xms64m -Xmx512m -XX:MaxPermSize=256m -Djava.net.preferIPv4Stack=true -Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Djboss.modules.system.pkgs=org.jboss.byteman=========================================================================16:32:05,050 INFO [org.jboss.modules] JBoss Modules version 1.0.1.GA16:32:05,379 INFO [org.jboss.msc] JBoss MSC version 1.0.0.GA16:32:05,421 INFO [org.jboss.as] JBoss AS 7.0.0.Final "Lightning" starting<snip>16:32:07,578 INFO [org.jboss.as] (Controller Boot Thread) JBoss AS 7.0.0.Final "Lightning" started in 2804ms - Started 91 of 146 services (55 services are passive or on-demand)

As with previous JBoss releases, you can point your browser to http://localhost:8080 (if using the default configured http port) which brings you to the Welcome Screen:

From here you can access links to the AS 7 community documentation set, stay up-to-date on the latest project information, have a discussion in the user forum and access the newly designed web-based Administration Console. Or, if you uncover an issue while using AS 7, report an issue to inform us (attached patches will be reviewed). This landing page is recommended for convenient access to information about AS 7 but can easily be replaced with your own if desired.

Adminstration Console

To access the web-based Administration Console, simply follow the link from the Welcome Screen. To directly access the Management Console, point your browser at:
http://localhost:9990/console
NOTE: port 9990 is the default port configured. If you modify the http-interface port in your running configuration:

<management-interfaces> <native-interface interface="management" port="9999" /> <http-interface interface="management" port="9990"/></management-interfaces>

adjust the above command accordingly. If such modifications are made, then the link from the Welcome Screen will also be inaccessible.

Command-Line Interface

If you prefer to manage your server from the command line (or batching), the jboss-admin.sh script provides the same capabilities available via the web-based UI. This script is accessed from $JBOSS_HOME/bin directory; e.g.,

cd $JBOSS_HOME/bin./jboss-admin.sh --connectConnected to standalone controller at localhost:9999

Notice if no host or port information provided, it will default to localhost:9999.
Once connected you can add, modify, remove resources and deploy or undeploy applications. For a complete list of commands and command syntax, type help once connected.

Configure Logging in JBoss Application Server 7

**Note: The XML configuration should be used. The log manager properties are ignored after the logging subsystem is started.
JBoss Application Server 7 logging can be configured in the XML configuration files and the log manager properties file. The default logging configuration is located in the logging.properties file located in the configuration directory. For example, the standalone configuration file is under $JBOSS_HOME/standalone/configuration/logging.properties.
In general the defaults in the logging.properties configuration should be sufficient for most installs. If you require custom logging categories it's suggested they be configured in your XML configuration file, e.g. standalone.xml.
XML Configuration:
The XML configuration is defined in the standalone.xml file or the domain.xml configuration files, under the profile section in the logging subsystem. This is the preferred method to configure your custom logging categories.
There are 7 main types that can be defined:

1. <root-logger />

2. <logger category="" />

3. <console-handler />

4. <file-handler />

5. <periodic-rotating-file-handler />

6. <size-rotating-file-handler />

7. <async-handler />

The root-logger defines the base settings for the other loggers to inherit by default.
See logging configuration for more details. The schema definition is located in $JBOSS_HOME/docs/schema/jboss-logging.xsd if you wish to see all the options.
The follow example shows how you could configure a logger for the category "org.jboss.as.quickstart.kitchensink" to a debug level.

<logger category="org.jboss.as.quickstart.kitchensink"> <level name="DEBUG"/></logger>

The above example inherits the handlers from the <root-logger />. This can be overridden by adding the use-parent-handlers with a value of false to the <logger /> tag.
The advantage to using this method the level is easily changeable for the management console. This makes it very easy to turn on or off debugging for applications with no restart required.
Log Manager Properties:
The log manager configuration files is defined in the logging.properties file located in the configuration directory. For example, the standalone configuration file is under $JBOSS_HOME/standalone/configuration/logging.properties. This is only used as a bootstrap logger and does not support updates at runtime. The following properties may be specified in logging.properties:
Logger options

• loggers=<category>[,<category>,...] - Specify a comma-separated list of logger categories which will be configured. Any categories not listed here will not be configured from the following properties.

• logger.<category>.level=<level> - Specify the level for a category. The level can be a JDK logging level (SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST), a JBoss Logging 3 style level (FATAL, ERROR, WARN, INFO, DEBUG, TRACE), or a special level (OFF, ALL).

• logger.<category>.handlers=<handler>[,<handler>,...] - Specify a comma-separated list of the names of handlers to attach to this logger. The handlers must be configured in the same properties file.

• logger.<category>.filter=<filter> - Specify a filter for a category. The filter must be configured in the same properties file.

• logger.<category>.useParentHandlers=(true|false) - Specify whether log messages should cascade up to parent handlers. The default value is true.

Handler options

• handler.<name>=<className> - (Required) Specify the class name of the handler to instantiate.

• handler.<name>.level=<level> - Restrict the level of this handler. If unspecified, the default value of ALL is retained.

• handler.<name>.encoding=<encoding> - Specify the character encoding, if it is supported by this handler type. If not specified, a handler-specific default is used.

• handler.<name>.errorManager=<name> - Specify the name of the error manager to use. The error manager must be configured in the same properties file. If unspecified, no error manager is configured.

• handler.<name>.filter=<name> - Specify the name of the filter to use. The filter must be configured in the same properties file. If unspecified, messages are not filtered.

• handler.<name>.formatter=<name> - Specify the name of the formatter to use, if it is supported by this handler type. The formatter must be configured in the same properties file. If not specified, messages will not be logged for most handler types.

• handler.<name>.properties=<property>[,<property>,...] - Specify a list of JavaBean-style properties to additionally configure. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.

• handler.<name>.<property>=<value> - Set the value of the named property.

Error manager options

• errorManager.<name>=<className> - (Required) Specify the class name of the error manager to instantiate.

• errorManager.<name>.properties=<property>[,<property>,...] - Specify a list of JavaBean-style properties to additionally configure. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.

• errorManager.<name>.<property>=<value> - Set the value of the named property.

Formatter options

• formatter.<name>=<className> - (Required) Specify the class name of the formatter to instantiate.

• formatter.<name>.properties=<property>[,<property>,...] - Specify a list of JavaBean-style properties to additionally configure. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.

• formatter.<name>.<property>=<value> - Set the value of the named property.

Filter options

• filter.<name>=<className> - (Required) Specify the class name of the filter to instantiate.

• filter.<name>.properties=<property>[,<property>,...] - Specify a list of JavaBean-style properties to additionally configure. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.

• filter.<name>.<property>=<value> - Set the value of the named property.