5:28 a.m.
Author: galder.zamarreno(a)jboss.com
Date: 2009-08-07 06:28:08 -0400 (Fri, 07 Aug 2009)
New Revision: 8166
Modified:
core/trunk/README-Maven.txt
core/trunk/src/main/docbook/userguide/en/modules/deployment.xml
Log:
[JBCACHE-1521] (Docu: Remove AS integration sections and point to AS Clustering Guide) AS
integration sections now point to Clustering guide sections and added a note about an
issue with OpenJDK 6 and documentation generation.
Modified: core/trunk/README-Maven.txt
===================================================================
--- core/trunk/README-Maven.txt 2009-08-07 10:03:27 UTC (rev 8165)
+++ core/trunk/README-Maven.txt 2009-08-07 10:28:08 UTC (rev 8166)
@@ -27,6 +27,17 @@
* mvn package -P Docs: Packages the module as a JAR file, and builds the javadocs and
user documentation from docbook sources.
+Important! Please note that if you try to generate user documentation using OpenJDK (at
least build 14.0-b15) you might see an
+exception like this:
+ java.lang.NullPointerException
+ at org.apache.fop.render.pdf.FopPDFImage.setup(FopPDFImage.java:144)
+ at org.apache.fop.pdf.PDFDocument.addImage(PDFDocument.java:794)
+ at org.apache.fop.render.pdf.PDFRenderer.putImage(PDFRenderer.java:1725)
+ at org.apache.fop.render.pdf.PDFRenderer.renderImage(PDFRenderer.java:1652)
+ ...
+This appears to be a known issue: https://lists.launchpad.net/openjdk/msg00820.html. To
get around the issue, simply switch
+to Sun JDK 5 or 6 to generate documentation.
+
* mvn install: will install the artifacts in your local repo for use by other projects
(such as JBoss Cache POJO edition
which depends on JBoss Cache Core). Will also use Maven's assembly plugin to build
ZIP files for download
(in target/distribution)
Modified: core/trunk/src/main/docbook/userguide/en/modules/deployment.xml
===================================================================
--- core/trunk/src/main/docbook/userguide/en/modules/deployment.xml 2009-08-07 10:03:27
UTC (rev 8165)
+++ core/trunk/src/main/docbook/userguide/en/modules/deployment.xml 2009-08-07 10:28:08
UTC (rev 8166)
@@ -37,130 +37,26 @@
</section>
<section id="deployment.microcontainer">
<title>Via JBoss Microcontainer (JBoss AS 5.x)</title>
-
- <para>
- Beginning with AS 5, JBoss AS supports deployment of POJO services via
- deployment of a file whose name ends with
- <literal>-jboss-beans.xml</literal>.
- A POJO service is one whose implementation is via a "Plain Old Java
Object",
- meaning a simple java bean that isn't required to implement any special
- interfaces or extend any particular superclass. A
- <literal>Cache</literal> is a POJO service, and all the components
in a
- <literal>Configuration</literal>
- are also POJOs, so deploying a cache in this way is a natural step.
- </para>
- <para>
- Deployment of the cache is done using the JBoss Microcontainer that forms the
- core of JBoss AS. JBoss Microcontainer is a sophisticated IOC framework
- similar to Spring. A <literal>-jboss-beans.xml</literal> file is
basically
- a descriptor that tells the IOC framework how to assemble the various
- beans that make up a POJO service.
- </para>
- <para>
- For each configurable option exposed by the
<literal>Configuration</literal>
- components, a getter/setter must be defined in the configuration class.
- This is required so that JBoss Microcontainer can, in typical IOC way,
- call these methods when the corresponding properties have been
- configured.
- </para>
- <para>
- You need to ensure that the <literal>jbosscache-core.jar</literal>
and <literal>jgroups.jar</literal> libraries
- are in your server's <literal>lib</literal> directory. This is
usually the case when you use JBoss AS in its
- <literal>all</literal> configuration. Note that you will have to
bring in any optional jars you require, such
- as <literal>jdbm.jar</literal> based on your cache configuration.
- </para>
- <para>
- The following is an example
- <literal>-jboss-beans.xml</literal>
- file. If you
- look in the
- <literal>server/all/deploy</literal>
- directory of a JBoss AS 5
- installation, you can find several more examples.
- </para>
-
- <programlisting role="XML"><![CDATA[
-<?xml version="1.0" encoding="UTF-8"?>
-
-<deployment xmlns="urn:jboss:bean-deployer:2.0">
-
- <!-- First we create a Configuration object for the cache -->
- <bean name="ExampleCacheConfig"
- class="org.jboss.cache.config.Configuration">
- <!-- Externally injected services -->
- <property name="runtimeConfig">
- <bean class="org.jboss.cache.config.RuntimeConfig">
- <property name="transactionManager">
- <inject bean="jboss:service=TransactionManager"
- property="TransactionManager"/>
- </property>
- <property name="muxChannelFactory"><inject
bean="JChannelFactory"/></property>
- </bean>
- </property>
-
- <property name="multiplexerStack">udp</property>
-
- <property name="clusterName">Example-EntityCache</property>
-
- <property name="isolationLevel">REPEATABLE_READ</property>
-
- <property name="cacheMode">REPL_SYNC</property>
-
- <property name="stateRetrievalTimeout">15000</property>
-
- <property name="syncReplTimeout">20000</property>
-
- <property name="lockAcquisitionTimeout">15000</property>
-
- <property name="exposeManagementStatistics">true</property>
- </bean>
-
- <!-- Factory to build the Cache. -->
- <bean name="DefaultCacheFactory"
class="org.jboss.cache.DefaultCacheFactory">
- <constructor factoryClass="org.jboss.cache.DefaultCacheFactory"
- factoryMethod="getInstance" />
- </bean>
-
- <!-- The cache itself -->
- <bean name="ExampleCache" class="org.jboss.cache.Cache">
-
- <constructor factoryMethod="createCache">
- <factory bean="DefaultCacheFactory"/>
- <parameter
class="org.jboss.cache.config.Configuration"><inject
bean="ExampleCacheConfig"/></parameter>
- <parameter class="boolean">false</parameter>
- </constructor>
-
- </bean>
-
-</deployment>
-]]></programlisting>
-
<para>
- See <ulink url="http://www.jboss.org/jbossmc/docs">the JBoss
Microcontainer documentation</ulink>
- for details on the above syntax. Basically, each
- <literal>bean</literal>
- element represents an object and is used to create a
- <literal>Configuration</literal>
- and its <link linkend="configuration.elements">constituent
parts</link>
- The <literal>DefaultCacheFactory</literal> bean constructs the
cache,
- conceptually doing the same thing as is shown in the
- <link linkend="api.create_start">User API</link> chapter.
- </para>
- <para>
- An interesting thing to note in the above example is the use of the
- <literal>RuntimeConfig</literal> object. External resources like a
<literal>TransactionManager</literal>
- and a JGroups <literal>ChannelFactory</literal> that are visible to
the microcontainer are dependency injected
- into the <literal>RuntimeConfig</literal>. The assumption here is
that in some other deployment descriptor in
- the AS, the referenced beans have already been described.
- </para>
+ For detailed information on how to deploy JBoss Cache instances this way,
+ please check section "11.2. Deploying Your Own JBoss Cache Instance"
and more
+ specifically, section "11.2.3. Deployment Via a -jboss-beans.xml File"
in the
+ <ulink
url="http://jboss.org/file-access/default/members/jbossclustering/fr...
+ JBoss Application Server 5 Clustering Guide</ulink>.
+ </para>
+
</section>
<section>
<title>Automatic binding to JNDI in JBoss AS</title>
<para>
- This feature is not available as of the time of this writing. We will
- add a wiki page describing how to use it once it becomes available.
+ Although access to cache instances bound to JNDI is not possible, JBoss
Application
+ Server 5 binds a CacheManager to JNDI which can be looked up and from where
cache
+ instances can be retrieved. Further detailed information can be found in section
+ "11.2.1. Deployment Via the CacheManager Service" in the
+ <ulink
url="http://jboss.org/file-access/default/members/jbossclustering/fr...
+ JBoss Application Server 5 Clustering Guide</ulink>.
</para>
</section>