[gatein-commits] gatein SVN: r9251 - epp/docs/JPP/trunk/Reference_Guide/en-US/modules/Advanced.

Author: jaredmorgs Date: 2013-04-03 21:23:32 -0400 (Wed, 03 Apr 2013) New Revision: 9251 Modified: epp/docs/JPP/trunk/Reference_Guide/en-US/modules/Advanced/Foundations.xml Log: Foundations.xml - ^Cmoved all the xmlns attributes and corrected the xi:include references with correct nesting so they would resolve correctly. Modified: epp/docs/JPP/trunk/Reference_Guide/en-US/modules/Advanced/Foundations.xml =================================================================== --- epp/docs/JPP/trunk/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2013-04-02 16:31:26 UTC (rev 9250) +++ epp/docs/JPP/trunk/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2013-04-04 01:23:32 UTC (rev 9251) @@ -6,7 +6,7 @@ <chapter id="chap-Reference_Guide-Foundations"> <title>The eXo Kernel</title> <remark>MOVED to Development Guide - The_eXo_Kernel.xml</remark> - <section xmlns="" id="sect-Reference_Guide-The_eXo_Kernel"> + <section id="sect-Reference_Guide-The_eXo_Kernel"> <title>eXo Kernel</title> <para> JBoss Portal Platform is built as a set of services on top of a dependency injection kernel. The kernel provides configuration, life-cycle handling, component scopes and some core services. @@ -138,7 +138,7 @@ </note> </section> </section> - <section xmlns="" id="sect-Reference_Guide-Configuration_Retrieval"> + <section id="sect-Reference_Guide-Configuration_Retrieval"> <title>Configuration Retrieval</title> <para> The container performs the following steps for configuration retrieval, depending on the container type. @@ -203,7 +203,7 @@ The effective configuration of the StandaloneContainer, RootContainer and/or PortalContainer can be known thanks to the method <emphasis>getConfigurationXML</emphasis>() that is exposed through JMX at the container&apos;s level. This method will give you the effective configuration in XML format that has been really interpreted by the kernel. This could be helpful to understand how a given component or plug-in has been initialized. </para> </section> - <section xmlns="" id="sect-Reference_Guide-Advanced_concepts_for_the_PortalContainers"> + <section id="sect-Reference_Guide-Advanced_concepts_for_the_PortalContainers"> <title>Advanced concepts for the <emphasis>PortalContainers</emphasis></title> <para> Since eXo JCR 1.12, we added a set of new features that have been designed to extend portal applications such as JBoss Portal Platform. @@ -1190,7 +1190,7 @@ </note> </section> </section> - <section xmlns="" id="sect-Reference_Guide-Runtime_configuration_profiles"> + <section id="sect-Reference_Guide-Runtime_configuration_profiles"> <title>Runtime configuration profiles</title> <para> The kernel configuration is able to handle configuration profiles at runtime (as opposed to packaging time). @@ -1356,7 +1356,7 @@ </section> </section> </section> - <section xmlns="" id="sect-Reference_Guide-Component_request_life_cycle"> + <section id="sect-Reference_Guide-Component_request_life_cycle"> <title>Component request life cycle</title> <section id="sect-Reference_Guide-Component_request_life_cycle-Component_request_life_cycle_contract"> <title>Component request life cycle contract</title> @@ -1433,7 +1433,7 @@ </section> </section> </section> - <section xmlns="" id="sect-Reference_Guide-Configuring_Services"> + <section id="sect-Reference_Guide-Configuring_Services"> <title>Configuring Services</title> <para> The eXo Kernel uses dependency injection to create services based on <filename>configuration.xml</filename> configuration files. The location of the configuration files determines if services are placed into the <literal>RootContainer</literal> scope, or into the <literal>PortalContainer</literal> scope. @@ -1477,7 +1477,7 @@ <para> The usual approach is to specify an interface as a key. </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default.xml" parse="text"/></programlisting> <para> The configuration found inside the jar file is considered as the default configuration. If you want to override this default configuration you can do it in different places outside the jar. When the container finds several configurations for the same service, the configuration which is found later replaces completely the one found previously. Let&apos;s call this the <emphasis>configuration override mechanism</emphasis>. </para> @@ -1664,7 +1664,7 @@ <para> In the following example the <literal>PortalContainerDefinitionPlugin</literal> implements the <literal>ComponentPlugin</literal>: </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default1.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default1.xml" parse="text"/></programlisting> <para> The <emphasis role="bold">&lt;target-component&gt;</emphasis> defines the service for which the plug-in is defined. The configuration is injected by the container using a method that is defined in <emphasis role="bold">&lt;set-method&gt;</emphasis>. The method has exactly one argument of the type org.exoplatform.services.cms.categories.impl.TaxonomyPlugin: </para> @@ -1782,7 +1782,7 @@ <para> Below is an example <filename>configuration.xml</filename> that &apos;outsources&apos; its content into several files: </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default2.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default2.xml" parse="text"/></programlisting> <para> Comment #1: This line is being used to reference another configuration file. The <code>war:</code> URL schema indicates that the following path is to be resolved relative to the current <literal>PortalContainer</literal>&apos;s servlet context resource path, starting with <emphasis role="bold">WEB-INF</emphasis> as a root. </para> @@ -1812,7 +1812,7 @@ <para> A good example of this is the <emphasis role="bold">HibernateService</emphasis>: </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default3.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default3.xml" parse="text"/></programlisting> </section> </section> <section id="sect-Reference_Guide-Configuration_syntax-InitParams_configuration_element"> @@ -1831,7 +1831,7 @@ <para> Below is an example of how the kernel XML configuration syntax looks when creating &lt;init-params&gt; instances: </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default4.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default4.xml" parse="text"/></programlisting> <para> An &lt;init-params&gt; element description begins with an &lt;init-params&gt; element. </para> @@ -1900,11 +1900,11 @@ <para> The value specification for &lt;value-param&gt; elements is a &lt;value&gt; element which defines a <literal>String</literal> instance. </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default5.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default5.xml" parse="text"/></programlisting> <para> The value specification for &lt;values-param&gt; requires one or more &lt;value&gt; elements. Each &lt;value&gt; represents one <literal>String</literal> instance. All <literal>String</literal> values are then collected into a <literal>java.util.List</literal> instance. </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default6.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default6.xml" parse="text"/></programlisting> <example> <title>&lt;value-param&gt; Example</title> <programlisting language="XML" role="XML"> &lt;component&gt; @@ -2215,7 +2215,7 @@ </section> </section> </section> - <section xmlns="" id="sect-Reference_Guide-Specific_Services"> + <section id="sect-Reference_Guide-Specific_Services"> <title>Specific Services</title> <section id="sect-Reference_Guide-Specific_Services-ListenerService"> <title>ListenerService</title> @@ -2894,7 +2894,7 @@ </section> </section> </section> - <section xmlns="" id="sect-Reference_Guide-Configuring_a_portal_container"> + <section id="sect-Reference_Guide-Configuring_a_portal_container"> <title>Configuring a portal container</title> <para> A <literal>portal container</literal> is defined by several attributes: @@ -2933,7 +2933,7 @@ </listitem> </varlistentry> </variablelist> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default7.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default7.xml" parse="text"/></programlisting> <para> Dependencies are part of the <emphasis role="bold">extension mechanism</emphasis> which is discussed later in this document. </para> @@ -2984,7 +2984,7 @@ Resources from other web applications are queried in the order specified by the dependencies. The later entries in the list override the previous ones. </para> </section> - <section xmlns="" id="sect-Reference_Guide-System_property_configuration"> + <section id="sect-Reference_Guide-System_property_configuration"> <title>System property configuration</title> <para> A new property configuration service has been developed for taking care of configuring system properties from the inline kernel configuration or from specified property files. @@ -3046,7 +3046,7 @@ </para> </section> </section> - <section xmlns="" id="sect-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions"> + <section id="sect-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions"> <title>The Extension Mechanism and Portal Extensions</title> <para> The <emphasis role="bold">Extension mechanism</emphasis> makes it possible to override portal resources in a way similar to hardware plug-and-play functionalities. @@ -3066,7 +3066,7 @@ <para> This example shows a portal extension called <emphasis role="bold">sample-ext</emphasis>. </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default8.xml" parse="text"/></programlisting> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default8.xml" parse="text"/></programlisting> </step> <step> <para> @@ -3126,7 +3126,7 @@ <para> If your servlet handles the requests by implementing a <literal>service()</literal> method, that method must be renamed to match the following signature: </para> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default9.java" parse="text"/></programlisting> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default9.java" parse="text"/></programlisting> <note> <para> This ensures that <literal>AbstractHttpServlet</literal>&apos;s <literal>service()</literal> interception is not overwritten. @@ -3138,11 +3138,11 @@ <para> In this instance, modify the method signatures as follows: </para> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default10.java" parse="text"/></programlisting> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default10.java" parse="text"/></programlisting> <para> Another method must also be implemented in this case: </para> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default11.java" parse="text"/></programlisting> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/default11.java" parse="text"/></programlisting> <para> If this method returns <emphasis>true</emphasis> the current thread&apos;s context Classloader is set up according to the <emphasis role="bold">dependencies</emphasis> configuration and availability of the associated web applications. </para> @@ -3176,7 +3176,7 @@ <para> An example of this is the Gadgets application which registers Google gadgets with the current <literal>PortalContainer</literal>. This example uses <emphasis role="bold">PortalContainerPostInitTask</emphasis> which is executed after the portal container has been initialized. </para> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/GadgetRegister.java" parse="text"/></programlisting> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Advanced_Development_Foundations/GadgetRegister.java" parse="text"/></programlisting> <para> In some situations initialization may be required <emphasis>after</emphasis> the portal container is instantiated but <emphasis>before</emphasis> it has initialized. <literal>PortalContainerPreInitTask</literal> can be used in that case. </para> @@ -3197,7 +3197,7 @@ </para> </section> </section> - <section xmlns="" id="sect-Reference_Guide-Manageability"> + <section id="sect-Reference_Guide-Manageability"> <title>Manageability</title> <section id="sect-Reference_Guide-Manageability-Introduction"> <title>Introduction</title>