3 Replies Latest reply on Dec 14, 2006 12:23 PM by Thomas Diesler

    Proposed JAX-WS Docs

    Sam Griffith Jr. Newbie

      Hello,

      The outline below is a basis for the docs for the JAX-WS 2.0 docs. I'd like to get input on what other documentation people would like to see. The initial docs will be for the January release and will have the most important information and we will add to it from there. So even if you don't see your suggestion in the initial cut, we will try and add it later.

      Thanks for the input.

      Sam Griffith
      Docs Team

      ---------------------------------------------------------


      JBoss JAX-WS 2.0 Doc Proposal
      - [ ] JAX-WS 2 Topics for Docs
      - [ ] Overview
      - [ ] JAXB
      - [ ] What roll does JAXB play in JAX-WS 2.0?
      - [ ] SOAP 1.2
      - [ ] Description
      - [ ] WS Basic Profile 1.1
      - [ ] Description
      - [ ] Annotations in JAX-WS 2.0
      - [ ] Description
      This is the annotations that JAX-WS 2.0 defines.
      The annotations allow you to set the common
      configuration settings for client and server side
      development in common configurations.
      - [ ] Overview of
      - [ ] rpc/literal
      - [ ] document/literal/bare
      - [ ] document/literal/wrapped

      - [ ] JBoss Tools
      - [ ] Which tools do we provide
      - [ ] WSTOOL
      - [ ] Description
      - [ ] options
      - [ ] description
      - [ ] acceptable values
      - [ ] ???
      - [ ] Which tools do we use from reference implementation
      - [ ] ????
      - [ ] JSR 181 POJO Example
      - [ ] Description
      - [ ] Greeting App
      A variation of Hello World.
      - [ ] Important Annotations
      - [ ] Ant build file
      The standard Ant build file that you can build on for JAX-WS 2.0 web services you want to build.
      - [ ] Setting up Eclipse to work with JBossWS 2.0
      - [ ] How to
      - [ ] Setting up NetBeans to work with JBossWS 2.0
      - [ ] How to
      - [ ] JSR 181 EJB Example
      - [ ] Description
      - [ ] What's different than the POJO example?
      - [ ] New Annotations
      - [ ] Changes to Ant build file
      - [ ] MTOM Example
      - [ ] Description
      - [ ] How To
      - [ ] Annotaions?
      - [ ] WS-Security
      - [ ] Description
      - [ ] Alignment with JSR 183
      - [ ] Annotations?
      - [ ] Authentication
      - [ ] What we support
      - [ ] How To
      - [ ] Encryption
      - [ ] What we support
      - [ ] How To
      - [ ] Authorization
      - [ ] What we support
      - [ ] Signatures
      - [ ] How To
      - [ ] Provider
      - [ ] ???
      - [ ] Protocol vs. Logic Handler
      - [ ] ???
      - [ ] WS-Addressing (Not sure on this one)
      - [ ] Description
      - [ ] How To
      - [ ] Annotations?
      - [ ] Async Web Services (Not sure on this one)
      - [ ] Description
      - [ ] How To
      - [ ] Client Programming Model
      - [ ] ie - @WebServiceRef
      - [ ] ??? - others...

        • 1. Re: Proposed JAX-WS Docs
          Thomas Diesler Master

          From the SunRI

          # JAX-WS 2.0 User's Guide

          1. Contents
          2. 1. Introduction
          1. 1.1 What's new in JAX-WS 2.0 ea3
          1. 1.1.1 new JAXWS 2.0 API
          2. 1.1.2 Fully Dynamic Runtime
          3. 1.1.3 MTOM & Swaref
          4. 1.1.4 SOAP 1.2
          2. 2.1 Features introduced in this release
          1. 2.1.1 JAXB 2.0
          2. 2.1.2 Annotations
          3. 2.1.3 Customizations
          4. 2.1.4 Improved Handler Framework
          5. 2.1.5 Provider
          6. 2.1.6 Dispatch
          7. 2.1.7 Asynchronous Client Operations
          3. 3. Programming Model
          1. 3.1 Server
          1. 3.1.1 Starting from Java
          2. 3.1.1.1 Generate Portable Artifacts
          3. 3.1.1.2 Create a WAR file to deploy
          4. 3.1.2 Starting from a WSDL File
          5. 3.1.2.1 Generate a Service Endpoint Interface
          6. 3.1.2.2 Implement the Service Endpoint Interface
          7. 3.1.2.3 Create a WAR
          8. 3.1.2.4 J2SE Endpoints
          2. 3.2 Client
          1. 3.2.1 Dynamic Proxy
          2. 3.2.1.1 Generate Client Artifacts
          3. 3.2.2 Dispatch
          4. 4. Useful Information

          • 2. Re: Proposed JAX-WS Docs
            Thomas Diesler Master

            From XFire

            * Overview (READ FIRST!)
            * Guides
            o Quick Start - Your first service with XFire using services.xml
            o Dependency Guide - This is so confusing... What jars do I need and why?!?!
            o Client and Server Stub Generation from WSDL - How to make a web service client
            o Embedded XFire HTTP Service - How to use the XFire API to create a Service, Client, and embedded HTTP server.
            o JSR 181 Service - How to write a service using annotations
            o JAXB 2.0 - Writing a schema and service with JAXB 2.0
            o JMS Transport - Impress your friends by doing SOAP over JMS
            o Service Router - How to route messages to various Services with one endpoint
            o Maven Guide - How do I set up Maven to use XFire Jars?
            o Parsing a SOAP Message without Web Services - How to leverage all the power of XFire without using traditional Web Services
            o Eclipse Plugin - Using the eclipse plugin to generate services and clients from WSDL.
            * XML Configuration
            o services.xml Reference
            * Using the XFire API
            o The ServiceFactory
            o Servlet Setup
            o Embedding XFire
            o Invokers
            o The MessageContext and Messages
            o Processing Pipeline
            o Writing Handlers
            o Fault and Exception Handling
            o Logging
            * Bindings
            o Aegis Binding: XFire's default POJO binding
            + Inheritance
            + Aegis Java 5 Annotations
            + Interfaces
            + Collections
            + Custom Types
            + Aegis Internals
            o Castor
            o XMLBeans Binding
            o JAXB 2.0
            o JAXB 1.1
            o JiBX
            o Message Binding
            * JSR 181 Annotations
            * Client API
            o Dynamic Client
            * Client and Server Stub Generation from WSDL
            * Authentication
            * Container Support
            o Spring
            + Spring QuickStart Guide
            + Spring, XBean, Servlets and more
            + Spring Remoting
            + Advanced Configuration
            o Plexus
            o Loom
            o PicoContainer
            o Yan
            * MTOM Support
            * JAX-WS
            * JBI Integration
            * WS-Addressing
            * WS-Security
            * GZip Support
            * Transports
            o Transport and Channel API
            o HTTP Transport
            o JMS Transport
            o Local Transport
            o XMPP Transport
            * Application Server Support
            * Best Practices
            o Web Service Design
            o Versioning
            o Testing Your XFire Services
            * Developers
            o Architecture
            o Source Repository
            o Building from sources

            • 3. Re: Proposed JAX-WS Docs
              Thomas Diesler Master

              From Axis

              * Introduction
              o What is SOAP?
              o What is Axis?
              o What's in this release?
              o What's still to do?
              * Installing Axis and Using this Guide
              * Consuming Web Services with Axis
              o Basics - Getting Started
              o Naming Parameters
              o Interoperating with "untyped" servers
              * Publishing Web Services with Axis
              o JWS (Java Web Service) Files - Instant Deployment
              o Custom Deployment - Introducing WSDD
              o Service Styles - RPC, Document, Wrapped, and Message
              * XML <-> Java Data Mapping in Axis
              o How your Java types map to SOAP/XML types
              o Exceptions
              o What Axis can send via SOAP with restricted Interoperability
              o What Axis can not send via SOAP
              o Encoding Your Beans - the BeanSerializer
              o When Beans Are Not Enough - Custom Serialization
              * Using WSDL with Axis
              o ?WSDL: Obtaining WSDL for deployed services
              o WSDL2Java: Building stubs, skeletons, and data types from WSDL
              o Java2WSDL: Building WSDL from Java
              * Published Axis Interfaces
              * Newbie Tips: Finding Your Way Around
              o Places to Look for Clues
              o Classes to Know
              * Appendix : Using the Axis TCP Monitor (tcpmon)
              * Appendix: Using the SOAP Monitor
              * Glossary