User: juhalindfors
Date: 01/04/02 09:39:39
Modified: src/docs jbossdocs.xml
Added: src/docs howtoverifier.xml
Log:
Quick hack at documenting the use of verifier in Ant. (incomplete)
Revision Changes Path
1.12 +2 -0 manual/src/docs/jbossdocs.xml
Index: jbossdocs.xml
===================================================================
RCS file: /cvsroot/jboss/manual/src/docs/jbossdocs.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- jbossdocs.xml 2001/04/02 03:25:40 1.11
+++ jbossdocs.xml 2001/04/02 16:39:38 1.12
@@ -25,6 +25,7 @@
<!ENTITY howtojpda.xml SYSTEM "howtojpda.xml">
<!ENTITY howtomssql.xml SYSTEM "howtomssql.xml">
<!ENTITY howtojetty.xml SYSTEM "howtojetty.xml">
+ <!ENTITY howtoverifier.xml SYSTEM "howtoverifier.xml">
<!ENTITY howtombeans.xml SYSTEM "howtombeans.xml">
<!ENTITY jbosssx.xml SYSTEM "jbosssx.xml">
]>
@@ -65,6 +66,7 @@
&howtojndi_external.xml;
&howto_socketfactories.xml;
&howtojaxp.xml;
+&howtoverifier.xml;
</chapter>
</book>
1.1 manual/src/docs/howtoverifier.xml
Index: howtoverifier.xml
===================================================================
<?xml version = "1.0" encoding = "UTF-8"?>
<!-- brief howto for using the ejb verifier with ant -->
<section>
<title>Using Verifier in Ant</title>
<para>
When deploying the Enterprise JavaBeans, JBoss attempts to verify
each bean against the specification to make sure the
<emphasis>Bean Developer</emphasis> has fulfilled her contract to
implement all the required interfaces. The verifier goes through both
session and entity beans making sure the method descriptors do not
violate the specification, RMI/IIOP requirements are met, the relevant
parts of the deployment descriptor are correct, and so forth.
</para>
<para>
It is also possible to use the verifier as part of your build process.
Using Ant to build your project enables you to verify your Enterprise
JavaBeans as you compile them. This removes the extra step of deploying
just to verify your <emphasis>ejb-jar</emphasis> file is compliant and
deploys correctly in the container. In case of spec violations, you can
optionally stop the build process and rework your files to meet the
specification requirements. This Howto explains the setup you need to
verify your beans early rather than late.
</para>
<section>
<title>Getting the required files</title>
<para>
To use the verifier in Ant you will need two jars copied from the
JBoss distribution to your build directory:
<filename>verifier.jar</filename> and <filename>metadata.jar</filename>.
You will find the <filename>verifier.jar</filename> file in the
<filename>/dist/bin</filename> directory of your JBoss installation,
and the <filename>metadata.jar</filename> in the
<filename>/dist/external</filename> directory.
</para>
<para>
If you are using the CVS version of JBoss, you can build both of the
above mentioned files by executing
</para>
<para>
<prompt>src/build></prompt> <command>build verifier</command>
</para>
<para>
in the <filename>/src/build</filename> directory. This will generate
the required packages to the correct directories.
</para>
</section>
<section>
<title>Edit build.xml</title>
<para>
A custom verifier task for Ant does not exist at the moment but you can
execute the verifier from Ant by creating a new JVM for it using Ant's
built in <literal><java></literal> task. For the most up to date
information of using the <literal><java></literal> tag, see
<ulink url="http://jakarta.apache.org/ant/manual/CoreTasks/java.html">
Ant online documentation</ulink>.
</para>
<para>
Below is an example of using the <literal><java></literal> tag to
execute the verifier:
<programlisting>
<!-- verify the EJBs -->
<java classname = "org.jboss.verifier.Main" fork="true">
<classpath refid = "classpath"/>
<arg value = "${dist.home}/admin.jar"/>
</java>
</programlisting>
</para>
<para> To be continued... </para>
</section>
<section>
<title>Troubleshooting</title>
<para> How to deal with the most common verifier warnings </para>
</section>
</section>
_______________________________________________
Jboss-development mailing list
[EMAIL PROTECTED]
http://lists.sourceforge.net/lists/listinfo/jboss-development