[jboss-cvs] JBossAS SVN: r61486 - in projects/microcontainer/trunk/docs: reference and 5 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Tue Mar 20 01:09:43 EDT 2007
Author: scott.stark at jboss.org
Date: 2007-03-20 01:09:42 -0400 (Tue, 20 Mar 2007)
New Revision: 61486
Added:
projects/microcontainer/trunk/docs/reference/
projects/microcontainer/trunk/docs/reference/pom.xml
projects/microcontainer/trunk/docs/reference/src/
projects/microcontainer/trunk/docs/reference/src/docbkx/
projects/microcontainer/trunk/docs/reference/src/docbkx/en/
projects/microcontainer/trunk/docs/reference/src/docbkx/en/images/
projects/microcontainer/trunk/docs/reference/src/docbkx/en/images/empty.dir
projects/microcontainer/trunk/docs/reference/src/docbkx/en/master.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/beaninfo.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/bootstrap.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/bus.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/classadapter.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/configuration.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependency.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependencycontroller.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependencyinfo.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/deployment.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/events.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/introduction.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/joinpoint.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/kernel.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/metadata.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/reflection.xml
projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/registry.xml
Log:
Migrate the 1.0 reference docs
Property changes on: projects/microcontainer/trunk/docs/reference
___________________________________________________________________
Name: svn:ignore
+ target
Added: projects/microcontainer/trunk/docs/reference/pom.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/pom.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/pom.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,80 @@
+<?xml version="1.0"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>jboss</groupId>
+ <artifactId>mc-reference</artifactId>
+ <version>1.0</version>
+ <packaging>pom</packaging>
+ <name>JBossMC Reference Guide</name>
+ <description>The JBossMC reference guide</description>
+
+ <repositories>
+ <repository>
+ <id>agilejava</id>
+ <name>AgileJava</name>
+ <url>http://agilejava.com/maven/</url>
+ </repository>
+ </repositories>
+ <pluginRepositories>
+ <pluginRepository>
+ <id>agilejava</id>
+ <name>AgileJava</name>
+ <url>http://agilejava.com/maven/</url>
+ </pluginRepository>
+ </pluginRepositories>
+
+
+ <build>
+ <plugins>
+ <plugin>
+ <!--
+ See the following for config options:
+ http://www.agilejava.com/docbkx/docbkx-maven-plugin/generate-html-mojo.html
+ -->
+ <groupId>com.agilejava.docbkx</groupId>
+ <artifactId>docbkx-maven-plugin</artifactId>
+ <version>2.0.3</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>generate-pdf</goal>
+ <goal>generate-html</goal>
+ </goals>
+ <phase>generate-sources</phase>
+ </execution>
+ </executions>
+ <dependencies>
+ <dependency>
+ <groupId>org.docbook</groupId>
+ <artifactId>docbook-xml</artifactId>
+ <version>4.4</version>
+ <scope>runtime</scope>
+ </dependency>
+ </dependencies>
+
+ <configuration>
+ <foCustomization>${basedir}/src/styles/docbook-fo.xsl</foCustomization>
+ <includes>master.xml</includes>
+
+ <!-- use separate pages per chapter for HTML -->
+ <chunkedOutput>true</chunkedOutput>
+
+ <entities>
+ <entity>
+ <name>version</name>
+ <value>${version}</value>
+ </entity>
+ </entities>
+
+ <xincludeSupported>true</xincludeSupported>
+ <sourceDirectory>${basedir}/src/docbkx/en</sourceDirectory>
+ <headerRule>0</headerRule>
+ <footerRule>0</footerRule>
+ <draftMode>0</draftMode>
+ <bodyFontFamily>Helvetica</bodyFontFamily>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+</project>
+
Property changes on: projects/microcontainer/trunk/docs/reference/pom.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/images/empty.dir
===================================================================
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/master.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/master.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/master.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,90 @@
+<?xml version='1.0' encoding="iso-8859-1"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
+[
+<!ENTITY beaninfo SYSTEM "modules/beaninfo.xml">
+<!ENTITY bootstrap SYSTEM "modules/bootstrap.xml">
+<!ENTITY bus SYSTEM "modules/bus.xml">
+<!ENTITY classadapter SYSTEM "modules/classadapter.xml">
+<!ENTITY configuration SYSTEM "modules/configuration.xml">
+<!ENTITY dependency SYSTEM "modules/dependency.xml">
+<!ENTITY dependencycontroller SYSTEM "modules/dependencycontroller.xml">
+<!ENTITY dependencyinfo SYSTEM "modules/dependencyinfo.xml">
+<!ENTITY deployment SYSTEM "modules/deployment.xml">
+<!ENTITY events SYSTEM "modules/events.xml">
+<!ENTITY introduction SYSTEM "modules/introduction.xml">
+<!ENTITY joinpoint SYSTEM "modules/joinpoint.xml">
+<!ENTITY kernel SYSTEM "modules/kernel.xml">
+<!ENTITY metadata SYSTEM "modules/metadata.xml">
+<!ENTITY registry SYSTEM "modules/registry.xml">
+<!ENTITY reflection SYSTEM "modules/reflection.xml">
+]>
+<book lang="en">
+ <bookinfo>
+ <title>JBoss Microcontainer Reference</title>
+ <subtitle>A Reference for Developers</subtitle>
+ <releaseinfo>1.0.2</releaseinfo>
+ </bookinfo>
+
+ <toc/>
+
+ <preface id="target" revision="1">
+ <title>Target Audience</title>
+
+ <para>
+ This reference is aimed at microcontainer developers.
+ </para>
+ <para>
+ It aims at describing how the microcontainer is constructed, the
+ design decisions made and how to extend or develop it.
+ </para>
+
+ </preface>
+
+ <preface id="preface" revision="1">
+ <title>Preface</title>
+
+ <para>Commercial development support, production support and training for
+ the JBoss Microcontainer is available through <ulink
+ url="http://www.jboss.com">JBoss Inc.</ulink> The JBoss Microcontainer is
+ a project of the JEMS product suite.</para>
+
+ <para>Authors: <itemizedlist spacing="compact">
+ <listitem>
+ <para>Adrian Brock - JBoss Microcontainer Project Lead and Chief
+ Scientist of JBoss Inc.</para>
+ </listitem>
+ </itemizedlist></para>
+ </preface>
+
+&introduction;
+
+&reflection;
+
+&joinpoint;
+
+&classadapter;
+
+&dependencycontroller;
+
+&dependencyinfo;
+
+&bootstrap;
+
+®istry;
+
+&bus;
+
+&beaninfo;
+
+&metadata;
+
+&configuration;
+
+&dependency;
+
+&deployment;
+
+&events;
+
+</book>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/master.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/beaninfo.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/beaninfo.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/beaninfo.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="beaninfo">
+ <title>Describing a Bean</title>
+
+ <para>The BeanInfo provides a description of a POJO. This information allows
+ the microcontainer to know what can be done with the bean.</para>
+
+ <para>This is similar to the BeanInfo provided by the java.beans package but
+ some java environments like J2ME do not include this package because it has
+ dependencies on AWT.</para>
+
+ <sect1 id="beaninfofactory-overview" revision="1">
+ <title>BeanInfoFactory - retrieveing bean descriptions</title>
+
+ <para>The <literal>BeanInfoFactory</literal> is used to create BeanInfos for a given class.
+ <programlisting>BeanInfo getBeanInfo(String className)</programlisting>
+ The default implementation is the IntrospectionBeanInfoFactory which uses
+ reflection.</para>
+ </sect1>
+
+ <sect1 id="beaninfo-overview" revision="1">
+ <title>BeanInfo - information about a bean</title>
+
+ <para>The BeanInfo provides top level information and access to the more
+ detailed information about the bean.</para>
+ </sect1>
+
+ <sect1 id="propertyinfo-overview" revision="1">
+ <title>PropertyInfo - information about a property</title>
+
+ <para>The PropertyInfo describes an property, i.e. something that
+ follows the <programlisting>Type getX(); void setX(Type x)</programlisting>
+ javabean pattern.</para>
+ </sect1>
+
+ <sect1 id="eventinfo-overview" revision="1">
+ <title>EventInfo - information about an event</title>
+
+ <para>The EventInfo describes an event.</para>
+ </sect1>
+
+</chapter>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/beaninfo.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/bootstrap.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/bootstrap.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/bootstrap.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="bootstrap">
+ <title>Bootstrapping the Kernel</title>
+
+ <para>The bootstrap provides a simple mechanism for bootstrapping the microcontainer.</para>
+
+ <sect1 id="bootstrap-overview">
+ <title>Bootstrap - bootstrapping</title>
+
+ <para>This bootstrap creates and configures the microcontainer. This
+ involves creating a KernelConfig
+ from which the KernelFactory
+ can be instantiated using the KernelInstantiator.</para>
+ </sect1>
+
+ <sect1 id="config-overview">
+ <title>Config - bootstrap configuration</title>
+
+ <para>This KernelConfig provides the mechanism to configure the bootstrap
+ including how the core kernel services are instantiated and
+ configured.</para>
+ </sect1>
+
+ <sect1 id="kernelfactory-overview">
+ <title>KernelFactory - kernel instantiation</title>
+
+ <para>The KernelFactory is responsible for initializing and configuring
+ the kernel services using information provided by the KernelConfig.</para>
+ </sect1>
+</chapter>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/bootstrap.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/bus.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/bus.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/bus.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="bus">
+ <title>The Invocation Bus</title>
+
+ <para>The invocation bus provides detyped, named access to the objects in
+ the registry.</para>
+
+ <sect1 id="bus-overview" revision="1">
+ <title>Bus - invoking objects by name</title>
+
+ <para>The invocation bus provides <itemizedlist spacing="compact">
+ <listitem><para>
+ Detyped invocations - the beans operations can be invoked by name using
+ </para></listitem>
+
+ <listitem><para>
+ Named endpoints - the target bean is specified by a name registered in the registry
+ </para></listitem>
+ </itemizedlist></para>
+ </sect1>
+
+</chapter>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/bus.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/classadapter.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/classadapter.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/classadapter.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="classadapter">
+ <title>ClassAdapter</title>
+
+ <para>WARNING: The classadapter model is subject to change without notice.
+ It is currently under developement as issues with AOP integration and using
+ the Microcontainer in more constrained environments are investigated.</para>
+
+ <para>The class adapter abstraction provides a mechanism to override a class
+ or a specific instance of a class in a given context.</para>
+
+ <section>
+ <title>Aims</title>
+
+ <section>
+ <title>AOP Integration</title>
+
+ <para>The main of the classadapter is to provide an integration point
+ for AOP and the microcontainer. It represents a class instance before it
+ is constructed or maybe even before the class has been deployed. AOP can
+ override the joinpoints to add extra work during construction.</para>
+ </section>
+
+ <section>
+ <title>Overridding annotations</title>
+
+ <para>The microcontainer allows annotations to be overridden on a
+ specific bean deployment. These are passed to AOP.</para>
+ </section>
+
+ <section>
+ <title>Obtaining AOP dependencies</title>
+
+ <para>The microcontainer uses the classadapter to learn what
+ cross-cutting AOP dependencies are required before any attempt is made
+ to construct the object.</para>
+ </section>
+ </section>
+
+ <section>
+ <title>Issues</title>
+
+ <section>
+ <title>AOP Integration</title>
+
+ <para>The AOP integration is currently being finalized as part of
+ AOP2.0</para>
+ </section>
+ </section>
+</chapter>
\ No newline at end of file
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/classadapter.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/configuration.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/configuration.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/configuration.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,18 @@
+<chapter id="configuration">
+ <title>Bean Configuration - instantiating and configuring beans</title>
+
+ <para>
+ The kernel configurator provides a service to instantiate and configure
+ beans.
+ </para>
+
+ <sect1 id="configurator-overview" revision="1">
+ <title>KernelConfigurator - configuring beans</title>
+ <para>
+ This service is used by the
+ <link linkend="controller-overview">Controller</link>
+ once it knows the dependencies have been satisfied.
+ </para>
+ </sect1>
+
+</chapter>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/configuration.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependency.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependency.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependency.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="dependency">
+ <title>Bean Dependency - wiring beans together</title>
+
+ <para>The POJO controller extends the dependency controller to provide a
+ specific lifecycle for POJOs.</para>
+
+ <sect1 id="controller-overview" revision="1">
+ <title>KernelController - wiring beans</title>
+
+ <para>The POJO controller defines the following state operations for
+ </para>
+
+ <para>describe: determines the dependencies from the bean metadata</para>
+
+ <para>instantiate: invokes the constructor or factory</para>
+
+ <para>configure: configures the bean </para>
+
+ <para>create: invokes any "create()" method </para>
+
+ <para>start: invokes any "start()" method</para>
+
+ <para>install: registers the bean with the registry</para>
+ </sect1>
+
+ <sect1>
+ <title>KernelController - demand and supply</title>
+
+ <para>The POJO controller acts as a Registry plugin to handle demand and
+ supply.</para>
+ </sect1>
+</chapter>
\ No newline at end of file
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependency.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependencycontroller.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependencycontroller.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependencycontroller.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="dependencycontroller">
+ <title>Dependency Controller</title>
+
+ <para>WARNING: The dependency controller is subject to change without notice. It
+ is currently under developement as issues with the integration of the JMX microkernel
+ and microcontainer are resolved.</para>
+
+</chapter>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependencycontroller.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependencyinfo.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependencyinfo.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependencyinfo.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,8 @@
+<chapter id="dependencyinfo">
+ <title>Dependency Info - describing dependencies</title>
+
+ <para>WARNING: The dependency controller is subject to change without notice. It
+ is currently under developement as issues with the integration of the JMX microkernel
+ and microcontainer are resolved.</para>
+
+</chapter>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/dependencyinfo.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/deployment.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/deployment.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/deployment.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="deployment">
+ <title>Bean Deployment - deploying beans</title>
+
+ <para>The bean deployer provides routines for deploying beans.</para>
+
+ <sect1>
+ <title>Abstract deployer </title>
+
+ <para>The abstract deployer provides the basic processing for deploying
+ multiple beans together.</para>
+ </sect1>
+
+ <sect1>
+ <title>BeanXMLDeployer</title>
+
+ <para>The xml deployer adds extra routines for parsing
+ <deployment/>s from xml.</para>
+ </sect1>
+</chapter>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/deployment.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/events.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/events.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/events.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="events">
+ <title>Events - notifications from the microcontainer and services</title>
+
+ <para>The event subsystem allows services to produce and consume
+ events.</para>
+
+ <sect1 id="event-overview" revision="1">
+ <title>Event - event abstraction</title>
+
+ <para>The Event class is intended to abstract the different event
+ mechanisms used by different software.</para>
+ </sect1>
+
+ <sect1 id="eventemitter-overview" revision="1">
+ <title>EventEmitter - producting events</title>
+
+ <para>Event emitters produce events and send them to their registered
+ <link linkend="eventlistener-overview">listeners</link>.</para>
+
+ <para>Listeners can be registered with a <link
+ linkend="eventfilter-overview">filter</link> to filter the events they are
+ interested in before they are sent.</para>
+ </sect1>
+
+ <sect1 id="eventlistener-overview" revision="1">
+ <title>EventListener - consuming events</title>
+
+ <para>Event listeners consume events from <link
+ linkend="eventemitter-overview">emitters</link>.</para>
+ </sect1>
+
+ <sect1 id="eventfilter-overview" revision="1">
+ <title>EventFilter - filtering events</title>
+
+ <para>A filter allows events to filtered before they are sent. This is can
+ be more efficient than filtering the event in the <link
+ linkend="eventlistener-overview">listener</link>.</para>
+ </sect1>
+
+ <sect1 id="eventmanager-overview" revision="1">
+ <title>EventManager - named listening</title>
+
+ <para>The event manager allows <link
+ linkend="eventemitter-overview">emitters</link> and <link
+ linkend="eventlistener-overview">listeners</link> to be more detached from
+ each other. Instead of direct registration, the names of the objects in
+ the registry are used.</para>
+ </sect1>
+</chapter>
\ No newline at end of file
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/events.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/introduction.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/introduction.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/introduction.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="introduction">
+ <title>Introduction to the JBoss Microcontainer</title>
+
+ <para>The JBoss Microcontainer provides an environment to configure and
+ manage POJOs (plain old java objects). It is designed to reproduce the
+ existing JBoss JMX Microkernel but targetted at POJO environments. As such
+ it can be used standalone outside the JBoss Application Server.</para>
+
+ <para></para>
+
+ <para>This initial release provides a set of features to support POJO
+ deployment in JBoss-4.0.3+ and the bootstrap of services used by the
+ standalone EJB3 distribution.</para>
+
+ <para></para>
+
+ <para>This document takes you through the design of the microcontainer
+ including design decisions and future directions.</para>
+</chapter>
\ No newline at end of file
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/introduction.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/joinpoint.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/joinpoint.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/joinpoint.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="joinpoint">
+ <title>Joinpoint - Accessing a Bean</title>
+
+ <para>WARNING: The joinpoint model is subject to change without notice. It
+ is currently under developement as issues with AOP integration and using the
+ Microcontainer in more constrained environments are investigated.</para>
+
+ <para>The joinpoint model provides a mechanism to access class operations in
+ a standard way.</para>
+
+ <section>
+ <title>Aims</title>
+
+ <section>
+ <title>Stanardize reflection operations</title>
+
+ <para>There are many places that use reflection within JBoss. The
+ joinpoint provides a mechansim to deal with reflection dispatching
+ without having worry about all the standard error handling, etc.</para>
+ </section>
+
+ <section>
+ <title>Overridding Definition</title>
+
+ <para>The joinpoint allows the mechanism of dispatch to be overridden
+ either through configuration or implementation. Examples would be not
+ using get/set to define a property either because it is a different
+ method name or it should use direct field access.</para>
+ </section>
+ </section>
+
+ <section>
+ <title>Issues</title>
+
+ <section>
+ <title>javabean versus object</title>
+
+ <para>Much of the javabean abstraction has moved the BeanInfo model, it
+ is questionable whether the ability to override on a plain object is
+ still required.</para>
+ </section>
+
+ <section>
+ <title>Alternative implementations</title>
+
+ <para>One use of this abstraction would be to precompile reflection
+ objects using javassist for use in environments where dynamic reflection
+ is not supported.</para>
+ </section>
+
+ <section>
+ <title>AOP</title>
+
+ <para>Another potential other use is to "optimize away" reflection when
+ already dispatching requests through AOP.</para>
+ </section>
+ </section>
+</chapter>
\ No newline at end of file
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/joinpoint.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/kernel.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/kernel.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/kernel.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,52 @@
+<chapter id="kernel">
+ <title>The Core Kernel</title>
+
+ <para>
+ Kernel provides access to the kernel services.
+ </para>
+
+ <sect1 id="kernel-overview" revision="1">
+ <title>Kernel - getting access to kernel services</title>
+ <para>
+ The static method
+ <programlisting>Kernel getKernel()</programlisting>
+ provides access to the kernel for the current context.
+ The context is determined by the
+ <link linkend="manager-overview">KernelManager</link>.
+ </para>
+ <para>
+ The services provided by the kernel are:
+ <itemizedlist spacing="compact">
+ <listitem>
+ <link linkend="bus-overview">The invocation bus</link>.
+ </listitem>
+ <listitem>
+ <link linkend="config-overview">The kernel configuration</link>.
+ </listitem>
+ <listitem>
+ <link linkend="configurator-overview">The bean configurator</link>.
+ </listitem>
+ <listitem>
+ <link linkend="controller-overview">The kernel controller</link>.
+ </listitem>
+ <listitem>
+ <link linkend="eventmanager-overview">The event manager</link>.
+ </listitem>
+ <listitem>
+ <link linkend="registry-overview">The registry</link>.
+ </listitem>
+ </itemizedlist>
+ </para>
+ </sect1>
+
+ <sect1 id="manager-overview" revision="1">
+ <title>KernelManager - controlling context</title>
+ <para>
+ The kernel manager decides which kernel is relevent
+ for the given context. e.g. it could use a singleton
+ kernel or it could provide a different kernel
+ based on classloading domain.
+ </para>
+ </sect1>
+
+</chapter>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/kernel.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/metadata.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/metadata.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/metadata.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="beanmetadata">
+ <title>Decribing Beans</title>
+
+ <para>The BeanMetaData provides configuration used to deploy beans.</para>
+
+ <para>This is similar to the -service.xml files in JBoss4.</para>
+
+ <sect1 id="beanmetadata-overview" revision="1">
+ <title>BeanMetaData - deploying a single bean</title>
+
+ <para>The BeanMetaData provides top level information and access to the
+ more detailed information about the bean deployment.</para>
+ </sect1>
+
+ <sect1 id="classloadermetadata-overview" revision="1">
+ <title>ClassLoaderMetaData - configuring a classloader</title>
+
+ <para>The classloader metadata is used to configure the classloader
+ for an individual bean or a whole deployment.</para>
+ </sect1>
+
+ <sect1 id="propertymetadata-overview" revision="1">
+ <title>PropertyMetaData - configuring properties</title>
+
+ <para>The property metadata is used to configure individual bean
+ property with values.</para>
+ </sect1>
+
+ <sect1 id="parametermetadata-overview" revision="1">
+ <title>ParameterMetaData - configuring values passed to constructors or
+ methods</title>
+
+ <para>The parameter metadata is used to pass values to constructors and
+ methods.</para>
+ </sect1>
+
+ <sect1 id="supplymetadata-overview" revision="1">
+ <title>SupplyMetaData - specifying the bean supplies a demand</title>
+
+ <para>The supply metadata is used to define what the bean supplies.</para>
+ </sect1>
+
+ <sect1 id="demandmetadata-overview" revision="1">
+ <title>DemandMetaData - specifying the bean demands a dependency</title>
+
+ <para>The demand metadata is used to define what the bean demands.</para>
+ </sect1>
+
+ <sect1 id="valuemetadata-overview" revision="1">
+ <title>ValueMetaData - configuring values</title>
+
+ <para>The value metadata is used to define values.</para>
+ </sect1>
+
+ <sect1 id="dependencyvaluemetadata-overview" revision="1">
+ <title>DependencyValueMetaData - defining named dependencies</title>
+
+ <para>An extension to the value metadata that treats the underlying value
+ as the name of an entry in the Registry and returns the registry's
+ registered object when asked for the value.</para>
+ </sect1>
+</chapter>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/metadata.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/reflection.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/reflection.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/reflection.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="reflection">
+ <title>Reflection Model</title>
+
+ <para>WARNING: The reflection model is subject to change without notice. It
+ is currently under developement as issues with AOP integration and using the
+ Microcontainer in more constrained environments are investigated.</para>
+
+ <para>The reflection model provides an abstraction over java.lang.reflect.
+ It exists in the container module in package org.jboss.reflect.</para>
+
+ <section>
+ <title>Aims</title>
+
+ <section>
+ <title>Cache</title>
+
+ <para>Reflection can be a bottleneck unless the information is cached.
+ This package provides a single stop cache for reflection data rather
+ than repeating this behaviour throughout JBoss.</para>
+ </section>
+
+ <section>
+ <title>Abstraction</title>
+
+ <para>It is anticapted that the reflection model can be improved in
+ different circumstances or environments. This module aims to be the one
+ place where those issues are resolved.</para>
+ </section>
+
+ <section>
+ <title>Hide implementation</title>
+
+ <para>Under AOP, classes can change their characteristics usually
+ through some sort of bytecode manipulation. This module aims to "hide"
+ some of these details from routines that "don't care" about these
+ implementation details.</para>
+ </section>
+ </section>
+
+ <section>
+ <title>Issues</title>
+
+ <section>
+ <title>Java5</title>
+
+ <para>Complete the support for annotations and generics.</para>
+ </section>
+
+ <section>
+ <title>Lazy Cache</title>
+
+ <para>Improve the lazy cache implementation. Details should only be
+ retrieved when accessed.</para>
+ </section>
+
+ <section>
+ <title>AOP</title>
+
+ <para>It is still an open issue whether this implementation can be used
+ by AOP or whether the ClassAdapter is a better place.</para>
+ </section>
+
+ <section>
+ <title>Javassist</title>
+
+ <para>The current implementation just uses simple reflection. Javassist
+ can proably provide a better implementation including supporting
+ annotations before java5?</para>
+ </section>
+ </section>
+</chapter>
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/reflection.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
Added: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/registry.xml
===================================================================
--- projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/registry.xml (rev 0)
+++ projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/registry.xml 2007-03-20 05:09:42 UTC (rev 61486)
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="registry">
+ <title>Registering Objects</title>
+
+ <para>The registry is used to register objects against logical names.</para>
+
+ <para>Beans can either be registered directly with the registry or <link
+ linkend="registryfactory-overview">KernelRegistryPlugin</link>s can be
+ registered to supply objects from other registries, e.g. JNDI.</para>
+
+ <sect1 id="registry-overview" revision="1">
+ <title>KernelRegistry - retrieving named objects</title>
+
+ <para>The kernel registry is used to register and retrieve objects against
+ a logical name.</para>
+
+ <para>When the object registered is an instance of <link
+ linkend="registryfactory-overview">KernelRegistryPlugin</link> it will be
+ asked for an entry if it is not directly registered with the registry. The
+ registry factories are asked in turn in the order they were
+ registered.</para>
+ </sect1>
+
+ <sect1 id="registryfactory-overview" revision="1">
+ <title>KernelRegistryPlugin - helpers for the registry</title>
+
+ <para>A registry factory allows other registry domains (such as JMX or
+ JNDI) to be inserted into the kernel registry.</para>
+
+ <para>To insert a registry factory into the registry, simply register it
+ like any other object.</para>
+ </sect1>
+</chapter>
\ No newline at end of file
Property changes on: projects/microcontainer/trunk/docs/reference/src/docbkx/en/modules/registry.xml
___________________________________________________________________
Name: svn:keywords
+ Id,Revision
Name: svn:eol-style
+ native
More information about the jboss-cvs-commits
mailing list