blob: 3b6c22b31e988cd9877afd2d9861ce26109f5c40 [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>XMLStringProvider (Apache Axis)</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="XMLStringProvider (Apache Axis)";
}
//-->
</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/XMLStringProvider.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/axis/configuration/SimpleProvider.html" title="class in org.apache.axis.configuration"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis/configuration/XMLStringProvider.html" target="_top">Frames</a></li>
<li><a href="XMLStringProvider.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="#fields_inherited_from_class_org.apache.axis.configuration.FileProvider">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>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.axis.configuration</div>
<h2 title="Class XMLStringProvider" class="title">Class XMLStringProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.4.2/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/axis/configuration/DelegatingWSDDEngineConfiguration.html" title="class in org.apache.axis.configuration">org.apache.axis.configuration.DelegatingWSDDEngineConfiguration</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/axis/configuration/FileProvider.html" title="class in org.apache.axis.configuration">org.apache.axis.configuration.FileProvider</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis.configuration.XMLStringProvider</li>
</ul>
</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/axis/EngineConfiguration.html" title="interface in org.apache.axis">EngineConfiguration</a>, <a href="../../../../org/apache/axis/WSDDEngineConfiguration.html" title="interface in org.apache.axis">WSDDEngineConfiguration</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">XMLStringProvider</span>
extends <a href="../../../../org/apache/axis/configuration/FileProvider.html" title="class in org.apache.axis.configuration">FileProvider</a></pre>
<div class="block">A simple ConfigurationProvider that uses the Admin class to
configure the engine from a String containing XML.
This provider does not write configuration to persistent storage.
Example of usage:
new XMLStringProvider("<engineConfig><handlers><handler name=" +
"\"MsgDispatcher\" class=\"org.apache.axis.providers.java" +
".MsgProvider\"/></handlers><services><service name=\"Adm" +
"inService\" pivot=\"MsgDispatcher\"><option name=\"class" +
"Name\" value=\"org.apache.axis.utils.Admin\"/><option na" +
"me=\"allowedMethods\" value=\"AdminService\"/><option na" +
"me=\"enableRemoteAdmin\" value=\"false\"/></service></se" +
"rvices></engineConfig>");</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Glen Daniels (gdaniels@apache.org)</dd></dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.axis.configuration.FileProvider">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.axis.configuration.<a href="../../../../org/apache/axis/configuration/FileProvider.html" title="class in org.apache.axis.configuration">FileProvider</a></h3>
<code><a href="../../../../org/apache/axis/configuration/FileProvider.html#log">log</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.axis.EngineConfiguration">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.axis.<a href="../../../../org/apache/axis/EngineConfiguration.html" title="interface in org.apache.axis">EngineConfiguration</a></h3>
<code><a href="../../../../org/apache/axis/EngineConfiguration.html#PROPERTY_NAME">PROPERTY_NAME</a></code></li>
</ul>
</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/axis/configuration/XMLStringProvider.html#XMLStringProvider(java.lang.String)">XMLStringProvider</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;xmlConfiguration)</code>
<div class="block">Constructor</div>
</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/configuration/XMLStringProvider.html#configureEngine(org.apache.axis.AxisEngine)">configureEngine</a></strong>(<a href="../../../../org/apache/axis/AxisEngine.html" title="class in org.apache.axis">AxisEngine</a>&nbsp;engine)</code>
<div class="block">Configure this AxisEngine using whatever data source we have.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/configuration/XMLStringProvider.html#writeEngineConfig(org.apache.axis.AxisEngine)">writeEngineConfig</a></strong>(<a href="../../../../org/apache/axis/AxisEngine.html" title="class in org.apache.axis">AxisEngine</a>&nbsp;engine)</code>
<div class="block">Save the engine configuration.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.axis.configuration.FileProvider">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axis.configuration.<a href="../../../../org/apache/axis/configuration/FileProvider.html" title="class in org.apache.axis.configuration">FileProvider</a></h3>
<code><a href="../../../../org/apache/axis/configuration/FileProvider.html#getDeployment()">getDeployment</a>, <a href="../../../../org/apache/axis/configuration/FileProvider.html#setDeployment(org.apache.axis.deployment.wsdd.WSDDDeployment)">setDeployment</a>, <a href="../../../../org/apache/axis/configuration/FileProvider.html#setInputStream(java.io.InputStream)">setInputStream</a>, <a href="../../../../org/apache/axis/configuration/FileProvider.html#setSearchClasspath(boolean)">setSearchClasspath</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.axis.configuration.DelegatingWSDDEngineConfiguration">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axis.configuration.<a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html" title="class in org.apache.axis.configuration">DelegatingWSDDEngineConfiguration</a></h3>
<code><a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html#getDeployedServices()">getDeployedServices</a>, <a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html#getGlobalOptions()">getGlobalOptions</a>, <a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html#getGlobalRequest()">getGlobalRequest</a>, <a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html#getGlobalResponse()">getGlobalResponse</a>, <a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html#getHandler(javax.xml.namespace.QName)">getHandler</a>, <a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html#getRoles()">getRoles</a>, <a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html#getService(javax.xml.namespace.QName)">getService</a>, <a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html#getServiceByNamespaceURI(java.lang.String)">getServiceByNamespaceURI</a>, <a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html#getTransport(javax.xml.namespace.QName)">getTransport</a>, <a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html#getTypeMappingRegistry()">getTypeMappingRegistry</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.4.2/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.4.2/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.4.2/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.4.2/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.4.2/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.4.2/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.4.2/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.4.2/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.4.2/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.4.2/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.4.2/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.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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="XMLStringProvider(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XMLStringProvider</h4>
<pre>public&nbsp;XMLStringProvider(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;xmlConfiguration)</pre>
<div class="block">Constructor</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlConfiguration</code> - a String containing an engine configuration
in XML.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="writeEngineConfig(org.apache.axis.AxisEngine)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeEngineConfig</h4>
<pre>public&nbsp;void&nbsp;writeEngineConfig(<a href="../../../../org/apache/axis/AxisEngine.html" title="class in org.apache.axis">AxisEngine</a>&nbsp;engine)
throws <a href="../../../../org/apache/axis/ConfigurationException.html" title="class in org.apache.axis">ConfigurationException</a></pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/axis/configuration/FileProvider.html#writeEngineConfig(org.apache.axis.AxisEngine)">FileProvider</a></code></strong></div>
<div class="block">Save the engine configuration. In case there's a problem, we
write it to a string before saving it out to the actual file so
we don't screw up the file.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/axis/EngineConfiguration.html#writeEngineConfig(org.apache.axis.AxisEngine)">writeEngineConfig</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/axis/EngineConfiguration.html" title="interface in org.apache.axis">EngineConfiguration</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/axis/configuration/FileProvider.html#writeEngineConfig(org.apache.axis.AxisEngine)">writeEngineConfig</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/axis/configuration/FileProvider.html" title="class in org.apache.axis.configuration">FileProvider</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>engine</code> - the AxisEngine from which to read state.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis/ConfigurationException.html" title="class in org.apache.axis">ConfigurationException</a></code> - if there was a problem</dd></dl>
</li>
</ul>
<a name="configureEngine(org.apache.axis.AxisEngine)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>configureEngine</h4>
<pre>public&nbsp;void&nbsp;configureEngine(<a href="../../../../org/apache/axis/AxisEngine.html" title="class in org.apache.axis">AxisEngine</a>&nbsp;engine)
throws <a href="../../../../org/apache/axis/ConfigurationException.html" title="class in org.apache.axis">ConfigurationException</a></pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/axis/EngineConfiguration.html#configureEngine(org.apache.axis.AxisEngine)">EngineConfiguration</a></code></strong></div>
<div class="block">Configure this AxisEngine using whatever data source we have.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/axis/EngineConfiguration.html#configureEngine(org.apache.axis.AxisEngine)">configureEngine</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/axis/EngineConfiguration.html" title="interface in org.apache.axis">EngineConfiguration</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/axis/configuration/FileProvider.html#configureEngine(org.apache.axis.AxisEngine)">configureEngine</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/axis/configuration/FileProvider.html" title="class in org.apache.axis.configuration">FileProvider</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>engine</code> - the AxisEngine we'll deploy state to</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis/ConfigurationException.html" title="class in org.apache.axis">ConfigurationException</a></code> - if there was a problem</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/XMLStringProvider.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/axis/configuration/SimpleProvider.html" title="class in org.apache.axis.configuration"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis/configuration/XMLStringProvider.html" target="_top">Frames</a></li>
<li><a href="XMLStringProvider.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="#fields_inherited_from_class_org.apache.axis.configuration.FileProvider">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>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 © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>