aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: /**
aoqi@0:  * <h1>JAX-WS 2.1 Tools</h1>
aoqi@0:  * This document describes the tools included with JAX-WS 2.0.1.
aoqi@0:  *
aoqi@0:  * {@DotDiagram digraph G {
aoqi@0: // external tools
aoqi@0: AP;
aoqi@0: 
aoqi@0: // ANT tasks
aoqi@0: node [style=filled,color=lightyellow];
aoqi@0: "WsGen ANT Task"; "WsImport ANT Task";
aoqi@0: 
aoqi@0: // commandline
aoqi@0: node [style=filled,color=lightpink];
aoqi@0: wsgen; wsimport;
aoqi@0: 
aoqi@0: // libraries
aoqi@0: node [style=filled,color=lightblue];
aoqi@0: WsimportTool; WsgenTool;"WSAP"; WebServiceAp; WSDLModeler;WSDLParser;SeiGenerator;ServiceGenerator;ExceptionGenerator;"JAXB XJC APIs";CodeModel;
aoqi@0: 
aoqi@0: // aps
aoqi@0: #       node [style=filled,color=lightpink];
aoqi@0: #       "JAX-WS"; tools; runtime; SPI; "Annotation Processor";
aoqi@0: 
aoqi@0: "WsGen ANT Task" -> wsgen -> WsgenTool;
aoqi@0: "WsImport ANT Task" -> wsimport -> WsimportTool;
aoqi@0: 
aoqi@0: WsgenTool -> Annotation Processing -> WSAP -> WebServiceAp;
aoqi@0: WsimportTool -> WSDLModeler;
aoqi@0: WSDLModeler->WSDLParser;
aoqi@0: WSDLModeler->"JAXB XJC APIs"
aoqi@0: WsimportTool->SeiGenerator->CodeModel;
aoqi@0: WsimportTool->ServiceGenerator->CodeModel;
aoqi@0: WsimportTool->ExceptionGenerator->CodeModel;
aoqi@0: WebServiceAp->CodeModel
aoqi@0: }
aoqi@0:  * }
aoqi@0:  * <div align=right>
aoqi@0:  * <b>Legend:</b> blue: implementation classes, pink: command-line toosl, white: external tool, yellow: ANT tasks
aoqi@0:  * </div>
aoqi@0:  *
aoqi@0:  * <h2>ANT Tasks</h2>
aoqi@0:    <d1>
aoqi@0:  *  <dt>{@link com.sun.tools.internal.ws.ant.AnnotationProcessingTask AnnotationProcessing}
aoqi@0:  *  <dd>An ANT task to invoke <a href="http://download.oracle.com/javase/6/docs/api/javax/annotation/processing/package-summary.html">Annotation Processing</a>.
aoqi@0: 
aoqi@0:  *  <dt>{@link com.sun.tools.internal.ws.ant.WsGen2 WsGen}
aoqi@0:  *  <dd>
aoqi@0:  *    An ANT task to invoke {@link com.sun.tools.internal.ws.WsGen WsGen}
aoqi@0: 
aoqi@0:  *  <dt>{@link com.sun.tools.internal.ws.ant.WsImport2 WsImport}
aoqi@0:  *  <dd>
aoqi@0:  *    An ANT task to invoke {@link com.sun.tools.internal.ws.WsImport WsImport}
aoqi@0:  *
aoqi@0:  *  </d1>
aoqi@0:  * <h2>Command-line Tools</h2>
aoqi@0:    <d1>
aoqi@0:  *  <dt><a href="http://download.oracle.com/javase/6/docs/api/javax/annotation/processing/package-summary.html">AP</a>
aoqi@0:  <dd>A Java SE tool and framework for processing annotations. Annotation processing will invoke a JAX-WS AnnotationProcossor for
aoqi@0:  *   processing Java source  files with javax.jws.* annotations and making them web services.
aoqi@0:  *   Annotation processing will compile the Java source files and generate any additional classes needed to make an javax.jws.WebService
aoqi@0:  *   annotated class a Web service.
aoqi@0:  *
aoqi@0:  *  <dt>{@link com.sun.tools.internal.ws.WsGen WsGen}
aoqi@0:  *  <dd>Tool to process a compiled javax.jws.WebService annotated class and to generate the necessary classes to make
aoqi@0:  *  it a Web service.
aoqi@0: 
aoqi@0:  *  <dt>{@link com.sun.tools.internal.ws.ant.WsImport2 WsImport}
aoqi@0:  *  <dd>
aoqi@0:  *    Tool to import a WSDL and to generate an SEI (a javax.jws.WebService) interface that can be either implemented
aoqi@0:  *    on the server to build a web service, or can be used on the client to invoke the web service.
aoqi@0:  *  </d1>
aoqi@0:  * <h2>Implementation Classes</h2>
aoqi@0:  *  <d1>
aoqi@0:  *    <dt>{@link com.sun.tools.internal.ws.processor.model.Model Model}
aoqi@0:  *    <dd>The model is used to represent the entire Web Service.  The JAX-WS ProcessorActions can process
aoqi@0:  *    this Model to generate Java artifacts such as the service interface.
aoqi@0:  *
aoqi@0:  *
aoqi@0:  *    <dt>{@link com.sun.tools.internal.ws.processor.modeler.Modeler Modeler}
aoqi@0:  *    <dd>A Modeler is used to create a Model of a Web Service from a particular Web
aoqi@0:  *    Web Service description such as a WSDL
aoqi@0:  *    file.
aoqi@0:  *
aoqi@0:  *    <dt>{@link com.sun.tools.internal.ws.processor.modeler.wsdl.WSDLModeler WSDLModeler}
aoqi@0:  *    <dd>The WSDLModeler processes a WSDL to create a Model.
aoqi@0:  *
aoqi@0:  *    <dt>{@link com.sun.tools.internal.ws.processor.modeler.annotation.WebServiceAp WebServiceAp}
aoqi@0:  *    <dd>WebServiceAp is a AnnotationProcessor for processing javax.jws.* and
aoqi@0:  *    javax.xml.ws.* annotations. This class is used either by the WsGen (CompileTool) tool or
aoqi@0:  *    idirectly via the {@link com.sun.istack.internal.ws.WSAP WSAP} when invoked by Annotation Processing.
aoqi@0:  *   </d1>
aoqi@0:  *
aoqi@0:  * @ArchitectureDocument
aoqi@0:  **/
aoqi@0: package com.sun.tools.internal.ws;