[jboss-cvs] JBossAS SVN: r63042 - in projects/aop/trunk/aop/docs/reference/reference/en: modules and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Tue May 15 06:23:26 EDT 2007
Author: kabir.khan at jboss.com
Date: 2007-05-15 06:23:26 -0400 (Tue, 15 May 2007)
New Revision: 63042
Modified:
projects/aop/trunk/aop/docs/reference/reference/en/images/install.jpg
projects/aop/trunk/aop/docs/reference/reference/en/modules/installing.xml
projects/aop/trunk/aop/docs/reference/reference/en/modules/running.xml
Log:
[JBAOP-397] Update reference doc to reflect the new packaging
Modified: projects/aop/trunk/aop/docs/reference/reference/en/images/install.jpg
===================================================================
(Binary files differ)
Modified: projects/aop/trunk/aop/docs/reference/reference/en/modules/installing.xml
===================================================================
--- projects/aop/trunk/aop/docs/reference/reference/en/modules/installing.xml 2007-05-15 05:28:22 UTC (rev 63041)
+++ projects/aop/trunk/aop/docs/reference/reference/en/modules/installing.xml 2007-05-15 10:23:26 UTC (rev 63042)
@@ -3,7 +3,7 @@
<title>Installing</title>
<para>
- This section defines how to install JBoss AOP standalone, within JBoss 4.0 and within JBoss 3.2.6
+ This section defines how to install JBoss AOP standalone, within JBoss 4.0.x, JBoss 4.2.x and within JBoss 5.x
</para>
<mediaobject>
@@ -21,68 +21,87 @@
<para>
There's nothing really to install if you're running outside the JBoss application server. If you are using
- JDK 1.4.x, use the libraries under the
- <literal>lib/</literal> directory to build your JBoss AOP applications.
- If you're using JDK 5.0, use the libraries under
- <literal>lib-50/</literal>.
+ JDK 1.4.x, use the libraries under the <literal>lib-14/</literal> directory to build your JBoss AOP applications.
+ If you're using JDK 5.0, use the libraries under <literal>lib-50/</literal>.
</para>
</sect1>
- <sect1 id="installing-jboss40" revision="1">
- <title>Installing with JBoss 4.x Application Server</title>
+ <sect1 id="installing-jboss40-jdk50" revision="1">
+ <title>Installing with JBoss 4.0.x amd JBoss 4.2.x Application Server for JDK 5</title>
<para>
- To install JBoss AOP in JBoss 4.x Application Server:
+ To install JBoss AOP in JBoss 4.0.x or JBoss 4.2.x Application Server: with JDK 5, there is an ant build script to
+ install into the application server. It lives in <literal>jboss-40-install/jboss-aop-jdk50.deployer/build.xml</literal>.
+ Modify <literal>jboss-40-install/jboss-aop-jdk50.deployer/jboss.properties</literal> to point to the the root of your
+ JBoss installation and specify the application server configuration you want to upgrade. These are the steps taken by
+ the ant script:
</para>
<orderedlist spacing="compact">
<listitem>
- Delete
- <literal>jboss-aop.deployer</literal> file or directory from the existing JBoss Application Server distribution
- under
- <literal><![CDATA[server/<config-name>/deploy]]></literal>
+ Back up the existing <literal>jboss-40-install/jboss-aop-jdk50.deployer</literal> to
+ <literal><![CDATA[server/<config-name>/deploy/jboss-aop-jdk50.deployer.bak]]></literal>
</listitem>
<listitem>
- From the JBoss AOP distribution, from the
- <literal>jboss-40-install</literal> directory copy
- <literal>jboss-aop.deployer/</literal>
- or
- <literal>jboss-aop-jdk50.deployer</literal> to the JBoss Application Server distribution
- under
- <literal><![CDATA[server/<config-name>/deploy]]></literal> depending on which JDK you are running with.
+ Copy the files from <literal>jboss-40-install/jboss-aop-jdk50.deployer</literal> over the files that already
+ exist in your existing JBoss Application Server distribution under
+ <literal><![CDATA[server/<config-name>/deploy/jboss-aop-jdk50.deployer]]></literal>
</listitem>
+ <listitem>
+ In JBoss 4.0.4.GA and later, move <literal><![CDATA[server/<config-name>/deploy/jboss-aop-jdk50.deployer/javassist.jar]]></literal>
+ to <literal><![CDATA[server/<config-name>/lib/javassist.jar]]></literal>.
+ </listitem>
+ <listitem>
+ If you NOT upgrading from a previous AOP 2 distribution, open up
+ <literal><![CDATA[server/<config-name>/deploy/jboss-aop-jdk50.deployer/jboss-aspect-library-jdk50.jar]]></literal> and
+ delete all classes and subpackages under <literal>org.jboss.aop</literal>. (In AOP 2.0 we changed the packaging, these
+ classes now exist inside <![CDATA[server/<config-name>/deploy/jboss-aop-jdk50.deployer/jboss-aop-as4-deployer.jar]]>
+ </listitem>
</orderedlist>
-
</sect1>
- <sect1 id="installing-jboss32" revision="1">
- <title>Installing with JBoss 3.2.6 Application Server</title>
+ <sect1 id="installing-jboss40-jdk14" revision="1">
+ <title>Installing with JBoss 4.0.x Application Server for JDK 1.4</title>
<para>
- JBoss AOP only works with JBoss Application Server 3.2.6RC1+ and only with the precompiler. Load-time AOP is not supported
- at this time for JBoss 3.2.x application server. To install JBoss AOP to JBoss Application Server, copy all jars in the
- <literal>jboss-32-install/</literal> or <literal>jboss-32-install-jdk5</literal> directory to the
- <literal><![CDATA[server/<config-name>/lib]]></literal> depending on what version of the JDK you use.
+ To install JBoss AOP in JBoss 4.0.x with JDK 1.4 (JBoss 4.2.x requires JDK 5), there is an ant build script to
+ install into the application server. It lives in <literal>jboss-40-install/jboss-aop-jdk14.deployer/build.xml</literal>.
+ Modify <literal>jboss-40-install/jboss-aop-jdk14.deployer/jboss.properties</literal> to point to the the root of your
+ JBoss installation and specify the application server configuration you want to upgrade. These are the steps taken by
+ the ant script:
</para>
<orderedlist spacing="compact">
<listitem>
- copy all jars in the
- <literal>jboss-32-install/</literal> or <literal>jboss-32-install-jdk5</literal> directory to the
- <literal><![CDATA[server/<config-name>/lib]]></literal>
+ Back up the existing <literal>jboss-40-install/jboss-aop.deployer</literal> (if upgrading from AOP 1.x)
+ or <literal>jboss-40-install/jboss-aop-jdk14.deployer</literal> (if upgrading from AOP 2.x) to
+ <literal><![CDATA[server/<config-name>/deploy/jboss-aop.deployer.bak]]></literal>
</listitem>
<listitem>
- Copy
- <literal>etc/base-aop.xml</literal> to the JBoss Application Server distribution
- under
- <literal><![CDATA[server/<config-name>/deploy]]></literal>.
+ Copy the files from <literal>jboss-40-install/jboss-aop-jdk14.deployer</literal> to
+ <literal><![CDATA[server/<config-name>/deploy/jboss-aop-jdk50.deployer]]></literal>
</listitem>
<listitem>
- Edit
- <literal><![CDATA[server/<config-name>/conf/jboss-service.xml]]></literal> to add the appropriate
- configuration defined in section 10.2 "JBoss Application Server".
+ In JBoss 4.0.4.GA and later, move <literal><![CDATA[server/<config-name>/deploy/jboss-aop-jdk50.deployer/javassist.jar]]></literal>
+ to <literal><![CDATA[server/<config-name>/lib/javassist.jar]]></literal>
</listitem>
+ <listitem>
+ If you NOT upgrading from a previous AOP 2 distribution, copy the
+ <literal><![CDATA[server/<config-name>/deploy/jboss-aop.deployer.bak/jboss-aspect-library.jar]]></literal> to
+ <literal><![CDATA[server/<config-name>/deploy/jboss-aop-jdk14.deployer/jboss-aspect-library.jar]]></literal> and
+ delete all classes and subpackages under <literal>org.jboss.aop</literal>. (In AOP 2.0 we changed the packaging, these
+ classes now exist inside <literal><![CDATA[server/<config-name>/deploy/jboss-aop-jdk14.deployer/jboss-aop-as4-deployer.jar]]></literal>. The
+ script also makes the jdk 1.4 annotations compatible with how they are simulated in JBoss AOP 2.x.
+ </listitem>
</orderedlist>
+ </sect1>
+ <sect1 id="installing-jboss5-jdk5" revision="1">
+ <title>Installing with JBoss Application Server 5</title>
+ <para>
+ JBoss 5 is not released yet, this section will be modified when the packaging is finalised, but all you should need to do is
+ copy the contents of the <literal>jboss-50-install/lib</literal> directory into
+ <literal>$JBOSS_ROOT/lib</literal>, and copy the contents of the <literal>jboss-50-install/jboss-aop-jboss5.deployer</literal>
+ folder into <literal><![CDATA[$JBOSS_ROOT/server/<config-name>/deployers/jboss-aop-jboss5.deployer]]></literal>
+ </para>
</sect1>
-
</chapter>
Modified: projects/aop/trunk/aop/docs/reference/reference/en/modules/running.xml
===================================================================
--- projects/aop/trunk/aop/docs/reference/reference/en/modules/running.xml 2007-05-15 05:28:22 UTC (rev 63041)
+++ projects/aop/trunk/aop/docs/reference/reference/en/modules/running.xml 2007-05-15 10:23:26 UTC (rev 63042)
@@ -582,7 +582,7 @@
</para>
<para>
Next, you need to copy
- the jdk14-pluggable-instrumentor.jar from the lib/ directory of your JBoss AOP
+ the jdk14-pluggable-instrumentor.jar from the lib-14/ directory of your JBoss AOP
distribution to the bin/ directory of your JBoss application server installation. Next edit
run.sh or run.bat (depending on what OS you're on) and add the following to the JAVA_OPTS environment
variable
@@ -656,7 +656,7 @@
needed because sometimes a JBoss deployment will not have all the classes a class references.
</para>
<para>
- The next step is to copy the pluggable-instrumentor.jar from the lib-50 directory of your JBoss AOP
+ The next step is to copy the pluggable-instrumentor.jar from the lib-50/ directory of your JBoss AOP
distribution to the bin/ directory of your JBoss AOP application server installation. Next edit
run.sh or run.bat (depending on what OS you're on) and add the following to the JAVA_OPTS environment
variable
@@ -718,7 +718,7 @@
needed because sometimes a JBoss deployment will not have all the classes a class references.
</para>
<para>
- The next step is to copy the jrockit-pluggable-instrumentor.jar from the lib directory of your JBoss AOP
+ The next step is to copy the jrockit-pluggable-instrumentor.jar from the lib-50/ directory of your JBoss AOP
distribution to the bin/ directory of your JBoss AOP application server installation. Next edit
run.sh or run.bat (depending on what OS you're on) and add the following to the JAVA_OPTS and
JBOSS_CLASSPATH environment variables
@@ -740,155 +740,7 @@
<!-- 4.0 and jrockit - end -->
- <!-- 3.2.4 -->
- <sect2 id="jboss325" revision="1">
- <title>JBoss Application Server 3.2.x and JDK 1.4</title>
- <para>
- JBoss AOP can also work with JBoss 3.2.7 (maybe 3.2.6) and higher in the JBoss 3.2 series. Look in the
- Installing chapter on how to install the JAR files.
- </para>
- <para>
- After installing, you need to modify the
- <literal>jboss-3.2.7/server/xxx/conf/jboss-service.xml</literal>
- file to add these mbean definitions. They are similar to the 4.0 release, but notice the '32' added to the
- class name.
- </para>
- <programlisting>
- <![CDATA[ <mbean code="org.jboss.aop.deployment.AspectManagerService32"
- name="jboss.aop:service=AspectManager">
- <attribute name="EnableLoadtimeWeaving">false</attribute>
- <!-- only relevant when EnableLoadtimeWeaving is true -->
- <attribute name="SuppressTransformationErrors">true</attribute>
- <attribute name="Prune">true</attribute>
- <attribute name="Include">org.jboss.test</attribute>
- <attribute name="Exclude">org.jboss.</attribute>
- <attribute name="Optimized">true</attribute>
- <attribute name="Verbose">false</attribute>
- </mbean>
-
- <mbean code="org.jboss.aop.deployment.AspectDeployer32"
- name="jboss.aop:service=AspectDeployer">
- </mbean>
- ]]></programlisting>
- <para>
- Also, copy the
- <literal>base-aop.xml</literal> file into the server/xxx/deploy/ directory if you want to
- use any of JBoss Aspects.
- </para>
- <para>
- Follow the same steps to enable loadtime weaving as those for JDK 1.4 and JBoss 4.x.
- </para>
- </sect2>
-
<sect2>
- <title>JBoss 3.2.x and JDK 5</title>
- <para>
- You can use the JDK 5 -javaagent stuff if you like with JBoss 3.2.x.
- </para>
- <para>
- To use JDK 5 loadtime with JBoss 3.2.x make sure you follow the directions in the 'Installing' chapter.
- </para>
- <para>
- If you want to do load-time
- transformations with JBoss 3.2.7 and JDK 5, there are two steps you must take.
- </para>
- <para>
- After installing, you need to modify the
- <literal>jboss-3.2.7/server/xxx/conf/jboss-service.xml</literal>
- file to add these mbean definitions. They are similar to the 4.0 release, but notice the '32' added to the
- class name.
- </para>
- <programlisting>
- <![CDATA[ <mbean code="org.jboss.aop.deployment.AspectManagerService32JDK5"
- name="jboss.aop:service=AspectManager">
- <attribute name="EnableLoadtimeWeaving">false</attribute>
- <!-- only relevant when EnableLoadtimeWeaving is true -->
- <attribute name="SuppressTransformationErrors">true</attribute>
- <attribute name="Prune">true</attribute>
- <attribute name="Include">org.jboss.test</attribute>
- <attribute name="Exclude">org.jboss.</attribute>
- <attribute name="Optimized">true</attribute>
- <attribute name="Verbose">false</attribute>
- </mbean>
-
- <mbean code="org.jboss.aop.deployment.AspectDeployer32"
- name="jboss.aop:service=AspectDeployer">
- </mbean>
- ]]></programlisting>
- <para>
- Also, copy the
- <literal>base-aop.xml</literal> file into the server/xxx/deploy/ directory if you want to
- use any of JBoss Aspects.
- </para>
- <para>
- By default, JBoss application server will not do load-time bytecode manipulation
- of AOP files. You can turn load-time weaving the same way you do for JBoss 4.
- </para>
- <para>
- The next step is to copy the pluggable-instrumentor.jar from the lib-50 directory of your JBoss AOP
- distribution to the bin/ directory of your JBoss AOP application server installation. Next edit
- run.sh or run.bat (depending on what OS you're on) and add the following to the JAVA_OPTS environment
- variable
- </para>
- <programlisting>
-set JAVA_OPTS=%JAVA_OPTS% -Dprogram.name=%PROGNAME% -javaagent:pluggable-instrumentor.jar
- </programlisting>
- <para>
- After modifying JAVA_OPTS and setting the EnableLoadtimeWeaving to true, then you should be ready to go.
- </para>
- </sect2>
-
- <sect2>
- <title>JBoss 3.2.x and JRockit</title>
- <para>
- You can use the JRockit classloader integration if you like with JBoss 3.2.x. If you are using JRockit 1.4.2
- this is the only way to achieve loadtime transformations.
- </para>
- <para>
- If you want to do load-time
- transformations with JBoss 3.2.7 and JRockit, there are two steps you must take.
- </para>
- <para>
- After installing, you need to modify the
- <literal>jboss-3.2.7/server/xxx/conf/jboss-service.xml</literal>
- file to add these mbean definitions. They are similar to the 4.0 release, but notice the '32' added to the
- class name. Note that the <literal>code</literal> attribute of the AspectManager mbean must be
- <literal>org.jboss.aop.deployment.AspectManagerService</literal>
- as that is what works with the JRockit special hooks.
- </para>
- <programlisting>
- <![CDATA[ <mbean code="org.jboss.aop.deployment.AspectManagerService32"
- name="jboss.aop:service=AspectManager">
- <attribute name="EnableLoadtimeWeaving">false</attribute>
- <!-- only relevant when EnableLoadtimeWeaving is true -->
- <attribute name="SuppressTransformationErrors">true</attribute>
- <attribute name="Prune">true</attribute>
- <attribute name="Include">org.jboss.test</attribute>
- <attribute name="Exclude">org.jboss.</attribute>
- <attribute name="Optimized">true</attribute>
- <attribute name="Verbose">false</attribute>
- </mbean>
-
- <mbean code="org.jboss.aop.deployment.AspectDeployer32"
- name="jboss.aop:service=AspectDeployer">
- </mbean>
- ]]></programlisting>
- <para>
- Also, copy the
- <literal>base-aop.xml</literal> file into the server/xxx/deploy/ directory if you want to
- use any of JBoss Aspects.
- </para>
- <para>
- By default, JBoss application server will not do load-time bytecode manipulation
- of AOP files. You can turn load-time on weaving the same way you do for JBoss 4.
- </para>
- <para>
- The next step is to copy the jrockit-pluggable-instrumentor.jar from the lib directory of your JBoss AOP
- distribution to the bin/ directory of your JBoss AOP application server installation and to modify your run.sh/bat file
- as mentioned in "JBoss 4.x and JRockit".
- </para>
- </sect2>
- <sect2>
<title>Improving Loadtime Performance in a JBoss AS Environment</title>
<para>
The same rules apply to JBoss AS for tuning loadtime weaving performance as standalone Java. See the previous chapter on
More information about the jboss-cvs-commits
mailing list