Google Git
Sign in
apache / axis-site / ba8ff4839a48cf69d0eeaa99c7510eeb785896c0 / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / jaxws / framework / JAXWSServiceBuilderExtension.html
blob: 42f4db93a29ffebd832b154b793a2440c6d04b3a [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>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>JAXWSServiceBuilderExtension (Apache Axis2)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JAXWSServiceBuilderExtension (Apache Axis2)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/JAXWSServiceBuilderExtension.html">Use</a></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="../../../../../org/apache/axis2/jaxws/framework/JAXWSDeployerSupport.html" title="class in org.apache.axis2.jaxws.framework"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/jaxws/framework/JAXWSServiceBuilderExtension.html" target="_top">Frames</a></li>
<li><a href="JAXWSServiceBuilderExtension.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</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">org.apache.axis2.jaxws.framework</div>
<h2 title="Class JAXWSServiceBuilderExtension" class="title">Class JAXWSServiceBuilderExtension</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/axis2/deployment/AbstractServiceBuilderExtension.html" title="class in org.apache.axis2.deployment">org.apache.axis2.deployment.AbstractServiceBuilderExtension</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.jaxws.framework.JAXWSServiceBuilderExtension</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/axis2/deployment/ServiceBuilderExtension.html" title="interface in org.apache.axis2.deployment">ServiceBuilderExtension</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">JAXWSServiceBuilderExtension</span>
extends <a href="../../../../../org/apache/axis2/deployment/AbstractServiceBuilderExtension.html" title="class in org.apache.axis2.deployment">AbstractServiceBuilderExtension</a></pre>
<div class="block"><p>
The Class JAXWSServiceBuilderExtension is an implementation of
org.apache.axis2.deployment.ServiceBuilderExtension interface and facilitate
to deploy JAX-WS artifacts through other Deployers.
</p>
<p>
As an example it is possible to use JAXWSServiceBuilderExtension class to add
JAX-WS support for service.xml meta file based service deployment. First,
JAXWSServiceBuilderExtension create initial AxisService and ServiceDeployer
add further configuration based of provided service.xml meta data file.
Annotated call may load from embedded archive (AAR), a exploded directory or
from Classpath.
</p>
<p>
It is expected to define only JAXWSMessageReceiver as MessageReceivers in the
service.xml file
</p>
<p>
Example :
</p>
<pre>
<code>&lt;messageReceivers&gt;
&lt;messageReceiver mep="http://www.w3.org/ns/wsdl/in-only" class="org.apache.axis2.jaxws.server.JAXWSMessageReceiver"/&gt;
&lt;messageReceiver mep="http://www.w3.org/ns/wsdl/in-out" class="org.apache.axis2.jaxws.server.JAXWSMessageReceiver"/&gt;
&lt;/messageReceivers&gt;
</code>
</pre></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.7.0</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/axis2/jaxws/framework/JAXWSServiceBuilderExtension.html#JAXWSServiceBuilderExtension()">JAXWSServiceBuilderExtension</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/axis2/description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/framework/JAXWSServiceBuilderExtension.html#buildAxisServices(org.apache.axis2.deployment.repository.util.DeploymentFileData)">buildAxisServices</a></strong>(<a href="../../../../../org/apache/axis2/deployment/repository/util/DeploymentFileData.html" title="class in org.apache.axis2.deployment.repository.util">DeploymentFileData</a>&nbsp;deploymentFileData)</code>
<div class="block">Builds the AxisService.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/framework/JAXWSServiceBuilderExtension.html#checkPreconditions(java.lang.Object)">checkPreconditions</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;metaData)</code>
<div class="block">This method check whether all the defined <messageReceiver> are type of
JAXWSMessageReceiver.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.axis2.deployment.AbstractServiceBuilderExtension">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axis2.deployment.<a href="../../../../../org/apache/axis2/deployment/AbstractServiceBuilderExtension.html" title="class in org.apache.axis2.deployment">AbstractServiceBuilderExtension</a></h3>
<code><a href="../../../../../org/apache/axis2/deployment/AbstractServiceBuilderExtension.html#getAxisConfiguration()">getAxisConfiguration</a>, <a href="../../../../../org/apache/axis2/deployment/AbstractServiceBuilderExtension.html#getConfigurationContext()">getConfigurationContext</a>, <a href="../../../../../org/apache/axis2/deployment/AbstractServiceBuilderExtension.html#getDirectory()">getDirectory</a>, <a href="../../../../../org/apache/axis2/deployment/AbstractServiceBuilderExtension.html#init(org.apache.axis2.context.ConfigurationContext)">init</a>, <a href="../../../../../org/apache/axis2/deployment/AbstractServiceBuilderExtension.html#setDirectory(java.lang.String)">setDirectory</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JAXWSServiceBuilderExtension()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JAXWSServiceBuilderExtension</h4>
<pre>public&nbsp;JAXWSServiceBuilderExtension()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="buildAxisServices(org.apache.axis2.deployment.repository.util.DeploymentFileData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildAxisServices</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/axis2/description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a>&gt;&nbsp;buildAxisServices(<a href="../../../../../org/apache/axis2/deployment/repository/util/DeploymentFileData.html" title="class in org.apache.axis2.deployment.repository.util">DeploymentFileData</a>&nbsp;deploymentFileData)
throws <a href="../../../../../org/apache/axis2/deployment/DeploymentException.html" title="class in org.apache.axis2.deployment">DeploymentException</a></pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/axis2/deployment/ServiceBuilderExtension.html#buildAxisServices(org.apache.axis2.deployment.repository.util.DeploymentFileData)">ServiceBuilderExtension</a></code></strong></div>
<div class="block">Builds the AxisService.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>deploymentFileData</code> - the deployment file data *</dd>
<dt><span class="strong">Returns:</span></dt><dd>the map of AxisService instances.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/axis2/deployment/DeploymentException.html" title="class in org.apache.axis2.deployment">DeploymentException</a></code> - the deployment exception</dd></dl>
</li>
</ul>
<a name="checkPreconditions(java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>checkPreconditions</h4>
<pre>protected&nbsp;boolean&nbsp;checkPreconditions(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;metaData)</pre>
<div class="block">This method check whether all the defined <messageReceiver> are type of
JAXWSMessageReceiver. Return true only if all the <messageReceiver>
elements satisfy above condition.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>metaData</code> - the meta data</dd>
<dt><span class="strong">Returns:</span></dt><dd>true, if successful</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/JAXWSServiceBuilderExtension.html">Use</a></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="../../../../../org/apache/axis2/jaxws/framework/JAXWSDeployerSupport.html" title="class in org.apache.axis2.jaxws.framework"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/jaxws/framework/JAXWSServiceBuilderExtension.html" target="_top">Frames</a></li>
<li><a href="JAXWSServiceBuilderExtension.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>