blob: 8f5faf4847ea631fdaf64b63dd16a1f83ff92c59 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>jakarta.xml.ws</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="jakarta.xml.ws";
}
}
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 class="navBarCell1Rev">Package</li>
<li>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/xml/soap/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../jakarta/xml/ws/handler/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/xml/ws/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;jakarta.xml.ws</h1>
<div class="docSummary">
<div class="block">This package contains the core Jakarta XML Web Services APIs.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/AsyncHandler.html" title="interface in jakarta.xml.ws">AsyncHandler</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">The <code>AsyncHandler</code> interface is implemented by
clients that wish to receive callback notification of the completion of
service endpoint operations invoked asynchronously.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/Binding.html" title="interface in jakarta.xml.ws">Binding</a></td>
<td class="colLast">
<div class="block">The <code>Binding</code> interface is the base interface
for JAX-WS protocol bindings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/BindingProvider.html" title="interface in jakarta.xml.ws">BindingProvider</a></td>
<td class="colLast">
<div class="block">The <code>BindingProvider</code> interface provides access to the
protocol binding and associated context objects for request and
response message processing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/Dispatch.html" title="interface in jakarta.xml.ws">Dispatch</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">The <code>Dispatch</code> interface provides support
for the dynamic invocation of a service endpoint operations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/LogicalMessage.html" title="interface in jakarta.xml.ws">LogicalMessage</a></td>
<td class="colLast">
<div class="block">The <code>LogicalMessage</code> interface represents a
protocol agnostic XML message and contains methods that
provide access to the payload of the message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/Provider.html" title="interface in jakarta.xml.ws">Provider</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Service endpoints may implement the <code>Provider</code>
interface as a dynamic alternative to an SEI.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/Response.html" title="interface in jakarta.xml.ws">Response</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">The <code>Response</code> interface provides methods used to obtain the
payload and context of a message sent in response to an operation
invocation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/WebServiceContext.html" title="interface in jakarta.xml.ws">WebServiceContext</a></td>
<td class="colLast">
<div class="block">A <code>WebServiceContext</code> makes it possible for
a web service endpoint implementation class to access
message context and security information relative to
a request being served.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/Endpoint.html" title="class in jakarta.xml.ws">Endpoint</a></td>
<td class="colLast">
<div class="block">A Web service endpoint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/EndpointContext.html" title="class in jakarta.xml.ws">EndpointContext</a></td>
<td class="colLast">
<div class="block"><code>EndpointContext</code> allows multiple endpoints in an application
to share any information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/EndpointReference.html" title="class in jakarta.xml.ws">EndpointReference</a></td>
<td class="colLast">
<div class="block">This class represents an WS-Addressing EndpointReference
which is a remote reference to a web service endpoint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/Holder.html" title="class in jakarta.xml.ws">Holder</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Holds a value of type <code>T</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/RespectBindingFeature.html" title="class in jakarta.xml.ws">RespectBindingFeature</a></td>
<td class="colLast">
<div class="block">This feature clarifies the use of the <code>wsdl:binding</code>
in a JAX-WS runtime.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/Service.html" title="class in jakarta.xml.ws">Service</a></td>
<td class="colLast">
<div class="block"><code>Service</code> objects provide the client view of a Web service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/WebServiceFeature.html" title="class in jakarta.xml.ws">WebServiceFeature</a></td>
<td class="colLast">
<div class="block">A WebServiceFeature is used to represent a feature that can be
enabled or disabled for a web service.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/WebServicePermission.html" title="class in jakarta.xml.ws">WebServicePermission</a></td>
<td class="colLast">
<div class="block">This class defines web service permissions.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/Service.Mode.html" title="enum in jakarta.xml.ws">Service.Mode</a></td>
<td class="colLast">
<div class="block">The orientation of a dynamic client or service.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/ProtocolException.html" title="class in jakarta.xml.ws">ProtocolException</a></td>
<td class="colLast">
<div class="block">The <code>ProtocolException</code> class is a
base class for exceptions related to a specific protocol binding.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/WebServiceException.html" title="class in jakarta.xml.ws">WebServiceException</a></td>
<td class="colLast">
<div class="block">The <code>WebServiceException</code> class is the base
exception class for all JAX-WS API runtime exceptions.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/Action.html" title="annotation in jakarta.xml.ws">Action</a></td>
<td class="colLast">
<div class="block">The <code>Action</code> annotation allows explicit association of a
WS-Addressing <code>Action</code> message addressing property with
<code>input</code>, <code>output</code>, and
<code>fault</code> messages of the mapped WSDL operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/BindingType.html" title="annotation in jakarta.xml.ws">BindingType</a></td>
<td class="colLast">
<div class="block">The <code>BindingType</code> annotation is used to
specify the binding to use for a web service
endpoint implementation class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/FaultAction.html" title="annotation in jakarta.xml.ws">FaultAction</a></td>
<td class="colLast">
<div class="block">The <code>FaultAction</code> annotation is used inside an <a href="../../../jakarta/xml/ws/Action.html" title="annotation in jakarta.xml.ws"><code>Action</code></a>
annotation to allow an explicit association of a WS-Addressing
<code>Action</code> message addressing property with the <code>fault</code>
messages of the WSDL operation mapped from the exception class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/RequestWrapper.html" title="annotation in jakarta.xml.ws">RequestWrapper</a></td>
<td class="colLast">
<div class="block">Used to annotate methods in the Service Endpoint Interface with the request
wrapper bean to be used at runtime.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/RespectBinding.html" title="annotation in jakarta.xml.ws">RespectBinding</a></td>
<td class="colLast">
<div class="block">This feature clarifies the use of the <code>wsdl:binding</code>
in a JAX-WS runtime.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/ResponseWrapper.html" title="annotation in jakarta.xml.ws">ResponseWrapper</a></td>
<td class="colLast">
<div class="block">Used to annotate methods in the Service Endpoint Interface with the response
wrapper bean to be used at runtime.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/ServiceMode.html" title="annotation in jakarta.xml.ws">ServiceMode</a></td>
<td class="colLast">
<div class="block">Used to indicate whether a <a href="../../../jakarta/xml/ws/Provider.html" title="interface in jakarta.xml.ws"><code>Provider</code></a> implementation wishes to work
with entire protocol messages or just with protocol message payloads.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/WebEndpoint.html" title="annotation in jakarta.xml.ws">WebEndpoint</a></td>
<td class="colLast">
<div class="block">Used to annotate the <code>get<em>PortName</em>()</code>
methods of a generated service interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/WebFault.html" title="annotation in jakarta.xml.ws">WebFault</a></td>
<td class="colLast">
<div class="block">Used to annotate service specific exception classes to customize
to the local and namespace name of the fault element and the name
of the fault bean.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/WebServiceClient.html" title="annotation in jakarta.xml.ws">WebServiceClient</a></td>
<td class="colLast">
<div class="block">Used to annotate a generated service interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/WebServiceProvider.html" title="annotation in jakarta.xml.ws">WebServiceProvider</a></td>
<td class="colLast">
<div class="block">Used to annotate a Provider implementation class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/WebServiceRef.html" title="annotation in jakarta.xml.ws">WebServiceRef</a></td>
<td class="colLast">
<div class="block">The <code>WebServiceRef</code> annotation is used to
define a reference to a web service and
(optionally) an injection target for it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../jakarta/xml/ws/WebServiceRefs.html" title="annotation in jakarta.xml.ws">WebServiceRefs</a></td>
<td class="colLast">
<div class="block">The <code>WebServiceRefs</code> annotation allows
multiple web service references to be declared at the
class level.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package jakarta.xml.ws Description">Package jakarta.xml.ws Description</h2>
<div class="block">This package contains the core Jakarta XML Web Services APIs.
<p>
References in this document to JAX-WS refer to the Jakarta XML Web Services unless otherwise noted.<br>
References in this document to SAAJ refer to the Jakarta SOAP with Attachments unless otherwise noted.<br>
References in this document to JAXB refer to the Jakarta XML Binding unless otherwise noted.<br>
References in this document to JWS refer to the Jakarta Web Services Metadata unless otherwise noted.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/xml/soap/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../jakarta/xml/ws/handler/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/xml/ws/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>