blob: e3c827e941e1d177c2a449fb8e5fd8e9c6c5d56c [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>BaseAxisDataLocator (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="BaseAxisDataLocator (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/BaseAxisDataLocator.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/dataretrieval/AxisDataLocatorImpl.html" title="class in org.apache.axis2.dataretrieval"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis2/dataretrieval/Data.html" title="class in org.apache.axis2.dataretrieval"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/dataretrieval/BaseAxisDataLocator.html" target="_top">Frames</a></li>
<li><a href="BaseAxisDataLocator.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.dataretrieval</div>
<h2 title="Class BaseAxisDataLocator" class="title">Class BaseAxisDataLocator</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>org.apache.axis2.dataretrieval.BaseAxisDataLocator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/axis2/dataretrieval/PolicyDataLocator.html" title="class in org.apache.axis2.dataretrieval">PolicyDataLocator</a>, <a href="../../../../org/apache/axis2/dataretrieval/SchemaDataLocator.html" title="class in org.apache.axis2.dataretrieval">SchemaDataLocator</a>, <a href="../../../../org/apache/axis2/dataretrieval/WSDLDataLocator.html" title="class in org.apache.axis2.dataretrieval">WSDLDataLocator</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">BaseAxisDataLocator</span>
extends <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></pre>
<div class="block">BaseAxisDataLocator implements common code and serves as a base class
for the supported default Axis2 dialect data locators.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/axis2/dataretrieval/ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/dataretrieval/BaseAxisDataLocator.html#dataList">dataList</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/dataretrieval/BaseAxisDataLocator.html#BaseAxisDataLocator()">BaseAxisDataLocator</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="../../../../org/apache/axis2/dataretrieval/Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/dataretrieval/BaseAxisDataLocator.html#getData(org.apache.axis2.dataretrieval.DataRetrievalRequest, org.apache.axis2.context.MessageContext)">getData</a></strong>(<a href="../../../../org/apache/axis2/dataretrieval/DataRetrievalRequest.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalRequest</a>&nbsp;request,
<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code>
<div class="block">The default Axis2 Data locator getData API
Checks data information configured in ServiceData.xml for the supported
output forms: inline, url, EndpointReference.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/axis2/dataretrieval/OutputForm.html" title="class in org.apache.axis2.dataretrieval">OutputForm</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/dataretrieval/BaseAxisDataLocator.html#getOutputForm()">getOutputForm</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/axis2/dataretrieval/Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/dataretrieval/BaseAxisDataLocator.html#outputInlineForm(org.apache.axis2.context.MessageContext, org.apache.axis2.dataretrieval.ServiceData[])">outputInlineForm</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext,
<a href="../../../../org/apache/axis2/dataretrieval/ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;serviceData)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/axis2/dataretrieval/Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/dataretrieval/BaseAxisDataLocator.html#outputLocationForm(org.apache.axis2.dataretrieval.ServiceData[])">outputLocationForm</a></strong>(<a href="../../../../org/apache/axis2/dataretrieval/ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;serviceData)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/axis2/dataretrieval/Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/dataretrieval/BaseAxisDataLocator.html#outputReferenceForm(org.apache.axis2.context.MessageContext, org.apache.axis2.dataretrieval.ServiceData[])">outputReferenceForm</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext,
<a href="../../../../org/apache/axis2/dataretrieval/ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;serviceData)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/dataretrieval/BaseAxisDataLocator.html#setServiceData(org.apache.axis2.dataretrieval.ServiceData[])">setServiceData</a></strong>(<a href="../../../../org/apache/axis2/dataretrieval/ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;inServiceData)</code>&nbsp;</td>
</tr>
</table>
<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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="dataList">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>dataList</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/axis2/dataretrieval/ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[] dataList</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BaseAxisDataLocator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseAxisDataLocator</h4>
<pre>public&nbsp;BaseAxisDataLocator()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getData(org.apache.axis2.dataretrieval.DataRetrievalRequest, org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getData</h4>
<pre>public&nbsp;<a href="../../../../org/apache/axis2/dataretrieval/Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]&nbsp;getData(<a href="../../../../org/apache/axis2/dataretrieval/DataRetrievalRequest.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalRequest</a>&nbsp;request,
<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
throws <a href="../../../../org/apache/axis2/dataretrieval/DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></pre>
<div class="block">The default Axis2 Data locator getData API
Checks data information configured in ServiceData.xml for the supported
output forms: inline, url, EndpointReference.
<p/>
Note: Subclass that has its implementation of outInlineForm, outputLocationForm,
and outputReferenceForm logic must implement the getData API.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/dataretrieval/DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></code></dd></dl>
</li>
</ul>
<a name="outputInlineForm(org.apache.axis2.context.MessageContext, org.apache.axis2.dataretrieval.ServiceData[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputInlineForm</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/axis2/dataretrieval/Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]&nbsp;outputInlineForm(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext,
<a href="../../../../org/apache/axis2/dataretrieval/ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;serviceData)
throws <a href="../../../../org/apache/axis2/dataretrieval/DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/dataretrieval/DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></code></dd></dl>
</li>
</ul>
<a name="outputLocationForm(org.apache.axis2.dataretrieval.ServiceData[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputLocationForm</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/axis2/dataretrieval/Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]&nbsp;outputLocationForm(<a href="../../../../org/apache/axis2/dataretrieval/ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;serviceData)
throws <a href="../../../../org/apache/axis2/dataretrieval/DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/dataretrieval/DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></code></dd></dl>
</li>
</ul>
<a name="outputReferenceForm(org.apache.axis2.context.MessageContext, org.apache.axis2.dataretrieval.ServiceData[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputReferenceForm</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/axis2/dataretrieval/Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]&nbsp;outputReferenceForm(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext,
<a href="../../../../org/apache/axis2/dataretrieval/ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;serviceData)
throws <a href="../../../../org/apache/axis2/dataretrieval/DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/dataretrieval/DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></code></dd></dl>
</li>
</ul>
<a name="setServiceData(org.apache.axis2.dataretrieval.ServiceData[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServiceData</h4>
<pre>protected&nbsp;void&nbsp;setServiceData(<a href="../../../../org/apache/axis2/dataretrieval/ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;inServiceData)</pre>
</li>
</ul>
<a name="getOutputForm()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOutputForm</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/axis2/dataretrieval/OutputForm.html" title="class in org.apache.axis2.dataretrieval">OutputForm</a>&nbsp;getOutputForm()</pre>
</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/BaseAxisDataLocator.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/dataretrieval/AxisDataLocatorImpl.html" title="class in org.apache.axis2.dataretrieval"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis2/dataretrieval/Data.html" title="class in org.apache.axis2.dataretrieval"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/dataretrieval/BaseAxisDataLocator.html" target="_top">Frames</a></li>
<li><a href="BaseAxisDataLocator.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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>