Google Git
Sign in
apache / tomee-site-pub / 294f8729efbe13f29a64f7a60a72b67641434a45 / . / tomee-8.0 / javadoc / javax / xml / rpc / ServiceFactory.html
blob: 4d0db748c2011600e4310b75df0d8b546fb6440e [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>ServiceFactory</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="ServiceFactory";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/xml/rpc/Stub.html" title="interface in javax.xml.rpc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/rpc/ServiceFactory.html" target="_top">Frames</a></li>
<li><a href="ServiceFactory.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><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">javax.xml.rpc</div>
<h2 title="Class ServiceFactory" class="title">Class ServiceFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>javax.xml.rpc.ServiceFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ServiceFactory</span>
extends java.lang.Object</pre>
<div class="block">The <code>javax.xml.rpc.ServiceFactory</code> is an abstract class
that provides a factory for the creation of instances of the type
<code>javax.xml.rpc.Service</code>. This abstract class follows the
abstract static factory design pattern. This enables a J2SE based
client to create a <code>Service instance</code> in a portable manner
without using the constructor of the <code>Service</code>
implementation class.
<p>The ServiceFactory implementation class is set using the
system property <code>SERVICEFACTORY_PROPERTY</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc"><code>Service</code></a></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>
<table class="memberSummary" 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>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/rpc/ServiceFactory.html#SERVICEFACTORY_PROPERTY">SERVICEFACTORY_PROPERTY</a></span></code>
<div class="block">A constant representing the property used to lookup the
name of a <code>ServiceFactory</code> implementation
class.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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="../../../javax/xml/rpc/ServiceFactory.html#ServiceFactory--">ServiceFactory</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>abstract <a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc">Service</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/rpc/ServiceFactory.html#createService-javax.xml.namespace.QName-">createService</a></span>(javax.xml.namespace.QName&nbsp;serviceName)</code>
<div class="block">Create a <code>Service</code> instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc">Service</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/rpc/ServiceFactory.html#createService-java.net.URL-javax.xml.namespace.QName-">createService</a></span>(java.net.URL&nbsp;wsdlDocumentLocation,
javax.xml.namespace.QName&nbsp;serviceName)</code>
<div class="block">Create a <code>Service</code> instance.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc">Service</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/rpc/ServiceFactory.html#loadService-java.lang.Class-">loadService</a></span>(java.lang.Class&nbsp;serviceInterface)</code>
<div class="block">Create an instance of the generated service implementation class
for a given service interface, if available.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc">Service</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/rpc/ServiceFactory.html#loadService-java.net.URL-java.lang.Class-java.util.Properties-">loadService</a></span>(java.net.URL&nbsp;wsdlDocumentLocation,
java.lang.Class&nbsp;serviceInterface,
java.util.Properties&nbsp;properties)</code>
<div class="block">Create an instance of the generated service implementation class
for a given service interface, if available.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc">Service</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/rpc/ServiceFactory.html#loadService-java.net.URL-javax.xml.namespace.QName-java.util.Properties-">loadService</a></span>(java.net.URL&nbsp;wsdlDocumentLocation,
javax.xml.namespace.QName&nbsp;serviceName,
java.util.Properties&nbsp;properties)</code>
<div class="block">Create an instance of the generated service implementation
class for a given service, if available.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../javax/xml/rpc/ServiceFactory.html" title="class in javax.xml.rpc">ServiceFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/rpc/ServiceFactory.html#newInstance--">newInstance</a></span>()</code>
<div class="block">Gets an instance of the <code>ServiceFactory</code></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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="SERVICEFACTORY_PROPERTY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SERVICEFACTORY_PROPERTY</h4>
<pre>public static final&nbsp;java.lang.String SERVICEFACTORY_PROPERTY</pre>
<div class="block">A constant representing the property used to lookup the
name of a <code>ServiceFactory</code> implementation
class.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#javax.xml.rpc.ServiceFactory.SERVICEFACTORY_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ServiceFactory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServiceFactory</h4>
<pre>protected&nbsp;ServiceFactory()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newInstance</h4>
<pre>public static&nbsp;<a href="../../../javax/xml/rpc/ServiceFactory.html" title="class in javax.xml.rpc">ServiceFactory</a>&nbsp;newInstance()
throws <a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></pre>
<div class="block">Gets an instance of the <code>ServiceFactory</code>
<p>Only one copy of a factory exists and is returned to the
application each time this method is called.
<p> The implementation class to be used can be overridden by
setting the javax.xml.rpc.ServiceFactory system property.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="createService-java.net.URL-javax.xml.namespace.QName-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createService</h4>
<pre>public abstract&nbsp;<a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc">Service</a>&nbsp;createService(java.net.URL&nbsp;wsdlDocumentLocation,
javax.xml.namespace.QName&nbsp;serviceName)
throws <a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></pre>
<div class="block">Create a <code>Service</code> instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wsdlDocumentLocation</code> - URL for the WSDL document location
for the service</dd>
<dd><code>serviceName</code> - QName for the service</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></code> - If any error in creation of the
specified service</dd>
</dl>
</li>
</ul>
<a name="createService-javax.xml.namespace.QName-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createService</h4>
<pre>public abstract&nbsp;<a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc">Service</a>&nbsp;createService(javax.xml.namespace.QName&nbsp;serviceName)
throws <a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></pre>
<div class="block">Create a <code>Service</code> instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serviceName</code> - QName for the service</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></code> - If any error in creation of the
specified service</dd>
</dl>
</li>
</ul>
<a name="loadService-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadService</h4>
<pre>public abstract&nbsp;<a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc">Service</a>&nbsp;loadService(java.lang.Class&nbsp;serviceInterface)
throws <a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></pre>
<div class="block">Create an instance of the generated service implementation class
for a given service interface, if available.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serviceInterface</code> - Service interface</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></code> - If there is any error while creating the
specified service, including the case where
a generated service implementation class cannot
be located</dd>
</dl>
</li>
</ul>
<a name="loadService-java.net.URL-java.lang.Class-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadService</h4>
<pre>public abstract&nbsp;<a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc">Service</a>&nbsp;loadService(java.net.URL&nbsp;wsdlDocumentLocation,
java.lang.Class&nbsp;serviceInterface,
java.util.Properties&nbsp;properties)
throws <a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></pre>
<div class="block">Create an instance of the generated service implementation class
for a given service interface, if available.
An implementation may use the provided <code>wsdlDocumentLocation</code>
and <code>properties</code> to help locate the generated implementation
class. If no such class is present, a <code>ServiceException</code>
will be thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wsdlDocumentLocation</code> - URL for the WSDL document location
for the service or null</dd>
<dd><code>serviceInterface</code> - Service interface</dd>
<dd><code>properties</code> - A set of implementation-specific properties
to help locate the generated service
implementation class</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></code> - If there is any error while creating the
specified service, including the case where
a generated service implementation class cannot
be located</dd>
</dl>
</li>
</ul>
<a name="loadService-java.net.URL-javax.xml.namespace.QName-java.util.Properties-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadService</h4>
<pre>public abstract&nbsp;<a href="../../../javax/xml/rpc/Service.html" title="interface in javax.xml.rpc">Service</a>&nbsp;loadService(java.net.URL&nbsp;wsdlDocumentLocation,
javax.xml.namespace.QName&nbsp;serviceName,
java.util.Properties&nbsp;properties)
throws <a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></pre>
<div class="block">Create an instance of the generated service implementation
class for a given service, if available.
The service is uniquely identified by the <code>wsdlDocumentLocation</code>
and <code>serviceName</code> arguments.
An implementation may use the provided <code>properties</code> to help
locate the generated implementation class. If no such class is present,
a <code>ServiceException</code> will be thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wsdlDocumentLocation</code> - URL for the WSDL document location
for the service or null</dd>
<dd><code>serviceName</code> - Qualified name for the service</dd>
<dd><code>properties</code> - A set of implementation-specific properties
to help locate the generated service
implementation class</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</a></code> - If there is any error while creating the
specified service, including the case where
a generated service implementation class cannot
be located</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="../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/xml/rpc/Stub.html" title="interface in javax.xml.rpc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/rpc/ServiceFactory.html" target="_top">Frames</a></li>
<li><a href="ServiceFactory.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><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 ======= -->
</body>
</html>