The following sections contains some basic examples how to use the JavaScript API.

1. CRUD Operations
2. Read Child Resources
3. Execute DMR Operations
4. UI Elements
   1. Table
   2. Form
   3. Master Detail

CRUD Operations

This example shows the CRUD operations in action. First a IO worker is created using an add-resource dialog, then the newly created resource is read. Finally the IO worker is modified and removed again.

let core = hal.core.Core.getInstance();
let address = "{selected.profile}/subsystem=io/worker=*";
let template = hal.meta.AddressTemplate.of(address);
let attributes = ["io-threads", "stack-size", "task-keepalive", "task-max-threads"];

core.crud.addDialog("Worker", address, attributes, (name, address) => {

    console.log("Worker '" + name + "' successfully added as '" + address.toString() + "'"); 
    let workerAddress = template.resolve(core.statementContext, name);
    core.crud.read(workerAddress, worker => {

        console.log(worker.toString());
        core.crud.save("Worker", name, template, {"stack-size": 42}, () => {

            console.log("Worker '" + name + "' successfully modified"); 
            core.crud.remove("Worker", name, workerAddress, () => {

                console.log("Worker '" + name + "' successfully removed"); 
            });
        });
    });
});

Read Child Resources

This example uses the crud operations to read the children of a resource. In this case the subsystems of the selected profile are read.

let core = hal.core.Core.getInstance();

core.crud.readChildren("{selected.profile}", "subsystem", children => {
    children.forEach(child => console.log(child.name))
});

Execute DMR Operations

This example shows how to execute arbitrary operations.

let core = hal.core.Core.getInstance();
let op = core.operation("/", "read-resource")
    .param("attributes-only", true)
    .param("include-runtime", true)
    .build();

core.dispatcher.execute(op, result => console.log(result.toString()));

UI Elements

Table

Creates a table to manage paths defined at /path=*.

let name = "Path";
let core = hal.core.Core.getInstance();
let template = hal.meta.AddressTemplate.of("/path=*");

core.metadataProcessor.lookup(template, metadata => {
    let table = core.table(metadata)
        .add(name, template, ["name", "path", "relative-to"], refresh)
        .remove(name, template, t => t.selectedRow.get("name").asString(), refresh)
        .columns(["name", "path"])
        .build();

    $("#hal-root-container")
        .empty()
        .append("<h1>" + name + "</h1>")
        .append("<p>" + metadata.description.description + "</p>")
        .append(table.element);
    table.attach();
    refresh();

    function refresh() {
        core.crud.readChildren("/", "path", properties => {
            table.update(properties.map(property => property.value));
        });
    }
});

Form

Creates a form to view and edit the transaction manager defined at /subsystem=transactions.

let name = "Transaction Manager";
let core = hal.core.Core.getInstance();
let template = hal.meta.AddressTemplate.of("{selected.profile}/subsystem=transactions");

core.metadataProcessor.lookup(template, metadata => {
    let form = core.form(metadata)
        .onSave((f, changedValues) => {
            core.crud.saveSingleton(name, template, changedValues, refresh);
        })
        .build();

    $("#hal-root-container")
        .empty()
        .append("<h1>" + name + "</h1>")
        .append("<p>" + metadata.description.description + "</p>")
        .append(form.element);
    form.attach();
    refresh();

    function refresh() {
        core.crud.read(template, config => form.view(config));
    }
});

Master Detail

Creates a master-detail view to manage log categories defined at /subsystem=logging/logger=*.

let type = "Category";
let core = hal.core.Core.getInstance();
let template = hal.meta.AddressTemplate.of("{selected.profile}/subsystem=logging/logger=*");

core.metadataProcessor.lookup(template, metadata => {
    let table = core.namedTable(metadata)
        .add(type, template, ["level", "handlers", "use-parent-handlers"], refresh)
        .remove(type, template, t => t.selectedRow.name, refresh)
        .columns(["category", "level"])
        .build();

    let form = core.namedForm(metadata)
        .onSave((f, changedValues) => {
            core.crud.save(type, f.model.name, template, changedValues, refresh);
        })
        .build();

    $("#hal-root-container")
        .empty()
        .append("<h1>Categories</h1>")
        .append("<p>" + metadata.description.description + "</p>")
        .append(table.element)
        .append(form.element);

    table.attach();
    form.attach();
    table.bindForm(form);
    refresh();

    function refresh() {
        core.crud.readChildren(template.parent, "logger", properties => {
            form.clear();
            table.update(hal.dmr.ModelNodeHelper.asNamedNodes(properties));
        });
    }
});