Using JBoss AS 7 management API programmatically

In this tutorial we will show how to use detyped management API to control your application server resources. The CLI tool that comes with the application server uses this interface, and user can develop custom clients that use it as well.

A detyped API works by making it possible to build up arbitrarily complex data structures using a small number of Java types. All of the parameter values and return values in the API are expressed using those few types. Ideally, most of the types are basic JDK types, like java.lang.String, java.lang.Integer, etc. In addition to the basic JDK types, JBoss AS 7's detyped management API uses a small library called jboss-dmr.

The public API exposed by jboss-dmr is very simple: the primary class is org.jboss.dmr.ModelNode. A ModelNode is essentially just a wrapper around some value; the value is typically some basic JDK type. A ModelNode exposes a getType() method. This method returns a value of type org.jboss.dmr.ModelType, which is an enum of all the valid types of values.

In addition to jboss-dmr API the other module which is used to connect to the management API is jboss-as-controller-client. Both of these modules are included into the application server release 7.

Using the management API

There are basically two way to use the management API: from a standalone application or from a module running into the application server. If you are planning to create a standalone application, the suggested option is including the jboss-as-controller-client into your pom.xml :


If you plan to test the API from the application server, all you need is adding the required Dependencies into your MANIFEST file:


Here is a sample Servlet which performs a JNDI-lookup:

package com.sample;


import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.jboss.dmr.ModelNode;

public class Test extends HttpServlet {
    private static final long serialVersionUID = 1L;

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        try {
            PrintWriter out = response.getWriter();
            ModelNode op = new ModelNode();

            ModelNode address = op.get("address");
            address.add("subsystem", "naming");

            ModelControllerClient client = ModelControllerClient.Factory.create(
                    InetAddress.getByName(""), 9999);

            ModelNode returnVal = client.execute(op);

        } catch (Exception e) {
            // TODO Auto-generated catch block

    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub


In this example we have created a ModelNode with the following fields:

  • operation: the name of the operation to invoke. All operation requests must include this field and its value must be a String.
  • address: the address of the resource to invoke the operation against. This field's must be of ModelType.LIST with each element in the list being a ModelType.PROPERTY. If this field is omitted the operation will target the root resource. Here we are targeting the jndi-view operation for the naming subsystem.

Running the Sample Servlet will display the JNDI tree of the application server.

Here's another sample (inspired from ) which invokes the read-resource command on the available data sources:

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        try {

            PrintWriter out = response.getWriter();
            List<ModelNode> dataSources = getDataSources();
            for (ModelNode dataSource : dataSources) {
                out.println("Datasource: " + dataSource.asString());


        } catch (Exception e) {
            // TODO Auto-generated catch block

    public static List<ModelNode> getDataSources() throws IOException {
        final ModelNode request = new ModelNode();
        request.get(ClientConstants.OP_ADDR).add("subsystem", "datasources");
        ModelControllerClient client = null;
        try {
            client = ModelControllerClient.Factory.create(InetAddress.getByName(""), 9999);
            final ModelNode response = client.execute(new OperationBuilder(request).build());

            return response.get(ClientConstants.RESULT).get("data-source").asList();
        } finally {

    public static void safeClose(final Closeable closeable) {
        if (closeable != null) try {
        } catch (Exception e) {
            // no-op

Creating a Datasource programmatically on AS 7 and WildFly example

By using the Model API, you can also create resources. For example, here is how to create a Datasource programmatically on Jboss AS 7 and WildFly application server:

public void createMySQLDatasource() throws Exception{
  ModelNode request = new ModelNode();
  ModelControllerClient client = ModelControllerClient.Factory.create(InetAddress.getByName(""), 9999);
  client.execute(new OperationBuilder(request).build());

In the above example we have created programmatically a Datasource bound into the "Java:/MySQLDS" JNDI binding, using the mysql-connector-java-5.1.29-bin.jar Driver.

Related articles available on

JBoss AS 7 introduction

This is an introduction tutorial to the newest JBoss AS 7 which a

Develop Java EE applications with JBoss AS 7

In this tutorial we will learn how to create and deploy a Java EE

Adding users with JBoss AS 7

If you are planning to add new users to your management interface

JNDI view in JBoss AS 7

JNDI can be checked on the naming subsystem of the application se

How to install a module on WildFly / JBoss AS 7

Installing a module on WildFly / JBoss AS 7 requires creating a p

JBoss AS 7 classloading

JBoss AS 7 classloading explained As mandated by Java EE specifi

Follow us on Twitter