| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>WebService</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WebService"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/jws/WebResult.html" title="annotation in jakarta.jws"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/jws/WebService.html" target="_top">Frames</a></li> |
| <li><a href="WebService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.jws</div> |
| <h2 title="Annotation Type WebService" class="title">Annotation Type WebService</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Retention(value=RUNTIME) |
| @Target(value=TYPE) |
| public @interface <span class="memberNameLabel">WebService</span></pre> |
| <div class="block">Marks a Java class as implementing a Web Service, or a Java interface as defining a Web Service interface.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/examples/webservice-ws-with-resources-config.html">webservice-ws-with-resources-config</a>, <a href="../../../../../tomee-9.0/examples/webservice-ws-security.html">webservice-ws-security</a>, <a href="../../../../../tomee-9.0/examples/webservice-ssl-client-cert.html">webservice-ssl-client-cert</a>, <a href="../../../../../tomee-9.0/examples/webservice-security.html">webservice-security</a>, <a href="../../../../../tomee-9.0/examples/webservice-inheritance.html">webservice-inheritance</a>, <a href="../../../../../tomee-9.0/examples/webservice-holder.html">webservice-holder</a>, <a href="../../../../../tomee-9.0/examples/webservice-handlerchain.html">webservice-handlerchain</a>, <a href="../../../../../tomee-9.0/examples/webservice-attachments.html">webservice-attachments</a>, <a href="../../../../../tomee-9.0/examples/simple-webservice.html">simple-webservice</a>, <a href="../../../../../tomee-9.0/examples/simple-webservice-without-interface.html">simple-webservice-without-interface</a>, <a href="../../../../../tomee-9.0/examples/pojo-webservice.html">pojo-webservice</a>, <a href="../../../../../tomee-9.0/examples/mtom.html">mtom</a>, <a href="../../../../../tomee-9.0/examples/ejb-webservice.html">ejb-webservice</a>, <a href="../../../../../tomee-9.0/examples/ejb-examples.html">ejb-examples</a>, <a href="../../../../../tomee-9.0/examples/change-jaxws-url.html">change-jaxws-url</a>, <a href="../../../../../tomee-9.0/examples/applicationcomposer-jaxws-cdi.html">applicationcomposer-jaxws-cdi</a></dd> |
| <dt><span class="simpleTagLabel">Examples (pt):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/pt/examples/webservice-ws-with-resources-config.html">webservice-ws-with-resources-config</a>, <a href="../../../../../tomee-9.0/pt/examples/webservice-ssl-client-cert.html">webservice-ssl-client-cert</a>, <a href="../../../../../tomee-9.0/pt/examples/webservice-holder.html">webservice-holder</a>, <a href="../../../../../tomee-9.0/pt/examples/webservice-handlerchain.html">webservice-handlerchain</a>, <a href="../../../../../tomee-9.0/pt/examples/pojo-webservice.html">pojo-webservice</a>, <a href="../../../../../tomee-9.0/pt/examples/change-jaxws-url.html">change-jaxws-url</a>, <a href="../../../../../tomee-9.0/pt/examples/applicationcomposer-jaxws-cdi.html">applicationcomposer-jaxws-cdi</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.optional.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Optional Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> |
| <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Optional Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jws/WebService.html#endpointInterface--">endpointInterface</a></span></code> |
| <div class="block">The complete name of the service endpoint interface defining the service's abstract Web Service contract.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jws/WebService.html#name--">name</a></span></code> |
| <div class="block">The name of the Web Service.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jws/WebService.html#portName--">portName</a></span></code> |
| <div class="block">The port name of the Web Service.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jws/WebService.html#serviceName--">serviceName</a></span></code> |
| <div class="block">The service name of the Web Service.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jws/WebService.html#targetNamespace--">targetNamespace</a></span></code> |
| <div class="block">If the @WebService.targetNamespace annotation is on a service endpoint interface, the targetNamespace is used |
| for the namespace for the wsdl:portType (and associated XML elements).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jws/WebService.html#wsdlLocation--">wsdlLocation</a></span></code> |
| <div class="block">The location of a pre-defined WSDL describing the service.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="name--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>public abstract java.lang.String name</pre> |
| <div class="block">The name of the Web Service. |
| <p> |
| Used as the name of the wsdl:portType when mapped to WSDL 1.1.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the Web Service</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="targetNamespace--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>targetNamespace</h4> |
| <pre>public abstract java.lang.String targetNamespace</pre> |
| <div class="block">If the @WebService.targetNamespace annotation is on a service endpoint interface, the targetNamespace is used |
| for the namespace for the wsdl:portType (and associated XML elements). |
| <p> |
| If the @WebService.targetNamespace annotation is on a service implementation bean that does NOT reference a |
| service endpoint interface (through the endpointInterface attribute), the targetNamespace is used for both the |
| wsdl:portType and the wsdl:service (and associated XML elements). |
| <p> |
| If the @WebService.targetNamespace annotation is on a service implementation bean that does reference a service |
| endpoint interface (through the endpointInterface attribute), the targetNamespace is used for only the |
| wsdl:service (and associated XML elements).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>targetNamespace</code> annotation</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="serviceName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serviceName</h4> |
| <pre>public abstract java.lang.String serviceName</pre> |
| <div class="block">The service name of the Web Service. |
| <p> |
| Used as the name of the wsdl:service when mapped to WSDL 1.1. |
| <p> |
| <i>This member-value is not allowed on endpoint interfaces.</i></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the service name</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="portName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>portName</h4> |
| <pre>public abstract java.lang.String portName</pre> |
| <div class="block">The port name of the Web Service. |
| <p> |
| Used as the name of the wsdl:port when mapped to WSDL 1.1. |
| <p> |
| <i>This member-value is not allowed on endpoint interfaces.</i></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the port name</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="wsdlLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wsdlLocation</h4> |
| <pre>public abstract java.lang.String wsdlLocation</pre> |
| <div class="block">The location of a pre-defined WSDL describing the service. |
| <p> |
| The wsdlLocation is a URL (relative or absolute) that refers to a pre-existing WSDL file. The presence of a |
| wsdlLocation value indicates that the service implementation bean is implementing a pre-defined WSDL contract. |
| The JSR-181 tool MUST provide feedback if the service implementation bean is inconsistent with the portType and |
| bindings declared in this WSDL. Note that a single WSDL file might contain multiple portTypes and multiple |
| bindings. The annotations on the service implementation bean determine the specific portType and bindings that |
| correspond to the Web Service.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the location of a pre-defined WSDL</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="endpointInterface--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>endpointInterface</h4> |
| <pre>public abstract java.lang.String endpointInterface</pre> |
| <div class="block">The complete name of the service endpoint interface defining the service's abstract Web Service contract. |
| <p> |
| This annotation allows the developer to separate the interface contract from the implementation. If this |
| annotation is present, the service endpoint interface is used to determine the abstract WSDL contract (portType |
| and bindings). The service endpoint interface MAY include JSR-181 annotations to customize the mapping from |
| Java to WSDL. |
| <br> |
| The service implementation bean MAY implement the service endpoint interface, but is not REQUIRED to do so. |
| <br> |
| If this member-value is not present, the Web Service contract is generated from annotations on the service |
| implementation bean. If a service endpoint interface is required by the target environment, it will be |
| generated into an implementation-defined package with an implementation- defined name |
| <p> |
| <i>This member-value is not allowed on endpoint interfaces.</i></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the complete name of the service endpoint interface</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/jws/WebResult.html" title="annotation in jakarta.jws"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/jws/WebService.html" target="_top">Frames</a></li> |
| <li><a href="WebService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |