[gatein-commits] gatein SVN: r8848 - in epp/docs/branches/6.0/Reference_Guide/en-US: modules and 2 other directories.

Author: jaredmorgs Date: 2012-09-16 23:31:58 -0400 (Sun, 16 Sep 2012) New Revision: 8848 Added: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletBridge/ Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml Log: BZ#856417 - Created Portlet Bridge part in the Reference Guide to contain the information. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -5,10 +5,10 @@ ]> <bookinfo id="book-Reference_Guide-Reference_Guide"> <title>Reference Guide</title> - <subtitle>An in-depth guide to Enterprise Portal Platform 5.2, and its patch releases.</subtitle> + <subtitle>An in-depth guide to Enterprise Portal Platform 6.0, and its patch releases.</subtitle> <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>5.2</productnumber> - <edition>5.2.2</edition> + <productnumber>6.0</productnumber> + <edition>6.0.0</edition> <abstract> <para> This Reference Guide is a high-level usage document. It deals with more advanced topics than the Installation and User Guides, adding new content or taking concepts discussed in the earlier documents further. It aims to provide supporting documentation for advanced users of the JBoss Enterprise Portal Platform product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent 2012-09-17 03:31:58 UTC (rev 8848) @@ -5,16 +5,16 @@ <!ENTITY BOOKID "Reference Guide"> <!-- Bugzilla Specifics --> -<!ENTITY BZPRODUCT "JBoss Enterprise Portal Platform 5"> +<!ENTITY BZPRODUCT "JBoss Enterprise Portal Platform 6"> <!ENTITY BZCOMPONENT "docs-Reference_Guide"> -<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... +<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... <!-- Corporate Specifics: --> <!ENTITY YEAR "2012"> <!ENTITY HOLDER "Red Hat, Inc"> <!-- Version Specifcs: --> -<!ENTITY VX "5"> -<!ENTITY VY "5.2"> -<!ENTITY VZ "5.2.2"> -<!ENTITY WSRP_VERSION "2.1.7-EPP522-GA"> +<!ENTITY VX "6"> +<!ENTITY VY "6.0"> +<!ENTITY VZ "6.0.0"> +<!ENTITY WSRP_VERSION "CHANGEME"> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -9,9 +9,60 @@ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Introduction.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortalDevelopment.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortletDevelopment.xml"/> -<!-- <xi:include href="modules/GadgetDevelopment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/WSRP.xml"/> +<!-- <xi:include href="modules/GadgetDevelopment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <part> + <title>Authentication and Authorization</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity.xml"/> + </part> + <part> + <title>Portlet Bridge</title> + <chapter> + <title><remark/>Overview</title> + <section> + <title>Portlet Bridge</title> + <para>A portlet bridge allows non-native application frameworks to run in a portal environment, independent to the underlying portlet API, or portlet concept. This functionality provides a developer flexibility to continue writing applications in a preferred language, and allows a controlled transition to new technologies. </para> + </section> + <section> + <title>JBoss Portlet Bridge</title> + <para>The JBoss Portlet Bridge is a non-final draft implementation of the JSR-329 specification which supports the JSF 1.2 and 2.0 runtime within a JSR 168 or 286 portlet and with added enhancements to support other web frameworks (such as Seam and RichFaces). + +The project follows the spec from JSR-301 to JSR-329 and now maintains an alpha version (3.0) compatible with JSF 2.0 and RichFaces 4.0.</para> + </section> + <section> + <title>File Locations</title> + <remark>BZ#856417 - NEEDINFO - Do not have the root configuration directory for Portlet Bridge. Asked Ken in email on 17th Sep.</remark> + <para>Configuration files for Portlet Bridge are located in the &lt;DIRECTORY PATH GOES HERE&gt;.</para> + <para><variablelist> + <varlistentry> + <term>portlet.xml</term> + <listitem> + <para>Contains the primary configuration information for the portlet. Information such as the GenericFacesPortlet location, and which Java Server Faces (JSF) pages to render are stored in this file.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>faces-config.xml</term> + <listitem> + <para>Contains</para> + </listitem> + </varlistentry> + <varlistentry> + <term>web.xml</term> + <listitem> + <para/> + </listitem> + </varlistentry> + </variablelist></para> + </section> + </chapter> + <chapter> + <title>Configuration </title> + <section/> + </chapter> + </part> + <part> + <title>Web Services for Remote Portlets (WSRP)</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/WSRP.xml"/> + </part> + <part/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Advanced.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/eXoJCR.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -1,148 +1,131 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-Reference_Guide-The_eXo_Kernel"> - <title>The eXo Kernel</title> - <para> - JBoss Enterprise 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. - </para> - <para> - The portal kernel and the JCR used in JBoss Enterprise Portal Platform use the <emphasis>Inversion of Control</emphasis> (<emphasis role="bold">IoC</emphasis>) system to control service instantiation. This method is also known as 'dependency injection'. - </para> - <para> - In this system, services are not responsible for the instantiation of the components on which they depend. It prevents objects creating the instances of any objects referenced. This task is delegated to the container. The below image illustrates this: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/Advanced/Foundations/ioc.png" format="PNG" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" fileref="images/Advanced/Foundations/ioc.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <para> - There are two ways to inject a dependency : - </para> - <para> - Using a constructor: - </para> - -<programlisting language="Java" role="Java">public ServiceA(ServiceB serviceB)</programlisting> - <para> - Using setter methods: - </para> - -<programlisting language="Java" role="Java">public void setServiceB(ServiceB serviceB)</programlisting> - <para> - When a client service can not be stored in the container then the service locator pattern is used: - </para> - -<programlisting language="Java" role="Java">public ServiceA(){ + <title>eXo Kernel</title> + <para> + JBoss Enterprise 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. + </para> + <para> + The portal kernel and the JCR used in JBoss Enterprise Portal Platform use the <emphasis>Inversion of Control</emphasis> (<emphasis role="bold">IoC</emphasis>) system to control service instantiation. This method is also known as &apos;dependency injection&apos;. + </para> + <para> + In this system, services are not responsible for the instantiation of the components on which they depend. It prevents objects creating the instances of any objects referenced. This task is delegated to the container. The below image illustrates this: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata width="444" align="center" fileref="images/Advanced/Foundations/ioc.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata width="444" align="center" fileref="images/Advanced/Foundations/ioc.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + There are two ways to inject a dependency : + </para> + <para> + Using a constructor: + </para> + <programlisting language="Java" role="Java">public ServiceA(ServiceB serviceB)</programlisting> + <para> + Using setter methods: + </para> + <programlisting language="Java" role="Java">public void setServiceB(ServiceB serviceB)</programlisting> + <para> + When a client service can not be stored in the container then the service locator pattern is used: + </para> + <programlisting language="Java" role="Java">public ServiceA(){ this.serviceB =Container.getSInstance().getService(ServiceB.class); }</programlisting> - <para> - The container package is responsible of building a hierarchy of containers. Each service will then be registered in one container or the other according to the XML configuration file it is defined in. It is important to understand that there can be several PortalContainer instances that all are children of the RootContainer. - </para> - <para> - The behavior of the hierarchy is similar to a class loader one, hence when you will lookup a service that depends on another one, the container will look for it in the current container and if it cannot be found, then it will look in the parent container. That way you can load all the reusable business logic components in the same container (here the RootContainer) and differentiate the service implementation from one portal instance to the other by just loading different service implementations in two sibling PortalContainers. - </para> - <para> - Therefore, if you look at the Portal Container as a service repository for all the business logic in a portal instance, then you understand why several PortalContainers allows you to manage several portals (each one deployed as a single war) in the same server by just changing XML configuration files. - </para> - <para> - The default configuration XML files are packaged in the service jar. There are three configuration.xml files, one for each container type. In that XML file, we define the list of services and their init parameters that will be loaded in the corresponding container. - </para> - <para> - Service components exist in two scopes. The first scope is represented by the <literal>RootContainer</literal>. It contains services that exist independently of any portal, and can be accessed by all portals. - </para> - <para> - The second scope, the <literal>PortalContainer</literal>, is portal-specific. Each portal exists in an instance of the <literal>PortalContainer</literal>. This scope contains services that are common for a set of portals, and services which should not be shared by all portals. - </para> - <itemizedlist> - <listitem> - <para> - RootContainer: This is a base container. This container plays an important role during startup, but you should not use it directly. - </para> + <para> + The container package is responsible of building a hierarchy of containers. Each service will then be registered in one container or the other according to the XML configuration file it is defined in. It is important to understand that there can be several PortalContainer instances that all are children of the RootContainer. + </para> + <para> + The behavior of the hierarchy is similar to a class loader one, hence when you will lookup a service that depends on another one, the container will look for it in the current container and if it cannot be found, then it will look in the parent container. That way you can load all the reusable business logic components in the same container (here the RootContainer) and differentiate the service implementation from one portal instance to the other by just loading different service implementations in two sibling PortalContainers. + </para> + <para> + Therefore, if you look at the Portal Container as a service repository for all the business logic in a portal instance, then you understand why several PortalContainers allows you to manage several portals (each one deployed as a single war) in the same server by just changing XML configuration files. + </para> + <para> + The default configuration XML files are packaged in the service jar. There are three configuration.xml files, one for each container type. In that XML file, we define the list of services and their init parameters that will be loaded in the corresponding container. + </para> + <para> + Service components exist in two scopes. The first scope is represented by the <literal>RootContainer</literal>. It contains services that exist independently of any portal, and can be accessed by all portals. + </para> + <para> + The second scope, the <literal>PortalContainer</literal>, is portal-specific. Each portal exists in an instance of the <literal>PortalContainer</literal>. This scope contains services that are common for a set of portals, and services which should not be shared by all portals. + </para> + <itemizedlist> + <listitem> + <para> + RootContainer: This is a base container. This container plays an important role during startup, but you should not use it directly. + </para> + </listitem> + <listitem> + <para> + PortalContainer: Created at the startup of the portal web application (in the init() method of the PortalController servlet) + </para> + </listitem> + </itemizedlist> + <para> + <mediaobject> + <imageobject role="html"> + <imagedata width="444" align="center" scale="100" fileref="images/Advanced/Foundations/PortalContainers.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata width="444" contentwidth="150mm" align="center" fileref="images/Advanced/Foundations/PortalContainers.png" format="PNG"/> + </imageobject> + </mediaobject> - </listitem> - <listitem> - <para> - PortalContainer: Created at the startup of the portal web application (in the init() method of the PortalController servlet) - </para> + </para> + <para> + As there can be several portal container instances per JVM. it is important to be able to configure the loaded services per instance. Therefore all the default configuration files located in the service impl jar can be overridden from the portal war. + </para> + <para> + Whenever a specific service is looked up through the <literal>PortalContainer</literal>, and the service is not available, the lookup is delegated further up to the <literal>RootContainer</literal>. + </para> + <para> + JBoss Enterprise Portal Platform can have default instances of a certain component in the <literal>RootContainer</literal>, and portal specific instances in some or all <literal>PortalContainers</literal>, that override the default instance. + </para> + <para> + Whenever your portal application has to be integrated more closely with eXo services, these services can be looked up through the <literal>PortalContainer</literal>. + </para> + <important> + <para> + Only officially documented services should be accessed this way, and used according to documentation, as most of the services are an implementation detail of eXo, and subject to change without notice. + </para> + </important> + <section id="sect-Reference_Guide-The_eXo_Kernel-Kernel_configuration_namespace"> + <title>Kernel configuration namespace</title> + <para> + To be effective, the namespace URI <uri>http://www.exoplaform.org/xml/ns/kernel_1_2.xsd</uri> must be target namespace of the XML configuration file. + </para> + <programlisting language="XML" role="XML">&lt;configuration xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; + xsi:schemaLocation=&quot;http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd&quot; + xmlns=&quot;http://www.exoplaform.org/xml/ns/kernel_1_2.xsd&quot;... - </listitem> - </itemizedlist> - <para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/Advanced/Foundations/PortalContainers.png" format="PNG" scale="100" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/Advanced/Foundations/PortalContainers.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </para> - <para> - As there can be several portal container instances per JVM. it is important to be able to configure the loaded services per instance. Therefore all the default configuration files located in the service impl jar can be overridden from the portal war. - </para> - <para> - Whenever a specific service is looked up through the <literal>PortalContainer</literal>, and the service is not available, the lookup is delegated further up to the <literal>RootContainer</literal>. - </para> - <para> - JBoss Enterprise Portal Platform can have default instances of a certain component in the <literal>RootContainer</literal>, and portal specific instances in some or all <literal>PortalContainers</literal>, that override the default instance. - </para> - <para> - Whenever your portal application has to be integrated more closely with eXo services, these services can be looked up through the <literal>PortalContainer</literal>. - </para> - <important> - <para> - Only officially documented services should be accessed this way, and used according to documentation, as most of the services are an implementation detail of eXo, and subject to change without notice. - </para> - - </important> - <section id="sect-Reference_Guide-The_eXo_Kernel-Kernel_configuration_namespace"> - <title>Kernel configuration namespace</title> - <para> - To be effective, the namespace URI <uri>http://www.exoplaform.org/xml/ns/kernel_1_2.xsd</uri> must be target namespace of the XML configuration file. - </para> - -<programlisting language="XML" role="XML">&lt;configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" - xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"&gt; - - ... &lt;/configuration&gt;</programlisting> - <note> - <para> - Any values in the configuration files can be created thanks to variables since the eXo kernel resolves them, for example the following configuration will be well interpreted: - </para> - -<programlisting language="XML" role="XML">&lt;configuration -xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" -xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" -xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"&gt; + <note> + <para> + Any values in the configuration files can be created thanks to variables since the eXo kernel resolves them, for example the following configuration will be well interpreted: + </para> + <programlisting language="XML" role="XML">&lt;configuration +xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; +xsi:schemaLocation=&quot;http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd&quot; +xmlns=&quot;http://www.exoplaform.org/xml/ns/kernel_1_2.xsd&quot;&gt; &lt;import&gt;${db.configuration.path}/db.xml&lt;/import&gt; &lt;import&gt;${java.io.tmpdir}/bindfile.xml&lt;/import&gt; &lt;import&gt;simple.xml&lt;/import&gt; &lt;/configuration&gt;</programlisting> - <para> - The variables that are supported, are System properties and variables that are specific to your portal container, see next sections for more details. - </para> - - </note> - - </section> - - + <para> + The variables that are supported, are System properties and variables that are specific to your portal container, see next sections for more details. + </para> + </note> + </section> </section> - - Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -1,21 +1,19 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Foundations"> - <title>Foundations</title> - <xi:include href="Foundations/Kernel.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Config_Retrieval.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Advanced_Concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Profiles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Requests.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Configuring_Services.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Specific_Services.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Configuring_Containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/System_Properties.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Extensions_And_Multiple_Portals.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - + <title>The eXo Kernel</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Kernel.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Config_Retrieval.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Advanced_Concepts.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Profiles.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Requests.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Configuring_Services.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Specific_Services.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Configuring_Containers.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/System_Properties.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Extensions_And_Multiple_Portals.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Management.xml"/> </chapter> - Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -1,11 +1,9 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> <part id="part-Reference_Guide-Advanced_Development"> - <title>Advanced Development</title> - <xi:include href="Advanced/Foundations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - + <title>Advanced Development Foundations</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Advanced/Foundations.xml"/> </part> - Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -1,132 +1,45 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> - <part id="part-Reference_Guide-The_Java_Content_Repository_"> - <title>The Java Content Repository</title> - <!-- <xi:include href="eXoJCR/eXoJCR/jcr.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> - <xi:include href="eXoJCR/jcr/intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!--concepts --> - <!--<xi:include href="eXoJCR/jcr/concepts/why-jcr.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> - <xi:include href="eXoJCR/jcr/concepts/jcr-exo-implementation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!--<xi:include href="eXoJCR/jcr/concepts/jcr-advantages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - <!--<xi:include href="eXoJCR/jcr/concepts/jcr-compatibility-levels.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - <!--<xi:include href="eXoJCR/jcr/concepts/jcr-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - <!-- <xi:include href="eXoJCR/jcr/concepts/jcr-extensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> - <!--<xi:include href="eXoJCR/jcr/concepts/jcr-applications.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - <!--<xi:include href="eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - <!--<xi:include href="eXoJCR/jcr/concepts/nodetype-registration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - <!-- <xi:include href="eXoJCR/jcr/concepts/jcr-registry-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - <!--<xi:include href="eXoJCR/jcr/concepts/jcr-namespace-altering.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - - <!-- common configs --> - <xi:include href="eXoJCR/jcr/configuration/exo-jcr-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/configuration/multilanguage-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/configuration/search-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <!-- <xi:include href="eXoJCR/jcr/configuration/configuration-persister.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - - <xi:include href="eXoJCR/jcr/configuration/jdbc-data-container-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/configuration/external-value-storages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/configuration/workspace-persistence-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/configuration/rest-services-on-groovy.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - <!-- cluster configs --> - <xi:include href="eXoJCR/jcr/cluster-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/jbosscache-configuration-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/lock-manager-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/query-handler-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/jbossts-transaction-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/transaction-manager-lookup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/repository-creation-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - - <!-- search --> - <xi:include href="eXoJCR/jcr/searching/jcr-query-usecases.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/searching/searching-repository-content.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/searching/fulltext-search-and-settings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - - <!-- api extensions --> - <!--<xi:include href="eXoJCR/jcr/api-extensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - - - - <!-- protocols --> - <xi:include href="eXoJCR/jcr/protocols/webdav.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/protocols/ftp.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - - <!-- backup --> - <xi:include href="eXoJCR/jcr/backup/exojcr-backup-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/backup/backup-client.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/backup/use-external-backup-tool.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - <!-- other --> - <xi:include href="eXoJCR/jcr/statistics.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/repository-check-controller.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <!--<xi:include href="eXoJCR/jcr/jta.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - - <!--<xi:include href="eXoJCR/jcr/jca.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - - <!--<xi:include href="eXoJCR/jcr/other/acl.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - - <!--<xi:include href="eXoJCR/jcr/other/acl-ext.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - - <xi:include href="eXoJCR/jcr/other/link-producer.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <!--<xi:include href="eXoJCR/jcr/other/binary-values-processing.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - - <xi:include href="eXoJCR/jcr/other/jcr-resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - <!-- data container configs --> - <xi:include href="eXoJCR/jcr/data-container.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- <xi:include href="eXoJCR/jcr/data-container-howto.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> - <xi:include href="eXoJCR/jcr/db-cleaner-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - <!-- tuning guide - DOC NOTE: Could possibly be moved to a specific Tuning Guide later --> - <xi:include href="eXoJCR/jcr/performance-tuning-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - <!-- JCR Core +<part id="part-Reference_Guide-The_Java_Content_Repository_"> + <title>The Java Content Repository (JCR)</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/intro.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/concepts/jcr-exo-implementation.xml"/> +<!--<xi:include href="eXoJCR/jcr/concepts/jcr-advantages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/concepts/jcr-compatibility-levels.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/concepts/jcr-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!-- <xi:include href="eXoJCR/jcr/concepts/jcr-extensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --><!--<xi:include href="eXoJCR/jcr/concepts/jcr-applications.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/concepts/nodetype-registration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!-- <xi:include href="eXoJCR/jcr/concepts/jcr-registry-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/concepts/jcr-namespace-altering.xml! " xmlns:xi="http://www.w3.org/2001/XInclude" />--><!-- common configs --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/exo-jcr-configuration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/multilanguage-support.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/search-configuration.xml"/> +<!-- <xi:include href="eXoJCR/jcr/configuration/configuration-persister.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/jdbc-data-container-config.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/external-value-storages.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/workspace-persistence-storage.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/rest-services-on-groovy.xml"/> +<!-- cluster configs --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/cluster-config.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/jbosscache-configuration-templates.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/lock-manager-config.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/query-handler-config.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/jbossts-transaction-service.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/transaction-manager-lookup.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/repository-creation-service.xml"/> +<!-- search --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/searching/jcr-query-usecases.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/searching/searching-repository-content.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/searching/fulltext-search-and-settings.xml"/> +<!-- api extensions --><!--<xi:include href="eXoJCR/jcr/api-extensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!-- protocols --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/protocols/webdav.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/protocols/ftp.xml"/> +<!-- backup --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/exojcr-backup-service.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/backup-client.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/use-external-backup-tool.xml"/> +<!-- other --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/statistics.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/repository-check-controller.xml"/> +<!--<xi:include href="eXoJCR/jcr/jta.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/jca.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/other/acl.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/other/acl-ext.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/other/link-producer.xml"/> +<!--<xi:include href="eXoJCR/jcr/other/binary-values-processing.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/other/jcr-resources.xml"/> +<!-- data container configs --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/data-container.xml"/> +<!-- <xi:include href="eXoJCR/jcr/data-container-howto.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/db-cleaner-service.xml"/> +<!-- tuning guide + DOC NOTE: Could possibly be moved to a specific Tuning Guide later --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/performance-tuning-guide.xml"/> +<!-- JCR Core DOC NOTE: This section seems to include items covered elsewhere in this guide, or things that are not relevant to EPP - <xi:include href="eXoJCR/core.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> - - - <!-- Web services + <xi:include href="eXoJCR/core.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --><!-- Web services DOC NOTE: Red Hat JBoss has two possible Web Services packages. No need to document the eXo offering: - <xi:include href="eXoJCR/ws.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> - - - <!-- GateIn and JCR --> - <xi:include href="eXoJCR/jcr-with-gatein.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- DOC NOTE: Commented FAQ section out as per advice from Philippe Aristote; "Unfit for publication" --> - <!-- <xi:include href="eXoJCR/faq.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> - </part> \ No newline at end of file + <xi:include href="eXoJCR/ws.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --><!-- GateIn and JCR --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr-with-gatein.xml"/> +<!-- DOC NOTE: Commented FAQ section out as per advice from Philippe Aristote; "Unfit for publication" --><!-- <xi:include href="eXoJCR/faq.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --></part>