blob: 8cf793e1a0e553cfde5709577e1f1a6cdc360ac7 [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>SAAJMetaFactory</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="SAAJMetaFactory";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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/Node.html" title="interface in jakarta.xml.soap"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/xml/soap/SAAJResult.html" title="class in jakarta.xml.soap"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/xml/soap/SAAJMetaFactory.html" target="_top">Frames</a></li>
<li><a href="SAAJMetaFactory.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>
<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">jakarta.xml.soap</div>
<h2 title="Class SAAJMetaFactory" class="title">Class SAAJMetaFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jakarta.xml.soap.SAAJMetaFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">SAAJMetaFactory</span>
extends java.lang.Object</pre>
<div class="block">The access point for the implementation classes of the factories defined in the
SAAJ API. The <code>newInstance</code> methods defined on factories <a href="../../../jakarta/xml/soap/SOAPFactory.html" title="class in jakarta.xml.soap"><code>SOAPFactory</code></a> and
<a href="../../../jakarta/xml/soap/MessageFactory.html" title="class in jakarta.xml.soap"><code>MessageFactory</code></a> in SAAJ 1.4 defer to instances of this class to do the actual object creation.
The implementations of <code>newInstance()</code> methods (in <a href="../../../jakarta/xml/soap/SOAPFactory.html" title="class in jakarta.xml.soap"><code>SOAPFactory</code></a> and <a href="../../../jakarta/xml/soap/MessageFactory.html" title="class in jakarta.xml.soap"><code>MessageFactory</code></a>)
that existed in SAAJ 1.2 have been updated to also delegate to the SAAJMetaFactory when the SAAJ 1.2
defined lookup fails to locate the Factory implementation class name.
<p>
SAAJMetaFactory is a service provider interface and it uses similar lookup mechanism as other SAAJ factories
to get actual instance:
<ul>
<li>If a system property with name <code>jakarta.xml.soap.SAAJMetaFactory</code> exists then its value is assumed
to be the fully qualified name of the implementation class. This phase of the look up enables per-JVM
override of the SAAJ implementation.
<li>If a system property with name <code>jakarta.xml.soap.MetaFactory</code> exists then its value is assumed
to be the fully qualified name of the implementation class. This property, defined by previous specifications
(up to 1.3), is still supported, but it is strongly recommended to migrate to new property
<code>jakarta.xml.soap.SAAJMetaFactory</code>.
<li>Use the configuration file "jaxm.properties". The file is in standard <code>Properties</code> format
and typically located in the <code>conf</code> directory of the Java installation. It contains the fully qualified
name of the implementation class with key <code>jakarta.xml.soap.SAAJMetaFactory</code>. If no such property is defined,
again, property with key <code>jakarta.xml.soap.MetaFactory</code> is used. It is strongly recommended to migrate to
new property <code>jakarta.xml.soap.SAAJMetaFactory</code>.
<li> Use the service-provider loading facilities, defined by the <code>ServiceLoader</code> class,
to attempt to locate and load an implementation of the service using the default loading mechanism.
<li> Finally, if all the steps above fail, platform default implementation is used.
</ul>
<p>
There are no public methods on this
class.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6, SAAJ 1.3</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="memberSummary" 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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SAAJMetaFactory.html#SAAJMetaFactory--">SAAJMetaFactory</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected abstract <a href="../../../jakarta/xml/soap/MessageFactory.html" title="class in jakarta.xml.soap">MessageFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SAAJMetaFactory.html#newMessageFactory-java.lang.String-">newMessageFactory</a></span>(java.lang.String&nbsp;protocol)</code>
<div class="block">Creates a <code>MessageFactory</code> object for
the given <code>String</code> protocol.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected abstract <a href="../../../jakarta/xml/soap/SOAPFactory.html" title="class in jakarta.xml.soap">SOAPFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SAAJMetaFactory.html#newSOAPFactory-java.lang.String-">newSOAPFactory</a></span>(java.lang.String&nbsp;protocol)</code>
<div class="block">Creates a <code>SOAPFactory</code> object for
the given <code>String</code> protocol.</div>
</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="SAAJMetaFactory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SAAJMetaFactory</h4>
<pre>protected&nbsp;SAAJMetaFactory()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newMessageFactory-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newMessageFactory</h4>
<pre>protected abstract&nbsp;<a href="../../../jakarta/xml/soap/MessageFactory.html" title="class in jakarta.xml.soap">MessageFactory</a>&nbsp;newMessageFactory(java.lang.String&nbsp;protocol)
throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre>
<div class="block">Creates a <code>MessageFactory</code> object for
the given <code>String</code> protocol.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>protocol</code> - a <code>String</code> indicating the protocol</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../jakarta/xml/soap/MessageFactory.html" title="class in jakarta.xml.soap"><code>MessageFactory</code></a>, not null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in creating the
MessageFactory</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/xml/soap/SOAPConstants.html#SOAP_1_1_PROTOCOL"><code>SOAPConstants.SOAP_1_1_PROTOCOL</code></a>,
<a href="../../../jakarta/xml/soap/SOAPConstants.html#SOAP_1_2_PROTOCOL"><code>SOAPConstants.SOAP_1_2_PROTOCOL</code></a>,
<a href="../../../jakarta/xml/soap/SOAPConstants.html#DYNAMIC_SOAP_PROTOCOL"><code>SOAPConstants.DYNAMIC_SOAP_PROTOCOL</code></a></dd>
</dl>
</li>
</ul>
<a name="newSOAPFactory-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newSOAPFactory</h4>
<pre>protected abstract&nbsp;<a href="../../../jakarta/xml/soap/SOAPFactory.html" title="class in jakarta.xml.soap">SOAPFactory</a>&nbsp;newSOAPFactory(java.lang.String&nbsp;protocol)
throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre>
<div class="block">Creates a <code>SOAPFactory</code> object for
the given <code>String</code> protocol.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>protocol</code> - a <code>String</code> indicating the protocol</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../jakarta/xml/soap/SOAPFactory.html" title="class in jakarta.xml.soap"><code>SOAPFactory</code></a>, not null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in creating the
SOAPFactory</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/xml/soap/SOAPConstants.html#SOAP_1_1_PROTOCOL"><code>SOAPConstants.SOAP_1_1_PROTOCOL</code></a>,
<a href="../../../jakarta/xml/soap/SOAPConstants.html#SOAP_1_2_PROTOCOL"><code>SOAPConstants.SOAP_1_2_PROTOCOL</code></a>,
<a href="../../../jakarta/xml/soap/SOAPConstants.html#DYNAMIC_SOAP_PROTOCOL"><code>SOAPConstants.DYNAMIC_SOAP_PROTOCOL</code></a></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>
<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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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/Node.html" title="interface in jakarta.xml.soap"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/xml/soap/SAAJResult.html" title="class in jakarta.xml.soap"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/xml/soap/SAAJMetaFactory.html" target="_top">Frames</a></li>
<li><a href="SAAJMetaFactory.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>
<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 ======= -->
</body>
</html>