Search Mastertheboss

Our eBooks

jboss.xml reference

JBoss xml reference


JBoss AS uses a set of custom xml descriptors which can be used to customize Enterprise applications. Today they are not used so widely as once, because they have been replaced by their equivalent annotations. Though it can be useful to have a reference to most common XML configuration file, if you need to mantain older Enterprise applications, or if you prefer to mantain your configutation separated from your code.


In this tutorial we will cover the following files:


  • jboss.xml
  • jboss-web.xml




This descriptor can be used if your EJB do not use annotations to declare themselves as EJB.

It needs to be deployed in your EJB jar ander the META-INF folder.


Here's a sample jboss.xml file which can be used to declare a Session Bean and a Message driven Bean:


Here's an advanced jboss.xml containing a cluster definition and a security domain





This file descriptor can be bundled in a web application under the WEB-INF folder to define some specific configuration elements, related to the Web application context or to the Security configuration.


Here's an example which defines a custom context root for the Web application


Here's a jboss-web.xml example which uses the JaasSecurityMgr other security domain for authentication and authorization of secured web content.defines the security a custom context root for the Web application.

    <!-- Use the JaasSecurityMgr other security domain for authentication
      and authorization of secured web content.

 Here's an example which uses jboss-web.xml to define a Virtual Host

Note that when a WAR file is deployed, it is associated by default with the virtual host whose name matches the defaultHost attribute of the containing Engine.
To deploy a WAR to a specific virtual host you need to specify an appropriate virtual-host definition in your jboss-web.xml descriptor.
The following jboss-web.xml descriptor demonstrates how to deploy a WAR to the virtual host

The above virtual host needs to match the corresponding Host alias defined in the server.xml file
<Host name="" autoDeploy="false" deployOnStartup="false" deployXML="false">

Related articles available on

JBoss MBeans POJO

JMX MBean services are the core building blocks of the JBoss Appl

How to a dump of JNDI tree with JMX console ?

#2 JBoss Howto. This is the recipe of the day

How to configure JBoss to bind to a different IP ?

If you want to change the jboss.bind.address property use the&nbs

How to shut down JBoss from remote ?

JBoss recipe of the day

How to create multiple instances of an Mbean?

  Supposing you need two instances of an MBean, let's say one fo

JBoss classloader issues

By default JBoss (prior to version 3.2) uses a flat class loading

© 2020 All Rights Reserved.

Please publish modules in offcanvas position.