[jboss-cvs] JBossAS SVN: r63429 - in projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en: modules and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Fri Jun 8 11:59:53 EDT 2007
Author: alesj
Date: 2007-06-08 11:59:53 -0400 (Fri, 08 Jun 2007)
New Revision: 63429
Added:
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/classloader.xml
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/core.xml
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/deployers.xml
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/managed.xml
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/osgi.xml
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/spring.xml
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/vfs.xml
Modified:
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/master.xml
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/aop.xml
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/basics.xml
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/examples.xml
projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/introduction.xml
Log:
Re-structuring + adding docs about new modules.
Modified: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/master.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/master.xml 2007-06-08 15:56:43 UTC (rev 63428)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/master.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -53,12 +53,24 @@
<xi:include href="modules/packaging.xml"
xml:base="./"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="modules/basics.xml"
+ <xi:include href="modules/core.xml"
xml:base="./"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="modules/aop.xml"
+ <xi:include href="modules/classloader.xml"
xml:base="./"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="modules/managed.xml"
+ xml:base="./"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="modules/vfs.xml"
+ xml:base="./"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="modules/deployers.xml"
+ xml:base="./"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="modules/osgi.xml"
+ xml:base="./"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="modules/standalone.xml"
xml:base="./"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
Modified: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/aop.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/aop.xml 2007-06-08 15:56:43 UTC (rev 63428)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/aop.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -2,7 +2,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
-<chapter id="aop">
+<section>
<title>AOP Configuration and Usage</title>
<para>When writting new version of Kernel, there was always a need for
@@ -39,4 +39,4 @@
</deployment></programlisting>
</section>
-</chapter>
\ No newline at end of file
+</section>
\ No newline at end of file
Modified: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/basics.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/basics.xml 2007-06-08 15:56:43 UTC (rev 63428)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/basics.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -2,7 +2,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
-<chapter id="basics">
+<section>
<title>Basic Configuration and Usage</title>
<para>The Microcontainer's main purpose is to allow external configuration of
@@ -1019,7 +1019,7 @@
</section>
<section>
- <title>Contextual awareness - configuration, injection and callbacks</title>
+ <title>Contextual awareness</title>
<para>
With existing annoyance of using huge amounts of xml to sometimes wire up
@@ -1140,4 +1140,4 @@
</section>
-</chapter>
\ No newline at end of file
+</section>
\ No newline at end of file
Added: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/classloader.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/classloader.xml (rev 0)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/classloader.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+
+<chapter id="classloader">
+ <title>Classloader module</title>
+
+ <para>
+ Classloader ...
+ </para>
+</chapter>
Added: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/core.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/core.xml (rev 0)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/core.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+
+<chapter id="core">
+ <title>Microcontainer core</title>
+
+ <para>Core ...
+ </para>
+
+ <xi:include href="basics.xml"
+ xml:base="./"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="aop.xml"
+ xml:base="./"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="spring.xml"
+ xml:base="./"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</chapter>
\ No newline at end of file
Added: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/deployers.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/deployers.xml (rev 0)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/deployers.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+
+<chapter id="deployers">
+ <title>Deployers module</title>
+
+ <para>
+ Deployers ...
+ </para>
+</chapter>
Modified: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/examples.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/examples.xml 2007-06-08 15:56:43 UTC (rev 63428)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/examples.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -141,7 +141,7 @@
application both as a standalone Java SE application and as a service in the JBoss AS.
</para>
- <para>This just skims the surface of the MicroContainer, showing the most
+ <para>This just skims the surface of the Microcontainer, showing the most
common usecases. Other more complicated examples can be found in the tests
(available from SVN).</para>
Modified: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/introduction.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/introduction.xml 2007-06-08 15:56:43 UTC (rev 63428)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/introduction.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -9,6 +9,14 @@
used standalone outside the JBoss Application Server.
</para>
+ <para>As we mention JBoss Application Server, while rewritting its Microkernel to POJO environment, there were other
+ aspects that also needed to be considered while changing the core functionality. New modules or subprojects were
+ introduced to the Microcontainer project to tightly integrate those aspects with the new POJO direction and to
+ eventually solve some of the basic problems that arose over the years with the changes application server went
+ through.
+ We will discuss those modules or subproject later on.
+ </para>
+
<para>At its core, the JBoss Microcontainer is a generic "dependency injection" framework. It's primary function is
to instantiate objects, figure out their dependencies (e.g., object A must be instantiated before object B), and
then manage the relationship between those objects (e.g., object A is a property of object B). With the JBoss
@@ -17,8 +25,10 @@
decouples the components in an application and makes the application easy to unit-test.
</para>
- <para>The JBoss Microcontainer is a big object factory that manages objects. In this sense, it is similar to existing
- dependency injection frameworks such as the Spring framework and HiveMind framework. However, JBoss Microcontainer
+ <para>The JBoss Microcontainer is a big object factory that manages objects. In this sense, it is similar to
+ existing
+ dependency injection frameworks such as the Spring framework and HiveMind framework. However, JBoss
+ Microcontainer
also has several important new features that set it apart from existing frameworks.
</para>
@@ -34,35 +44,40 @@
</para>
</listitem>
<listitem>
- <para>JBoss Microcontainer integrates with the JBoss AOP (Aspect Oriented Programming) framework. In the JBoss
+ <para>JBoss Microcontainer integrates with the JBoss AOP (Aspect Oriented Programming) framework. In the
+ JBoss
Microcontainer configuration file, you can easily wire aspects as services to POJOs.
</para>
</listitem>
<listitem>
- <para>JBoss Microcontainer is used as a replacement for JMX based kernel in the new JBoss AS 5.x and above. All
+ <para>JBoss Microcontainer is used as a replacement for JMX based kernel in the new JBoss AS 5.x and above.
+ All
the existing features of MBeans are thightly integrated into new Microcontainer based ServiceController.
</para>
</listitem>
<listitem>
- <para>JBoss Microcontainer is embedded in JBoss AS 4.0.3 and above. It is the ideal choice if you need to
+ <para>JBoss Microcontainer is embedded in JBoss AS 4.x. It is the ideal choice if you need to
develop shared services in JBoss AS.
</para>
</listitem>
</itemizedlist>
<para>Of course, you can also run JBoss Microcontainer outside of the JBoss AS. For instance, you can run it in a
- Java SE (e.g., Swing) application or in the Tomcat servlet container. So, JBoss Microcontainer primarily targets
+ Java SE (e.g., Swing) application or in the Tomcat servlet container. So, JBoss Microcontainer primarily
+ targets
three types of developers.
</para>
<itemizedlist mark="bullet">
<listitem>
- <para>Framework developers can use JBoss Microcontainer to assemble custom server frameworks. For instance, the
+ <para>Framework developers can use JBoss Microcontainer to assemble custom server frameworks. For instance,
+ the
JBoss embeddable EJB3 framework is based on the Microcontainer.
</para>
</listitem>
<listitem>
- <para>JBoss application developers can develop POJO services that nicely integrate into the server and can be
+ <para>JBoss application developers can develop POJO services that nicely integrate into the server and can
+ be
shared across applications.
</para>
</listitem>
@@ -74,7 +89,8 @@
</listitem>
</itemizedlist>
- <para>A typical JBoss Microcontainer application or service include a set of POJOs that complete business tasks, as
+ <para>A typical JBoss Microcontainer application or service include a set of POJOs that complete business tasks,
+ as
well as an XML configuration file called
<varname>META-INF/jboss-beans.xml</varname>
on the class path. The
@@ -90,7 +106,7 @@
<para>This document takes you through some example deployments into
JBoss Microcontainer 2.0 explaining how to configure POJOs and link them together
through injection.
- We will also explain how to use the Microcontainer modules inside new JBoss AS 5.x, specially the re-written
+ We will also explain how to use other Microcontainer modules inside new JBoss AS 5.x, specially the re-written
deployers and classloader modules.
Later will show how to do the same thing outside the application server.
</para>
Added: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/managed.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/managed.xml (rev 0)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/managed.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+
+<chapter id="managed">
+ <title>Manager module</title>
+
+ <para>
+ Managed ...
+ </para>
+</chapter>
Added: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/osgi.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/osgi.xml (rev 0)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/osgi.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+
+<chapter id="osgi">
+ <title>OSGi module</title>
+
+ <para>
+ OSGi ...
+ </para>
+</chapter>
Added: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/spring.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/spring.xml (rev 0)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/spring.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+
+<section>
+ <title>Spring integration</title>
+
+ <para>XYZ
+ </para>
+
+</section>
\ No newline at end of file
Added: projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/vfs.xml
===================================================================
--- projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/vfs.xml (rev 0)
+++ projects/microcontainer/trunk/docs/gettingstarted/src/docbkx/en/modules/vfs.xml 2007-06-08 15:59:53 UTC (rev 63429)
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+
+<chapter id="vfs">
+ <title>VFS module</title>
+
+ <para>
+ VFS ...
+ </para>
+</chapter>
More information about the jboss-cvs-commits
mailing list