[jboss-cvs] JBossAS SVN: r104039 - projects/docs/enterprise/5.0/CXF_User_Guide/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Fri Apr 16 02:39:02 EDT 2010
Author: laubai
Date: 2010-04-16 02:39:02 -0400 (Fri, 16 Apr 2010)
New Revision: 104039
Modified:
projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Author_Group.xml
projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Five_WXF_Addressing_Config.xml
projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Four_WS_Addressing.xml
projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_One_Introduction.xml
projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Three_CXF_Integration.xml
projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Two_Installation.xml
projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Feedback.xml
projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Revision_History.xml
Log:
Added EDIT tags to assist rnewton in her editing work.
Modified: projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Author_Group.xml
===================================================================
--- projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Author_Group.xml 2010-04-16 06:36:02 UTC (rev 104038)
+++ projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Author_Group.xml 2010-04-16 06:39:02 UTC (rev 104039)
@@ -7,7 +7,7 @@
<author>
<firstname>Red Hat Documentation Group</firstname>
<affiliation>
- <orgname>Red Hat, Asia Pacific </orgname>
+ <orgname>Red Hat, Asia Pacific</orgname>
</affiliation>
<email>rnewton at redhat.com</email>
</author>
Modified: projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Five_WXF_Addressing_Config.xml
===================================================================
--- projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Five_WXF_Addressing_Config.xml 2010-04-16 06:36:02 UTC (rev 104038)
+++ projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Five_WXF_Addressing_Config.xml 2010-04-16 06:39:02 UTC (rev 104039)
@@ -6,7 +6,10 @@
<chapter>
<title> Addressing Configuration </title>
<para>Two things are necessary in order to use WS-Addressing in a message exchange:
-
+ <!--EDIT: Bec, try to close para tags as you come to the end of them - this one should
+ be closed before you use the orderedlist. :) You don't need to nest lists within para
+ tags - it works, but it's not good form, and with the direction recent publican updates
+ are taking, it might cause you other problems later.-->
<orderedlist>
<listitem>
<para>
@@ -15,7 +18,7 @@
</listitem>
<listitem>
<para>
- WS-Addressing is being used if any of the following elements have a <classname>UsingAddress xmlns="http://www.w3.org/2005/02/addressing/wsdl"</classname> element:
+ WS-Addressing is being used if any of the following elements have a <classname>UsingAddress xmlns="http://www.w3.org/2005/02/addressing/wsdl"</classname> element: <!--EDIT: You should probably add < and > to that element in the classname tag to make things clearer.-->
</para>
<orderedlist>
<listitem>
@@ -36,24 +39,25 @@
<section>
<title> Using the Addressing Feature </title>
<para>The addressing feature element is defined in <!--namespace http://cxf.apache.org/ws/addressing-->. It supports two attributes:
-
+ <!--EDIT: Same thing here: close the para before you open the list.-->
<variablelist>
<varlistentry>
<term> allowDuplicates </term>
- <listitem>
- <para> A boolean that determines if duplicate MessageIDs are tolerated (default: true).</para>
- </listitem>
+ <listitem>
+ <para> A boolean that determines if duplicate MessageIDs are tolerated (default: true).</para>
+ </listitem>
</varlistentry>
<varlistentry>
<term> usingAddressingAdvisory </term>
- <listitem>
- <para> A boolean that indicates if the presence of the <varname> UsingAddressing </varname>
- element in the wsdl is purely advisory, i.e. its absence doesn't prevent the encoding of
- WS-A headers. This is especially useful to enable WS-Addressing in the java-first case, where
- you have no <varname>wsdl</varname> and hence none of the conditons in 2.1 and 2.2 will be met.</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <listitem>
+ <para> A boolean that indicates if the presence of the <varname> UsingAddressing </varname>
+ element in the wsdl is purely advisory, i.e. its absence doesn't prevent the encoding of
+ WS-A headers. This is especially useful to enable WS-Addressing in the java-first case, where
+ you have no <varname>wsdl</varname> and hence none of the conditons in 2.1 and 2.2 will be met.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <!--EDIT: Remember to open another para here!-->
For example, to apply this feature to a JAX-WS server endpoint: </para>
<programlisting><![CDATA[ <beans ... xmlns:wsa="http://cxf.apache.org/ws/addressing" ...>
@@ -66,7 +70,10 @@
</section>
<section>
- <title> Adding the Addressing Interceptors Manually </title>
+ <title> Adding the Addressing Interceptors Manually </title>
+ <!--EDIT: Leave out the spaces between the contents of the tag and the tag itself.
+ Some of these - namely those spaces in classname tags below - will be rendered as
+ double-spaces in the built doc because the tags classify them as verbatim.-->
<para> <classname> org.apache.cxf.ws.addressing.MAPAggregator</classname> and
<classname> org.apache.cxf.ws.addressing.soap.MAPCodec </classname> must be added to the interceptor
chain for inbound and outbound messages and faults. On a global level, i.e. applicable to all client
@@ -74,6 +81,9 @@
that, as allowDuplicates and usingAddressingAdvisory are actually properties of the
MAPAggregator interceptor, they can also be set using Spring syntax.</para>
+ <!--EDIT: Try to avoid using i.e. or e.g. - spell it out. Have we linked you to the
+ word usage/style guides yet? Here: http://intranet.corp.redhat.com/ic/intranet/RedHatStyleGuide.html-->
+
<programlisting> <![CDATA[<bean id="mapAggregator" class="org.apache.cxf.ws.addressing.MAPAggregator">
<property name="allowDuplicates" value="false"/>
</bean>
Modified: projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Four_WS_Addressing.xml
===================================================================
--- projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Four_WS_Addressing.xml 2010-04-16 06:36:02 UTC (rev 104038)
+++ projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Four_WS_Addressing.xml 2010-04-16 06:39:02 UTC (rev 104039)
@@ -9,12 +9,52 @@
To enable WS-Addressing, enable the WSAddressingFeature on your service. If you wish to use XML to configure this, use the following syntax: </para>
+ <!--EDIT: You can probably neaten the appearance of this a little to make it easier
+ to read. I'll neaten the following commented-out text for you to give you the idea:
+
<programlisting><![CDATA[<jaxws:endpoint id="{your.service.namespace}YourPortName">
<jaxws:features>
<wsa:addressing xmlns:wsa="http://cxf.apache.org/ws/addressing"/>
</jaxws:features>
</jaxws:endpoint>]]>
</programlisting>
+
+ <para>
+ You can also use the same exact syntax with a <![CDATA[<jaxws:client><]]>:
+ </para>
+
+ <programlisting><![CDATA[<jaxws: client id="{your.service.namespace}YourPortName">
+ <jaxws:features>
+ <wsa:addressing xmlns:wsa="http://cxf.apache.org/ws/addressing"/>
+ </jaxws:features>
+ </jaxws:client>]]></programlisting>
+
+ <para>
+ From an API point of view this looks very similar:
+ </para>
+
+ <programlisting><![CDATA[import org.apache.cxf.jaxws.EndpointImpl;
+ import org.apache.cxf.ws.addressing.WSAddressingFeature;
+
+ MyServiceImpl implementor = new MyServiceImpl()
+ EndpointImpl ep = (EndpointImpl) Endpoint.create(implementor);
+ ep.getFeatures().add(new WSAddressingFeature());
+ ep.publish("http://some/address"); ]]></programlisting>
+
+ <para>
+ You can also use it with the ClientProxyFactoryBeans and ServerFactoryBeans (and their JAX-WS versions, namely JaxWsProxyFactoryBean and JaxWsServerFactoryBean):
+ </para>
+
+ ...and so on. It's much easier to scan a file for errors if all your nested tags are in line. :)
+ -->
+
+
+ <programlisting><![CDATA[<jaxws:endpoint id="{your.service.namespace}YourPortName">
+ <jaxws:features>
+ <wsa:addressing xmlns:wsa="http://cxf.apache.org/ws/addressing"/>
+ </jaxws:features>
+ </jaxws:endpoint>]]>
+ </programlisting>
<para>You can also use the same exact syntax with a <![CDATA[<jaxws:client><]]> </para>
<programlisting><![CDATA[ <jaxws: client id="{your.service.namespace}YourPortName">
<jaxws:features>
Modified: projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_One_Introduction.xml
===================================================================
--- projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_One_Introduction.xml 2010-04-16 06:36:02 UTC (rev 104038)
+++ projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_One_Introduction.xml 2010-04-16 06:39:02 UTC (rev 104039)
@@ -11,9 +11,14 @@
Apache CXF is an open source services framework. CXF helps you build and develop services using frontend programming APIs, like JAX-WS and JAX-RS. These services can speak a variety of protocols such as SOAP, XML/HTTP, RESTful HTTP, or CORBA and work over a variety of transports such as HTTP, JMS or JBI.
CXF includes a broad feature set, but it is primarily focused on the following areas:
+
+ <!--EDIT: itemizedlist does not need to be nested -->
<itemizedlist>
<listitem>
<para> Web Services Standards Support: CXF supports a variety of web service standards including SOAP, the WSI Basic Profile, WSDL, WS-Addressing, WS-Policy, WS-ReliableMessaging, WS-Security, WS-SecurityPolicy, and WS-SecureConversation.</para>
+ <!--EDIT: On future passes of this doc, remember to fully write out some of these acronyms,
+ at least the first time they are used, and generally whenever you think a user will have
+ forgotten what they are. -->
</listitem>
<listitem>
<para> Frontends: CXF supports a variety of "frontend" programming models. CXF implements the JAX-WS APIs (TCK compliant). It also includes a "simple frontend" which allows creation of clients and endpoints without annotations. CXF supports both contract first development with WSDL and code first development starting from Java. For REST, CXF also supports a JAX-RS (TCK compliant) frontend.</para>
Modified: projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Three_CXF_Integration.xml
===================================================================
--- projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Three_CXF_Integration.xml 2010-04-16 06:36:02 UTC (rev 104038)
+++ projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Three_CXF_Integration.xml 2010-04-16 06:39:02 UTC (rev 104039)
@@ -7,11 +7,14 @@
<chapter>
<title> Server Side Integration Customization </title>
+ <!--EDIT: The usuals: lists are block items, so they shouldn't be inside other block items, e.g. para.
+ Unnecessary spaces can cause weird things to happen when the docs build. -->
+
<para> It is possible to customize the JBossWS and CXF integration by incorporating the CXF configuration file to the endpoint deployment archive. The convention is the following:
<itemizedlist>
<listitem>
- <para> file name must be jbossws-cxf.xml </para>
+ <para> file name must be jbossws-cxf.xml <!--EDIT: Try to tag file names and directory paths with the <filename> tag. --></para>
</listitem>
<listitem>
<para> for POJO deployments it is located in WEB-INF directory </para>
@@ -79,7 +82,7 @@
Providing custom CXF configuration to the endpoint deployment is useful in cases when users want to use features that are not part of standard JAX-WS specification but CXF implements them. For example see <!-- CXF WS-RM tutorial customization file LINK TO THIS ONCE YOU HAVE MADE THE SECTION -->. We are providing custom CXF endpoint configuration there to turn on WS-RM feature for endpoint.
<note>
- <para> When user incorporates its own CXF configuration to the endpoint archive he must reference either org.jboss.wsf.stack.cxf.InvokerJSE or org.jboss.wsf.stack.cxf.InvokerEJB3 jaxws invoker bean there for each jaxws endpoint. </para>
+ <para> When user incorporates its own CXF configuration to the endpoint archive he must reference either org.jboss.wsf.stack.cxf.InvokerJSE or org.jboss.wsf.stack.cxf.InvokerEJB3 jaxws <!--EDIT: Two things - these two Invokers should be marked up with classname tags, and check how you've been referring to jaxws. All caps? Hyphenated? It's important to pick one and stick with it. :) --> invoker bean there for each jaxws endpoint. </para>
</note>
</para>
Modified: projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Two_Installation.xml
===================================================================
--- projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Two_Installation.xml 2010-04-16 06:36:02 UTC (rev 104038)
+++ projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Chapter_Two_Installation.xml 2010-04-16 06:39:02 UTC (rev 104039)
@@ -8,6 +8,7 @@
<chapter>
<title>Installation</title>
+ <!--EDIT: List nesting, tabbing, etc.-->
<warning><title> Installing JBoss Web Services CXF is irreversible. </title>
<para>
You should make a complete backup of your JBoss Enterprise Application Platform installation before installing JBoss Web Services CXF. </para>
@@ -30,7 +31,7 @@
This step will replace JBoss Web Services Native with JBoss Web Services CXF in every configuration that contains JBoss Web Services Native </para></note>
<para> After the jbossws.sar is deployed you should be able to access JBossWS under
-http://localhost:8080/jbossws
+http://localhost:8080/jbossws <!--EDIT: Keep in mind that none of the line breaks in this para are going to show up in the build. You should tag for this kind of structure rather than using the enter key. Also, please tag this sort of path with <filename> as well. :)-->
If you have any questions, please post to the userforum:
<ulink url="http://community.jboss.org/en/jbosswebservices/cxf?view=discussions" />
Modified: projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Feedback.xml
===================================================================
--- projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Feedback.xml 2010-04-16 06:36:02 UTC (rev 104038)
+++ projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Feedback.xml 2010-04-16 06:39:02 UTC (rev 104039)
@@ -5,11 +5,13 @@
<section>
<title>Help Contribute</title>
<para>
- If you find a typographical error in this document, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA: <ulink url="http://jira.jboss.com">http://jira.jboss.com</ulink> against the project <citetitle>JBoss Application Server</citetitle> and component <citetitle>Documentation</citetitle>.
+ If you find a typographical error in this document, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA: <ulink url="http://jira.jboss.com">http://jira.jboss.com</ulink> against the project <citetitle>JBoss Application Server</citetitle> <!--EDIT: Curse the template, for it fills in the wrong things for you. This should be JBoss Enterprise Application Platform.--> and component <citetitle>Documentation</citetitle>.
</para>
<para>
If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
</para>
+
+<!--EDIT: You can probably chop out these two notes. :) -->
<note><title>Note</title><para>Be sure to give us your name so you can receive full credit.</para></note>
<note><title>Note</title><para>This content is taken from svn.jboss.org/repos/jbossas/projects/docs/trunk and has yet to be branched.</para></note>
Modified: projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Revision_History.xml
===================================================================
--- projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Revision_History.xml 2010-04-16 06:36:02 UTC (rev 104038)
+++ projects/docs/enterprise/5.0/CXF_User_Guide/en-US/Revision_History.xml 2010-04-16 06:39:02 UTC (rev 104039)
@@ -9,7 +9,7 @@
<revhistory>
<revision>
<revnumber>0</revnumber>
- <date>Tues Apr 13 2010</date>
+ <date>Tues Apr 13 2010</date> <!--EDIT: The date here has to be in a certain format or it won't build in Brew for you (this will come later). Best to get into the habit of Ddd Mmm ## YYYY, e.g. Tue Apr 13 2010, now.-->
<author>
<firstname>Rebecca</firstname>
<surname>Newton</surname>
More information about the jboss-cvs-commits
mailing list