Bug 777685 (SOA-198)

Summary: Doc review comments - ESB Programmers Guide
Product: [JBoss] JBoss Enterprise SOA Platform 4 Reporter: Jehudi Castro Sierra <jcastro>
Component: DocumentationAssignee: trev <tkirby>
Status: CLOSED NEXTRELEASE QA Contact:
Severity: high Docs Contact:
Priority: high    
Version: 4.2 IR7CC: jwulf, mvecera
Target Milestone: ---   
Target Release: 4.2 CR2   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/SOA-198
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2008-01-31 11:29:04 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Jehudi Castro Sierra 2007-12-03 15:57:19 UTC
Date of First Response: 2008-01-09 14:36:01
project_key: SOA

https://engineering.redhat.com/docbot/en-US/Red_Hat_Enterprise_Linux/1.0/html/SOA_ESB_Programmers_Guide/SOA_ESB_Programmers_Guide-JBoss_ESB-_Rosetta_.html the image is no clear on the html, neither on the pdf

https://engineering.redhat.com/docbot/en-US/Red_Hat_Enterprise_Linux/1.0/html/SOA_ESB_Programmers_Guide/SOA_ESB_Programmers_Guide-Services_and_Messages-_Introduction_.html typo: on "Messages are the way in which clients an d services communicate with each other." "an d" -> "and"

https://engineering.redhat.com/docbot/en-US/Red_Hat_Enterprise_Linux/1.0/html/SOA_ESB_Programmers_Guide/SOA_ESB_Programmers_Guide-Services_and_Messages-_The_Message_.html typo: on "At present JBossESB does not support specifying other encoding mechanisms for the Message or attachment streaming. This will be added in later releases and where appropriate will be tied in to the SOAP-with-attachments delivery mechanism. Therefore, currently attachments are treated in the same was as named objects within the Body." "was" -> "way"

https://engineering.redhat.com/docbot/en-US/Red_Hat_Enterprise_Linux/1.0/html/SOA_ESB_Programmers_Guide/SOA_ESB_Programmers_Guide-_The_Message_-_The_Message_Header_.html "[To] URI (mandatory). The address of the intended receiver of this message." [To] is an EPR not an URI


https://engineering.redhat.com/docbot/en-US/Red_Hat_Enterprise_Linux/1.0/html/SOA_ESB_Programmers_Guide/SOA_ESB_Programmers_Guide-JBoss_ESB.html the note: "[1] Rosetta borrowed its name from the stone found in 1799 by French soldiers in the Nile delta's town of Rosetta (French for Rashid) that was instrumental in Jean-François Champollion deciphering of Egyptian hieroglyphs." must not be there

https://engineering.redhat.com/docbot/en-US/Red_Hat_Enterprise_Linux/1.0/html/SOA_ESB_Programmers_Guide/SOA_ESB_Programmers_Guide-_Advanced_Topics_.html the note: "[2] Most of the schedule based listener candidates are currently using a "threaded polling" model, in which they run a thread internally. This thread sleeps and wakes up periodically, checking for new messages." must not be there

https://engineering.redhat.com/docbot/en-US/Red_Hat_Enterprise_Linux/1.0/html/SOA_ESB_Programmers_Guide/SOA_ESB_Programmers_Guide-_Fault_tolerance_and_Reliability_.html the notes: "[3] Aircraft manufacturing has a very high fault tolerance requirement: the chance of a failure occurring should be no higher than 10-9." and "[4] When groups of receivers are present then the semantics are typically based around atomic delivery, i.e., either all recipients get the message or none of them get it." must not be there.

https://engineering.redhat.com/docbot/en-US/Red_Hat_Enterprise_Linux/1.0/html/SOA_ESB_Programmers_Guide/SOA_ESB_Programmers_Guide-_Fault_tolerance_and_Reliability_-_Reliability_guarantees_.html the note: "[4] When groups of receivers are present then the semantics are typically based around atomic delivery, i.e., either all recipients get the message or none of them get it." must not be there

https://engineering.redhat.com/docbot/en-US/Red_Hat_Enterprise_Linux/1.0/html/SOA_ESB_Programmers_Guide/SOA_ESB_Programmers_Guide-_Configuration_.html all the notes (5-10) must not be there

PDF
All images should be in vector format - they are either blurred or unreadble

Preface 2. We need feedback - conatins FIXME strings instead of product name

1.2 .When would you use an ESB? 

The figures below illustrate some concrete examples where JBossESB would be useful. Although these examples are specific to interactions between participants using non-interoperable JMS implementations, the principles are general and can be applied to other transports such as FTP and HTTP. - does not make sense the examples uses file bases and interoperable JMS implementations


2.2.  The core of JBossESB in a nutshell 

Rosetta is built on three core architectural components: - there are four items in the list, moreover, should be be also BPM componenet mentioned?

3.3.  The Message
Message structure images are not accurate to message structure
Note

In JBossESB, Attachments and Properties are not treated differently from the Body. The general concepts they embody are currently being re-evaluated and may change significantly in future releases. As such, we recommend developers do not use Attachments. - but we are encouraging this practice by use in aggegator!

3.3.2.  Extensions to Body
For each of the various Body types, you will find an associated create method (e.g., createTextBody) - where I find it?

3.3.3.  The Message Header
Header structure image is inaccurate
relatesTo from header is not explained

page 34 (44) - example MyJMSListenerAction uses deprecated API
page 40 (50) - table overflow
page 48 (58) - table overflow
6.1.3 - sample code overflow, missing typecasting for gets
page 66 (76) - sample code overflow
page 71 (81) - Image does not make sense as Fault Clssification Hierarchy

replace Bizantine with Byzantine

page 86 (96) - table overflow, mising okmethod, error method attributes, document that name must be unique

page 88, 89 (98,99) - wrong numbering format, footnote overflow
page 93 (103) - table overflow

Why FTP provider is configured and no others?

There should be JCA chapter included - transactions, exceptions

Document all supported parameters from jbossesb-properties.xml file
As jUDDI is not recommended as production UDDI provide the short procedure what is required to reconfigure (maybe in Admin Guide?)

Comment 1 Len DiMaggio 2007-12-03 16:27:24 UTC
Link: Added: This issue is a dependency of SOA-200


Comment 2 Len DiMaggio 2008-01-09 19:36:01 UTC
A new version of the doc is out for review.

Comment 3 Len DiMaggio 2008-01-28 14:41:32 UTC
Link: Added: This issue is a dependency of SOA-306