[esb-issues] [JBoss JIRA] Work started: (JBESB-2250) Update ProgrammersGuide.pdf

Update ProgrammersGuide.pdf --------------------------- Key: JBESB-2250 URL: https://jira.jboss.org/jira/browse/JBESB-2250 Project: JBoss ESB Issue Type: Task Security Level: Public(Everyone can see) Components: Documentation Reporter: Daniel Bevenius Assignee: Daniel Bevenius Fix For: 4.5 * "3.2 Figure 3.1 and Figure 3.2 - each describes the same but have different structure (missing pieces in the figures)" >Diagrams are derived from the ESB Programmers Guide & I believe 3.1 is supposed to be a much generalized image. Guidance please. This what Figure 3.1 looks like in the ESB Projects ProgrammersGuide: <?xml version = "1.0" encoding = "UTF-8"?> <jbossesb xmlns="http://anonsvn.labs.jboss.com/labs/jbossesb/trunk/product/etc... <services> <service category="Retail" name="ShoeStore" description="Acme Shoe Store Service"> <actions> <action name="println" class="org.jboss.soa.esb.actions.SystemPrintln" /> </actions> </service> </services> </jbossesb> The "missing pieces would in this case be the provider configuration and the listener configurations, unless the invm transport is assumed. The two diagrams do not describe the same thing, unless I'm missing something. I don't think that action should be taken here. * "3.2.4 The name for any given named object in a message must be unique or an exception will be thrown. - is it really true? How can this happen?" No, this is not true (the report is correct that is). This is simply a Hashtable and adding a new named object will replace the old one. This is also present in the ESB Programmers Guide on page 28 which needs to be updated * "3.2.5 Creating different body types - there is org.jboss.soa.esb.message.body.content.Payload class for this purpose >List of different message bodies - there are duplicate items" There are no duplicates in the ESB projects programmers Guide. See page 24. * "4.1 Routers are in the section name but are not mentioned in the text - also need to explain difference between routers and notifiers. >Would be also good to mention that it is not necessary to provide the information to listener - the reference to provider for given transport is typically used Routers are not mentioned in the ESB Programmers Guide, not in this section. Update required. * "5 This chapter should contain also Service orchestration section" >Update content in ESB Programmers Guide The "Service orchestration section" is located in the ESB projects document "ServicesGuide.pdf". It could be lifted into the SOA Platform document. * "page 73 - Note and page 34 - Note: The latter says that the gateway EPRs are not stored in registry and the former says they are" Page 41 of ESB ProgrammersGuide: Note: It is possible that multiple EPRs may be present in the Registry with the same Service Name/Category and that some of these EPRs may not be ESB-aware, e.g., Gateways. If the ServiceInvoker receives ESB-unaware EPRs from the Registry then it will ignore them. You may see the warning: "Invalid EPR for service (probably ESB-unaware)". Page 77 of ESB ProgrammersGuide: Note: For each gateway listener defined in a service, an ESB aware listener (or "native") listener must also be defined as gateway listeners do not define bidirectional endpoints, but rather "startpoints" into the ESB. From within the ESB you cannot send a message to a Gateway. Also, note that since a gateway is not an endpoint, it does not have an Endpoint Reference (EPR) persisted in the registry. This will need to be updated. * "Chapter 10 - the is new style functionality related to WS - EBWS (ESB services exposed as Web Services)" This needs to be added to the ESB projecs ProgrammersGuide. This is no currently in the main trunk but will be shortly. * "Appendix A - there is nothing in the text that justifies the inclusion of this Appendix - for what the JAXB is used in ESB context?" The appendix is for "JAXB Introductions" (http://www.jboss.org/community/docs/DOC-10075) and not JAXB isself.