blob: d064fff221bf4c1b14a747ace7b1f32ecba3c259 [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>DefaultConfiguration (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="DefaultConfiguration (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/DefaultConfiguration.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/BasicServerConfig.html" title="class in org.apache.axis.configuration"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis/configuration/DefaultEngineConfigurationFactory.html" title="class in org.apache.axis.configuration"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis/configuration/DefaultConfiguration.html" target="_top">Frames</a></li>
<li><a href="DefaultConfiguration.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.axis.configuration</div>
<h2 title="Class DefaultConfiguration" class="title">Class DefaultConfiguration</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>org.apache.axis.configuration.DefaultConfiguration</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">DefaultConfiguration</span>
extends <a href="../../../../org/apache/axis/configuration/DelegatingWSDDEngineConfiguration.html" title="class in org.apache.axis.configuration">DelegatingWSDDEngineConfiguration</a></pre>
<div class="block">Configuration provider that loads the default Axis configuration. It first loads the
<tt>org/apache/axis/&lt;type>/&lt;type>-config.wsdd</tt> resource and then searches for resources
with name <tt>META-INF/axis/default-&lt;type>-config.wsdd</tt>. All the discovered WSDD documents
are merged into a single configuration. <tt>&lt;type></tt> identifies the engine type for which
the configuration is to be built; it is either <tt>client</tt> or <tt>server</tt>.
<p>
This class looks up the resources using the thread context class loader, except if it determines
that the context class loader is not set correctly, in which case it falls back to the class
loader that loaded the <a href="../../../../org/apache/axis/configuration/DefaultConfiguration.html" title="class in org.apache.axis.configuration"><code>DefaultConfiguration</code></a> class. To determine if the context class
loader is set correctly, the code checks that the <a href="../../../../org/apache/axis/configuration/DefaultConfiguration.html" title="class in org.apache.axis.configuration"><code>DefaultConfiguration</code></a> class is visible
to the context class loader.
<p>
The algorithm implemented by this class is designed to support the modularized artifacts
introduced in Axis 1.4.1. It allows individual JARs to contribute items (transports, handlers,
etc.) to the default configuration. The naming convention for the base configuration file
(<tt>org/apache/axis/&lt;type>/&lt;type>-config.wsdd</tt>) was chosen for consistency with Axis
1.4, while <tt>META-INF/axis/default-&lt;type>-config.wsdd</tt> is new in Axis 1.4.1.
<p>
<a href="../../../../org/apache/axis/configuration/DefaultConfiguration.html" title="class in org.apache.axis.configuration"><code>DefaultConfiguration</code></a> is also used by <a href="../../../../org/apache/axis/configuration/FileProvider.html" title="class in org.apache.axis.configuration"><code>FileProvider</code></a> to build the configuration if
no existing configuration file is found.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Andreas Veithen</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.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/DefaultConfiguration.html#DefaultConfiguration(java.lang.String)">DefaultConfiguration</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;type)</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/DefaultConfiguration.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><a href="../../../../org/apache/axis/deployment/wsdd/WSDDDeployment.html" title="class in org.apache.axis.deployment.wsdd">WSDDDeployment</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/configuration/DefaultConfiguration.html#getDeployment()">getDeployment</a></strong>()</code>
<div class="block">Get the WSDDDeployment for this engine configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/configuration/DefaultConfiguration.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">Read the configuration from an engine, and store it somehow.</div>
</td>
</tr>
</table>
<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="DefaultConfiguration(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultConfiguration</h4>
<pre>public&nbsp;DefaultConfiguration(<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;type)</pre>
<div class="block">Constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the engine type to load the default configuration for; this should be
<code>client</code> or <code>server</code> (although any value is supported)</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="configureEngine(org.apache.axis.AxisEngine)">
<!-- -->
</a>
<ul class="blockList">
<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><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>
<a name="getDeployment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeployment</h4>
<pre>public&nbsp;<a href="../../../../org/apache/axis/deployment/wsdd/WSDDDeployment.html" title="class in org.apache.axis.deployment.wsdd">WSDDDeployment</a>&nbsp;getDeployment()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/axis/WSDDEngineConfiguration.html#getDeployment()">WSDDEngineConfiguration</a></code></strong></div>
<div class="block">Get the WSDDDeployment for this engine configuration.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the WSDDDeployment</dd></dl>
</li>
</ul>
<a name="writeEngineConfig(org.apache.axis.AxisEngine)">
<!-- -->
</a>
<ul class="blockListLast">
<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 interface:&nbsp;<code><a href="../../../../org/apache/axis/EngineConfiguration.html#writeEngineConfig(org.apache.axis.AxisEngine)">EngineConfiguration</a></code></strong></div>
<div class="block">Read the configuration from an engine, and store it somehow.</div>
<dl><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>
</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/DefaultConfiguration.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/BasicServerConfig.html" title="class in org.apache.axis.configuration"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis/configuration/DefaultEngineConfigurationFactory.html" title="class in org.apache.axis.configuration"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis/configuration/DefaultConfiguration.html" target="_top">Frames</a></li>
<li><a href="DefaultConfiguration.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 © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>