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