Print
Management guide

Introduction

Management refers to how a running instance of Loom, along with its components, applications and blocks are supervised and manipulated. This guide covers the steps required to write management-enabled applications for Loom.

(error) Note, this part of the documentation is not currently uptodate. Updates are beeing worked on.

Overview

Management in Loom is divided into two distinct areas. The first area is the the management metadata. This is information about which applications, blocks and components should be managed and the operations and attributes to expose from these.

The second area is the Loom component that uses the management metadata to generate a user interface through which Loom and its applications are interacted with. It is anticipated that a number of such interfaces will be developed. The current implementation of the management component generates ModelMBeans that are then registered and exposed through a slightly customized JMX implementation called MX4J.

Note that nothing about the management metadata is dependant on using JMX, and the block author does not need to know or care about how Loom, the application, and its blocks will be managed. His/her responsibility is limited to providing correct metadata.

The guide is broken into a number of sections, each covering a particular aspect of the management picture.

Management Metadata

This section walks through the steps that are needed to make a block manageable. The emphasis is on illuminating the process, it does not cover every feature or option.

Management Metadata

MetaClass Doclet tags

Loom supports MetaClass' doclet tags for describing management metadata.

MetaClass Doclet Tags

Phoenix Doclet Tags (deprecated)

The @phoenix- tags are considered deprecated. They are still supported by the maven-loom plugin, who converts them into MetaClass @mx. tags. The .mxinfo files, that Phoenix used for storing management metadata, are not supported anymore.

Phoenix Doclet Tags

Management Structure in Loom

This section provides a conceptual overview of the elements that are used to represent management information within Loom. An understanding of these elements and their relationships is essential for all users of the management functionality.

Management Structure in Loom

Powered by Atlassian Confluence