Mailing-List: contact issues-help@cxf.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@cxf.apache.org
Message-ID: <24030964.68741286749891017.JavaMail.jira@thor>
Date: Sun, 10 Oct 2010 18:31:31 -0400 (EDT)
From: "Robert Liguori (JIRA)" <jira@apache.org>
To: issues@cxf.apache.org
Subject: [jira] Updated: (CXF-3038) Update online CXF Architecture Document
In-Reply-To: <4607024.547641286289573019.JavaMail.jira@thor>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


     [ https://issues.apache.org/jira/browse/CXF-3038?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Liguori updated CXF-3038:
--------------------------------

    Description: 
The CXF Architecture Guide (http://cxf.apache.org/docs/cxf-architecture.html) needs to be updated.

Some strong suggestions:

(1) The "Frontends" section has only one sub-section, and it's empty.  The "Frontends" section should discuss JAX-WS, JAX-RS, Simple Frontend and Javascript.

(2) It would be nice if the "Data Bindings" section referenced supported data bindings (e.g., JAXB, XMLBeans, Aegis (2.1), Aegis (2.0.x), MTOM Attachments with JAXB, Service Data Objects (SDO) and SXC

(3) The "Bindings" section should be renamed to "Protocol Bindings".  There are currently two sections, one on SOAP bindings and an empty on on XML bindings.  Consider sub-sections on SOAP 1.1/1.2 bindings, HTTP 1.1 bindings, Pure XML bindings and CORBA bindings.

(4) Consider adding notes on supported transports to the "Transports" section; SOAP over HTTP, SOAP over JMS, XML over HTTp, XML over JMS, CORBA, Servlet, In-VM, SMTP/POP3 via Camel Transport for CXF, TCP via Camel Transport for CXF and Jabber (Experimental) via Camel Transport for CXF
 
(5) The book "Apache CXF Web Service Development" by Naveen Balani and Rajeev Hathi (Packt Publishing) has a nice "CXF Architecture" section, pages 39-49.  This nook should be references and/or compared to the document for alignment purposes (since the  section headers are nearly identical).

Note: Since this is an 'architecture' document, perhaps specific implementation details and related products is outside of scope (e.g., listing specific data binding APIs), but it would still be nice to see.  At a minimum though... the empty, place holder sections of this document should be completed by someone.

  was:
Considering the CXF Architecture Guide (http://cxf.apache.org/docs/cxf-architecture.html), the leading paragraph, does not model the actual content of the web page. 

Consider reworking the content and/or the leading paragraph so they are in sync.

For example:

The overall CXF architecture is primarily made up of the following parts:

1. Bus: This is the backbone of the CXF architecture. 
2. Messaging & Interceptors: These provide the low level message and pipeline layer upon which most functionality is built. 
3. Front ends: Frontends provide a programming model to create services (e.g. JAX-WS). 
4. Services: Services host a Service model which is a WSDL-like model which describes the service. 
5. Bindings: Bindings provide the functionality to interpret the protocol (i.e. SOAP, REST, Corba). 
6. Transports: Destinations and Conduits make up the transport abstraction that CXF uses to achieve transport neutrality. 

SHOULD READ

The overall CXF architecture is primarily made up of the following parts:

1. Bus: This is the backbone of the CXF architecture. 
2. Messaging & Interceptors: These provide the low level message and pipeline layer upon which most functionality is built. 
3. Transports: Destinations and Conduits make up the transport abstraction that CXF uses to achieve transport neutrality. 
4. Data Bindings: [TBD]
5. Service Model: Services host a Service model which is a WSDL-like model which describes the service. 
6. Bindings: Bindings provide the functionality to interpret the protocol (i.e. SOAP, REST, Corba). 
7. Endpoints: [TBD]
8. Front ends: Frontends provide a programming model to create services (e.g. JAX-WS). 


----------------------
Also, the initial TOC of links can be removed in favor of adding hyperlinks to the above number list (as they provide the same purpose)


> Update online CXF Architecture Document
> ---------------------------------------
>
>                 Key: CXF-3038
>                 URL: https://issues.apache.org/jira/browse/CXF-3038
>             Project: CXF
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Robert Liguori
>            Priority: Minor
>   Original Estimate: 2h
>  Remaining Estimate: 2h
>
> The CXF Architecture Guide (http://cxf.apache.org/docs/cxf-architecture.html) needs to be updated.
> Some strong suggestions:
> (1) The "Frontends" section has only one sub-section, and it's empty.  The "Frontends" section should discuss JAX-WS, JAX-RS, Simple Frontend and Javascript.
> (2) It would be nice if the "Data Bindings" section referenced supported data bindings (e.g., JAXB, XMLBeans, Aegis (2.1), Aegis (2.0.x), MTOM Attachments with JAXB, Service Data Objects (SDO) and SXC
> (3) The "Bindings" section should be renamed to "Protocol Bindings".  There are currently two sections, one on SOAP bindings and an empty on on XML bindings.  Consider sub-sections on SOAP 1.1/1.2 bindings, HTTP 1.1 bindings, Pure XML bindings and CORBA bindings.
> (4) Consider adding notes on supported transports to the "Transports" section; SOAP over HTTP, SOAP over JMS, XML over HTTp, XML over JMS, CORBA, Servlet, In-VM, SMTP/POP3 via Camel Transport for CXF, TCP via Camel Transport for CXF and Jabber (Experimental) via Camel Transport for CXF
>  
> (5) The book "Apache CXF Web Service Development" by Naveen Balani and Rajeev Hathi (Packt Publishing) has a nice "CXF Architecture" section, pages 39-49.  This nook should be references and/or compared to the document for alignment purposes (since the  section headers are nearly identical).
> Note: Since this is an 'architecture' document, perhaps specific implementation details and related products is outside of scope (e.g., listing specific data binding APIs), but it would still be nice to see.  At a minimum though... the empty, place holder sections of this document should be completed by someone.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.