Chapter 11. Managed module
Prev   Next

Chapter 11. Managed module

Table of Contents

Overview
org.jboss.managed.api Classes
org.jboss.metatype.api.types Classes
org.jboss.metatype.api.values Classes
org.jboss.managed.api.annotation Annotations
Annotation Examples
Adding ManagedObject Support to Deployers

Overview

The deployers support a management API based on the org.jboss.managed.api classes, and org.jboss.metatype.api.types, org.jboss.metatype.api.values MetaType/MetaValue classes.

org.jboss.managed.api Classes

The management API provides an abstraction for editing the metadata of a Deployment. The main management classes include:

  • org.jboss.managed.api.ManagedObject - is the root interface for a manageable element. Its consists of:

    • a name/name type for a registry/references
    • an attachment name to associate the ManagedObject with a deployment attachment
    • annotations from the metadata making up the ManagedObject
    • the attachment instance
    • the ManagedPropertys for the interface
    • the ManagedOperations for the interface

  • org.jboss.managed.api.ManagedProperty is an interface describing a manageable field in a ManagedObject. Its analogous to the JavaBean property/JMX mbean attribute. Its a type safe wrapper around the Fields interface.
  • org.jboss.managed.api.ManagedOperation an interface for representing an operation in a management interface.
  • org.jboss.managed.api.ManagedParameter – a parameter in a ManagedOperation
  • org.jboss.managed.api.Fields is an interface for a collection of named values that are associated with a managed property or operation.
  • org.jboss.managed.api.ManagedDeployment is an interface describing a collection of ManagedComponent and structural information about a deployment.
  • org.jboss.managed.api.ManagedComponent is an interface that extends ManagedObject to define a runtime component associated with a deployment.
  • org.jboss.managed.api.ComponentType – type/subtype qualification of a ManagedComponent
  • org.jboss.managed.api.DeploymentTemplateInfo – named collection of ManagedPropertys needed to create a deployment or component

org.jboss.metatype.api.types Classes

The types classes define an abstraction for the types of values found in the ManagedProperty and ManagedOperation interfaces. The types are essentially simplified types that only rely on basic JDK types. The main types classes include:

  • org.jboss.metatype.api.types.MetaType<T extends Serializable> - root interface for meta types
  • org.jboss.metatype.api.types.CompositeMetaType - a key/value collection type
  • org.jboss.metatype.api.types.TableMetaType - a table structure with the rows being a CompositeMetaType.
  • org.jboss.metatype.api.types.AbstractMetaType<T extends Serializable> - base abstract class implementing MetaType
  • org.jboss.metatype.api.types.AbstractCompositeMetaType - base abstract class implementing CompositeMetaType
  • org.jboss.metatype.api.types.ArrayMetaType - an array or Collection of MetaType
  • org.jboss.metatype.api.types.EnumMetaType - java enum type or a fixed set of String values.
  • org.jboss.metatype.api.types.GenericMetaType - an opaque pass through wrapper for types that don't fit into another MetaType.
  • org.jboss.metatype.api.types.SimpleMetaType - a wrapper type for primatives; BigDecimal, BigInteger, Boolean/boolean, Byte/byte, Character/char, Date, Double/double, Float/float, Integer/int, Long/long, Short/short, String, Void/void.

org.jboss.metatype.api.values Classes

The values API provides an value wrappers for the corresponding MetaTypes. The main values classes include:

  • org.jboss.metatype.api.values.MetaValue - the base value interface defining a type accessor and clone method.
  • org.jboss.metatype.api.values.ArrayValue<T extends Serializable> - a representation of an array or collection of MetaValues. It supports an index getter as well as Iterable<T>.
  • org.jboss.metatype.api.values.CompositeValue - A represention of a map of MetaValues keyed by a String. CompositeValueSupport is a concrete implementation of CompositeValue.
  • org.jboss.metatype.api.values.EnumValue - A represention of a java.lang.Enum set of values, or a set of Strings. EnumValueSupport is a concrete implementation of EnumValue that represents a single java.lang.Enum value or java.lang.String value.
  • org.jboss.metatype.api.values.GenericValue - A represention of a GenericMetaType. GenericValueSupport is a concrete implementation of GenericValue that represents a single java.io.Serializable value.
  • org.jboss.metatype.api.values.SimpleValue - the SimpleMetaType value. The org.jboss.metatype.api.values.SimpleValueSupport<T extends Serializable> class provides wrap method for generating the correct SimpleValue from the java value object.
  • org.jboss.metatype.api.values.TableValue - the TableMetaType value. The org.jboss.metatype.api.values.TableValueSupport class provides a concrete implementation of TableValue.
  • org.jboss.metatype.api.values.MetaValueFactory - a factory for converting a java value into the corresponding MetaValue. It support an org.jboss.metatype.spi.values.MetaValueBuilder plugin for controlling how a given java.lang.Class type is converted into a MetaValue.
  • org.jboss.metatype.spi.values.MetaValueBuilder - a plugin for converting a MetaType and object instance into a MetaValue.

org.jboss.managed.api.annotation Annotations

The annotations available for defining the management interfaces include:

  • org.jboss.managed.api.annotation.ManagementObject - a class level annotation that identifies a metadata class as a ManagedObject.
  • org.jboss.managed.api.annotation.ManagementObjectID - identifies a ManagedObject key/type qualifier source.
  • org.jboss.managed.api.annotation.ManagementObjectRef - indicates a property that references another ManagedObject.
  • org.jboss.managed.api.annotation.ManagementProperty - annotation for describing a ManagedProperty.
  • org.jboss.managed.api.annotation.ManagementComponent - identifies a property as metadata identifying a ManagedComponent.
  • org.jboss.managed.api.annotation.ManagementOperation - An annotation for describing a ManagedOperation.
  • org.jboss.managed.api.annotation.ManagementParameter - Annotation for documenting a ManagementOperation parameter.
Prev   Next
Ordering Home Annotation Examples