[jboss-cvs] JBossAS SVN: r103096 - projects/microcontainer/mcdocs/trunk/userguide/src/main/docbook/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Mon Mar 29 01:55:44 EDT 2010
Author: misty at redhat.com
Date: 2010-03-29 01:55:43 -0400 (Mon, 29 Mar 2010)
New Revision: 103096
Modified:
projects/microcontainer/mcdocs/trunk/userguide/src/main/docbook/en-US/Getting_Started.xml
projects/microcontainer/mcdocs/trunk/userguide/src/main/docbook/en-US/JBoss_Microcontainer_2.0.0.GA.ent
Log:
Polishing the Getting Started chapter
Modified: projects/microcontainer/mcdocs/trunk/userguide/src/main/docbook/en-US/Getting_Started.xml
===================================================================
--- projects/microcontainer/mcdocs/trunk/userguide/src/main/docbook/en-US/Getting_Started.xml 2010-03-29 05:49:44 UTC (rev 103095)
+++ projects/microcontainer/mcdocs/trunk/userguide/src/main/docbook/en-US/Getting_Started.xml 2010-03-29 05:55:43 UTC (rev 103096)
@@ -6,7 +6,7 @@
<title>Getting Started</title>
<chapter id="overview">
<title>Introduction</title>
- <para>The Java platform has traditionally been distributed in 3 editions, each providing a
+ <para>The Java platform has traditionally been distributed in three editions, each providing a
different type of runtime environment: </para>
<itemizedlist>
<listitem>
@@ -21,148 +21,161 @@
applications)</para>
</listitem>
</itemizedlist>
- <para>Each environment aims to provide a base level of functionality on top of which
- developers can add their own code to create applications. For example Java SE provides
- networking and security libraries together with graphical user interface toolkits to
- facilitate the development of desktop and simple client-server applications. Java EE takes
- this a stage further by adding a number of 'enterprise services' such as
- transactions, messaging, and persistence that allow much more robust and scalable
- 'enterprise applications' to be developed. These services are typically combined
- together inside a JEE application server in order to provide a standard runtime environment
- for enterprise applications but it is often the case that some are never used.</para>
- <para>Services that are never used are undesirable as they can take up valuable resources such
- as CPU and memory resulting in lower performance. They may also clutter up the environment
- with redundant configuration files, complicating maintenance and adding unnecessary
- complexity. Given these drawbacks it would be better if there was a way to create a custom
- runtime environment containing only those services that were needed. You would then be able
- to create your own custom 'Java Edition' tailored to your requirements.</para>
- <para>JBoss Microcontainer aims to provide these capabilities by allowing services, created
- using Plain Old Java Objects (POJOs), to be deployed into a standard Java SE runtime
- environment in a controlled manner to create a customized environment for your applications.
- Dependencies are fully managed to ensure that new services cannot be deployed until services
- they depend on have first been deployed. Where it makes sense to do so you can even redeploy
- services at runtime providing that you access them via the microcontainer bus. Undeploying a
- service causes all dependent services to be undeployed first in order to maintain the
- integrity of the system. </para>
- <para>JBoss Application Server 5.0 uses the microcontainer to integrate enterprise services
- together with a Servlet/JSP container, EJB container, deployers and management utilities in
- order to provide a standard Java EE environment. If you need additional services then you
- can simply deploy these on top of Java EE to provide the functionality you need. Likewise
- you are free to remove any services that you don't need simply by changing the
- configuration. You can even use the microcontainer to do this in other environments such as
- Tomcat and GlassFish since you can plug in different classloading models during the service
- deployment phase.</para>
- <para>Since JBoss Microcontainer is very lightweight and deals with POJOs it can also be used
- to deploy services into a Java ME runtime environment. This opens up new possibilities for
- mobile applications that can now take advantage of enterprise services without requiring a
- full JEE application server. </para>
- <para>In common with other lightweight containers JBoss Microcontainer uses dependency
- injection to wire individual POJOs together to create services. Configuration is performed
- using either annotations or XML depending on where the information is best located. Finally
- unit testing is made extremely simple thanks to a helper class that extends JUnit to setup
- the test environment, allowing you to access POJOs and services from your test methods using
- just a few lines of code.</para>
+ <para>
+ Each environment aims to provide a base level of functionality on top of which developers can add their own code to create applications. For example, Java SE provides networking and security libraries along with graphical user interface (GUI) toolkits to facilitate the development of desktop and simple client-server applications. Java EE takes this a step further by adding a number of enterprise services such as transactions, messaging, and persistence, that allow much more robust and scalable enterprise applications to be developed. These services are typically combined together inside a JEE application server in order to provide a standard runtime environment for enterprise applications but normally, some applications remain unused.
+ </para>
+ <para>
+ Services that are never used take up valuable resources, such as CPU and memory, resulting in lower performance. They may also clutter the environment with redundant configuration files, complicating maintenance and adding unnecessary complexity. Given these drawbacks it is good to create a custom runtime environment containing only those services that are necessary. You are now able to create your own custom 'Java Edition' tailored to your requirements.
+ </para>
+ <para>
+ JBoss Microcontainer aims to provide these capabilities by allowing services, created using Plain Old Java Objects (POJOs), to be deployed into a standard Java SE runtime environment in a controlled manner, to create a customized environment for your applications. Dependencies are fully managed to ensure that new services cannot be deployed until services they depend on are deployed first. Services can be redeployed at runtime providing that you access them via the microcontainer bus. Undeploying a service causes all dependent services to be undeployed first in order to maintain the integrity of the system.
+ </para>
+ <para>
+ JBoss Application Server 5.0 uses the microcontainer to integrate enterprise services together with a Servlet/JSP container, EJB container, deployers and management utilities to provide a standard Java EE environment. If you need additional services, deploy these on top of Java EE to provide the functionality you need. You can remove any unnecessary services by changing the configuration. You can even use the microcontainer to do this in other environments such as Tomcat and GlassFish by plugging in different classloading models during the service deployment phase.
+ </para>
+ <para>
+ Because JBoss Microcontainer is lightweight and uses POJOs it can also be used to deploy services into a Java ME runtime environment. This opens up new possibilities for mobile applications that can take advantage of enterprise services without requiring a full JEE application server.
+ </para>
+ <para>
+ JBoss Microcontainer uses dependency injection to wire individual POJOs together to create services. Configuration is performed using either annotations or XML. Finally, unit testing is greatly simplified by a helper class that extends JUnit to set up the test environment, allowing you to access POJOs and services from your test methods using just a few lines of code.
+ </para>
</chapter>
<chapter>
<title>Download and Installing</title>
- <para>JBoss Microcontainer 2.0.0 is available for download from <ulink
- url="http://www.jboss.org/jbossmc/downloads">the JBoss Microcontainer downloads</ulink>
- page. The initial downloads page is split into two sections: <ulink
- url="http://www.jboss.org/jbossmc/downloads/individual">Individual Projects</ulink>, which
- contains the jars for the individual projects that make up the JBoss Microcontainer, and
- <ulink url="http://www.jboss.org/jbossmc/downloads/framework">Frameworks</ulink>, which
- give you usable distributions containing all the dependencies. The two frameworks shipped
- are the <ulink url="http://www.jboss.org/jbossmc/downloads/framework/jboss-kernel">JBoss
- Kernel</ulink> and <ulink
- url="http://www.jboss.org/jbossmc/downloads/framework/jboss-deployers">JBoss Virtual
- Deployment Framework</ulink>. The JBoss Kernel distribution contains the core framework,
- which is discussed in Parts I, II and III. The JBoss Virtual Deployment Framework contains
- the JBoss Kernel as well as advanced classloading capabilities and deployer functionality,
- as discussed in Part IV.</para>
- <para>JBoss Microcontainer 2.0.0 is also available via Maven2. This means that you need to
- install and configure Maven before you can begin development. Once this is done then you can
- create a maven project that depends on the JBoss Microcontainer JARs in order to download
- and install them into your local maven repository. You can then create an assembly for your
- final application in order to package the relevant JARs into a distributable format.</para>
- <para>The examples created for this User Guide use Maven2 for their configuration to achieve
- exactly this so it is highly recommended that you <ulink
+ <para>
+ JBoss Microcontainer 2.0.0 is available for download from <ulink url="http://www.jboss.org/jbossmc/downloads">the JBoss Microcontainer downloads</ulink> page. The initial downloads page is split into two sections:
+ <variablelist>
+ <varlistentry>
+ <term><ulink url="http://www.jboss.org/jbossmc/downloads/individual">Individual Projects</ulink></term>
+ <listentry>
+ <para>
+ contains the jars for the individual projects that make up the JBoss Microcontainer
+ </para>
+ </listentry>
+ </varlistentry>
+ <varlistentry>
+ <term><ulink url="http://www.jboss.org/jbossmc/downloads/framework">Frameworks</ulink></term>
+ <listentry>
+ <para>
+ provides usable distributions containing all the dependencies.
+ </para>
+ </listentry>
+ </varlistentry>
+ </variablelist>
+
+ The two frameworks shipped are the <ulink url="http://www.jboss.org/jbossmc/downloads/framework/jboss-kernel">JBoss Kernel</ulink> and <ulink url="http://www.jboss.org/jbossmc/downloads/framework/jboss-deployers">JBoss Virtual Deployment Framework</ulink>. The JBoss Kernel distribution contains the core framework, which is discussed in Parts I, II and III. The JBoss Virtual Deployment Framework contains the JBoss Kernel, as well as advanced classloading capabilities and deployer functionality, as discussed in Part IV.<remark>Fix these number references by doing real xref's</remark>
+ </para>
+ <para>
+ JBoss Microcontainer 2.0.0 is also available via Maven2. You need to install and configure Maven before you can begin development. Then create a maven project that depends on the JBoss Microcontainer JARs, in order to download and install them into your local maven repository. Finally, create an assembly for your final application in order to package the relevant JARs into a distributable format.
+ </para>
+ <para>
+ The examples created for this User Guide use Maven2 for their configuration for its modularity. <ulink
url="http://labs.jboss.com/file-access/default/members/jbossmc/downloads/userGuide-examples-13112007.zip"
- >download</ulink> these first and take a look at how they work.</para>
+ >Download</ulink> the examples first and take a look at how they work.
+ </para>
<note>
- <para>To build and run the examples you first need to install and configure Maven 2.0.9
- available from <ulink url="http://maven.apache.org/"
- >http://maven.apache.org/</ulink></para>
- <para>Installation is performed by downloading and unzipping the maven-2.0.9-bin.zip file to
- a convenient location on your local disk. Configuration consists of adding $MAVEN_HOME/bin
- to your path and adding the following profile to your ~/.m2/settings.xml file:</para>
- <programlisting role="XML"><settings>
- <profiles>
- <profile>
- <id>jboss.repository</id>
- <activation>
- <property>
- <name>!jboss.repository.off</name>
- </property>
- </activation>
- <repositories>
- <repository>
- <id>snapshots.jboss.org</id>
- <url>http://snapshots.jboss.org/maven2</url>
- <snapshots>
- <enabled>true</enabled>
- </snapshots>
- </repository>
- <repository>
- <id>repository.jboss.org</id>
- <url>http://repository.jboss.org/maven2</url>
- <snapshots>
- <enabled>false</enabled>
- </snapshots>
- </repository>
- </repositories>
- <pluginRepositories>
- <pluginRepository>
- <id>repository.jboss.org</id>
- <url>http://repository.jboss.org/maven2</url>
- <snapshots>
- <enabled>false</enabled>
- </snapshots>
- </pluginRepository>
- <pluginRepository>
- <id>snapshots.jboss.org</id>
- <url>http://snapshots.jboss.org/maven2</url>
- <snapshots>
- <enabled>true</enabled>
- </snapshots>
- </pluginRepository>
- </pluginRepositories>
- </profile>
- </profiles>
- </settings></programlisting>
- <para>This profile informs maven of the two JBoss repositories (snapshots and releases) that
- are needed to download the JBoss Microcontainer and dependant JARs.</para>
+ <para>
+ To build and run the examples you first need to install and configure Maven 2.0.9 available from <ulink url="http://maven.apache.org/" />
+ </para>
+ <procedure>
+ <title>Installing Maven</title>
+ <step>
+ <para>
+ Download and unzip the <filename>maven-2.0.9-bin.zip</filename> file to a convenient location on your local disk. This local location will henceforth be referred to as MAVEN_HOME.
+ </para>
+ </step>
+ <step>
+ <para>
+ Add MAVEN_HOME/bin to your environment path, using the procedure appropriate for your operating system.
+ </para>
+ </step>
+ <step>
+ <para>
+ Add the following profile to your ~/.m2/settings.xml file:
+ </para>
+ <programlisting role="XML"><settings>
+ <profiles>
+ <profile>
+ <id>jboss.repository</id>
+ <activation>
+ <property>
+ <name>!jboss.repository.off</name>
+ </property>
+ </activation>
+ <repositories>
+ <repository>
+ <id>snapshots.jboss.org</id>
+ <url>http://snapshots.jboss.org/maven2</url>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+ <repository>
+ <id>repository.jboss.org</id>
+ <url>http://repository.jboss.org/maven2</url>
+ <snapshots>
+ <enabled>false</enabled>
+ </snapshots>
+ </repository>
+ </repositories>
+ <pluginRepositories>
+ <pluginRepository>
+ <id>repository.jboss.org</id>
+ <url>http://repository.jboss.org/maven2</url>
+ <snapshots>
+ <enabled>false</enabled>
+ </snapshots>
+ </pluginRepository>
+ <pluginRepository>
+ <id>snapshots.jboss.org</id>
+ <url>http://snapshots.jboss.org/maven2</url>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </pluginRepository>
+ </pluginRepositories>
+ </profile>
+ </profiles>
+ </settings>
+ </programlisting>
+ <para>
+ This profile informs maven of the two JBoss repositories (snapshots and releases) that are needed to download the JBoss Microcontainer and dependant JARs.
+ </para>
+ </step>
+ </procedure>
</note>
- <para>Once you have configured Maven and downloaded the examples then you can go to one of the
- following subdirectories in the <filename>examples/User_Guide</filename> directory and enter
- <command>mvn install</command> to perform a build:</para>
- <itemizedlist>
- <listitem>
- <para>gettingStarted - projects for creating and using a service together with AOP</para>
- </listitem>
- <listitem>
- <para>pojoDevelopment - examples of creating and configuring POJOs using XML and
- annotations</para>
- </listitem>
- <listitem>
- <para>aopDevelopment - examples of using AOP to add behaviour to POJOs</para>
- </listitem>
- <listitem>
- <para>extending - examples of how we created various extensions to the microcontainer by
- creating new dependencies</para>
- </listitem>
- </itemizedlist>
- <para>Instructions on how to run the individual examples can be found in the corresponding
- parts of this guide.</para>
+ <para>
+ After you have configured Maven and downloaded the examples, you can change to one of the following subdirectories in the <filename>examples/User_Guide</filename> directory and enter <command>mvn install</command> to perform a build:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>>gettingStarted</term>
+ <listitem>
+ <para>projects for creating and using a service with AOP</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pojoDevelopment</term>
+ <listitem>
+ <para>examples of creating and configuring POJOs using XML and annotations</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>aopDevelopment</term>
+ <listitem>
+ <para>examples of using AOP to add behaviour to POJOs</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>extending</term>
+ <listitem>
+ <para>examples of creating various extensions to the microcontainer by creating new dependencies</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ Instructions on how to run the individual examples can be found in the corresponding parts of this guide.
+ </para>
</chapter>
<chapter>
<title>Building services</title>
Modified: projects/microcontainer/mcdocs/trunk/userguide/src/main/docbook/en-US/JBoss_Microcontainer_2.0.0.GA.ent
===================================================================
--- projects/microcontainer/mcdocs/trunk/userguide/src/main/docbook/en-US/JBoss_Microcontainer_2.0.0.GA.ent 2010-03-29 05:49:44 UTC (rev 103095)
+++ projects/microcontainer/mcdocs/trunk/userguide/src/main/docbook/en-US/JBoss_Microcontainer_2.0.0.GA.ent 2010-03-29 05:55:43 UTC (rev 103096)
@@ -1 +1,2 @@
-<!ENTITY % RH-ENTITIES SYSTEM "Common_Config/rh-entities.ent">
\ No newline at end of file
+<!ENTITY % RH-ENTITIES SYSTEM "Common_Config/rh-entities.ent">
+<!ENTITY BOOKID "Microcontainer User Guide">
\ No newline at end of file
More information about the jboss-cvs-commits
mailing list