Google Git
Sign in
apache / juddi / refs/heads/asf-site / . / apidocs / org / apache / juddi / v3 / client / config / UDDIClient.html
blob: 8fb43767b916c5cd38432093aa6131e339c990c9 [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>
<!-- Generated by javadoc (1.8.0_101) on Mon Sep 19 16:59:27 EDT 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UDDIClient (jUDDI_v3 Parent 3.3.11-SNAPSHOT API)</title>
<meta name="date" content="2022-09-19">
<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="UDDIClient (jUDDI_v3 Parent 3.3.11-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":10,"i4":42,"i5":10,"i6":10,"i7":10,"i8":10,"i9":42,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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="class-use/UDDIClient.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/juddi/v3/client/config/UDDIClerkServlet.html" title="class in org.apache.juddi.v3.client.config"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClientContainer.html" title="class in org.apache.juddi.v3.client.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/juddi/v3/client/config/UDDIClient.html" target="_top">Frames</a></li>
<li><a href="UDDIClient.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">org.apache.juddi.v3.client.config</div>
<h2 title="Class UDDIClient" class="title">Class UDDIClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/6/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.juddi.v3.client.config.UDDIClient</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">UDDIClient</span>
extends <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><p>
The UDDIClient is the main entry point for using the jUDDI client. The
UDDICLient provides a simple way to get interact with a UDDI registry using
the UDDI v3 API.</p>
<h3>Note:</h3>
<p>
It is also possible to use the Java API for XML Registries (JAXR). Apache
Scout is an implementation of this API that can be configured to -behind the
scenes- use the jUDDI Client code to access either UDDIv2 or UDDIv3 registry.
The advantage of using JAXR is that your code can be configured to interact
with any XML Registry (such as UDDI or ebXML). The downside is that JAXR has
not evolved beyond the 1.0 release and is tightly coupled to the ebXML data
structures, which being mapped to the UDDI data structures. For more
information on JAXR see the Apache Scout project, which is a sub project of
Apache jUDDI. If programmatic acess to a UDDIv3 registry is what you want, we
recommend using the UDDIv3 API with the UDDIClient.</p>
<p>
The UDDIClient uses a XML formatted configuration file, which by default is
loaded from the classpath from location META-INF/uddi.xml.</p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>kstam</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#UDDIClient--">UDDIClient</a></span>()</code>
<div class="block">Default constructor, loads from the default config, META-INF/uddi.xml</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#UDDIClient-java.lang.String-">UDDIClient</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configurationFile)</code>
<div class="block">Manages the clerks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#UDDIClient-java.lang.String-java.util.Properties-">UDDIClient</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configurationFile,
<a href="https://docs.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;properties)</code>
<div class="block">Manages the clerks.</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="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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>static <a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#addRESTtModels-org.uddi.api_v3.BindingTemplate-">addRESTtModels</a></span>(<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;bt)</code>
<div class="block">adds the typical REST tmodel references, but only if they aren't
already present</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#addSOAPtModels-org.uddi.api_v3.BindingTemplate-">addSOAPtModels</a></span>(<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;bt)</code>
<div class="block">adds the typical SOAP tmodel references, but only if they aren't
already present</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#clearServiceLocatorCaches--">clearServiceLocatorCaches</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClerk.html" title="class in org.apache.juddi.v3.client.config">UDDIClerk</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#getClerk-java.lang.String-">getClerk</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;clerkName)</code>
<div class="block">Gets the UDDI Clerk, the entry point into many functions of the juddi
client</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#getClientCallbackUrl--">getClientCallbackUrl</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use SubscriptionCallbackListener</span></div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/juddi/v3/client/config/ClientConfig.html" title="class in org.apache.juddi.v3.client.config">ClientConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#getClientConfig--">getClientConfig</a></span>()</code>
<div class="block">Returns a live instance of the raw configuration file</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#getName--">getName</a></span>()</code>
<div class="block">returns getClientConfig().getClientName()</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/juddi/v3/client/mapping/ServiceLocator.html" title="class in org.apache.juddi.v3.client.mapping">ServiceLocator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#getServiceLocator--">getServiceLocator</a></span>()</code>
<div class="block">Uses the client config, and looks for a clerk called "default"</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/juddi/v3/client/mapping/ServiceLocator.html" title="class in org.apache.juddi.v3.client.mapping">ServiceLocator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#getServiceLocator-java.lang.String-">getServiceLocator</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;clerkName)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/juddi/v3/client/transport/Transport.html" title="class in org.apache.juddi.v3.client.transport">Transport</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#getTransport--">getTransport</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use the getTransport(String nodeName) instead. Returns
the "default" jUDDI nodes Transport. Note: this will always return a
new instance of Transport</span></div>
</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/juddi/v3/client/transport/Transport.html" title="class in org.apache.juddi.v3.client.transport">Transport</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#getTransport-java.lang.String-">getTransport</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeName)</code>
<div class="block">Returns the transport defined for the node with the given nodeName.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#registerAnnotatedServices--">registerAnnotatedServices</a></span>()</code>
<div class="block">Registers services to UDDI using a clerk, and the uddi.xml
configuration.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#registerWSDLs--">registerWSDLs</a></span>()</code>
<div class="block">Registers services to UDDI using a clerk, and the uddi.xml
configuration.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#restart--">restart</a></span>()</code>
<div class="block">calls stop and start again</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#saveClerkAndNodeInfo--">saveClerkAndNodeInfo</a></span>()</code>
<div class="block">Saves the clerk and node info from the uddi.xml to the home jUDDI
registry.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#start--">start</a></span>()</code>
<div class="block">Initializes the UDDI Clerk.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#startEmbeddedServer--">startEmbeddedServer</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#stop--">stop</a></span>()</code>
<div class="block">Stops the clerks.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#stopEmbeddedServer--">stopEmbeddedServer</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#unRegisterAnnotatedServices--">unRegisterAnnotatedServices</a></span>()</code>
<div class="block">Removes the service and all of its bindingTemplates of the annotated
classes.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#unRegisterBindingsOfAnnotatedServices-boolean-">unRegisterBindingsOfAnnotatedServices</a></span>(boolean&nbsp;removeServiceWithNoBindingTemplates)</code>
<div class="block">Removes the bindings of the services in the annotated classes.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#unRegisterWSDLs--">unRegisterWSDLs</a></span>()</code>
<div class="block">unregisters all config defined wsdls</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html#xRegister--">xRegister</a></span>()</code>
<div class="block">X-Register services listed in the uddi.xml</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.<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="UDDIClient--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UDDIClient</h4>
<pre>public&nbsp;UDDIClient()
throws org.apache.commons.configuration.ConfigurationException</pre>
<div class="block">Default constructor, loads from the default config, META-INF/uddi.xml</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="UDDIClient-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UDDIClient</h4>
<pre>public&nbsp;UDDIClient(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configurationFile)
throws org.apache.commons.configuration.ConfigurationException</pre>
<div class="block">Manages the clerks. Initiates reading the client configuration from
the uddi.xml.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="UDDIClient-java.lang.String-java.util.Properties-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UDDIClient</h4>
<pre>public&nbsp;UDDIClient(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configurationFile,
<a href="https://docs.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;properties)
throws org.apache.commons.configuration.ConfigurationException</pre>
<div class="block">Manages the clerks. Initiates reading the client configuration from
the uddi.xml.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configurationFile</code> - </dd>
<dd><code>properties</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></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="clearServiceLocatorCaches--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearServiceLocatorCaches</h4>
<pre>public static&nbsp;void&nbsp;clearServiceLocatorCaches()</pre>
</li>
</ul>
<a name="getServiceLocator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServiceLocator</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/juddi/v3/client/mapping/ServiceLocator.html" title="class in org.apache.juddi.v3.client.mapping">ServiceLocator</a>&nbsp;getServiceLocator()
throws org.apache.commons.configuration.ConfigurationException</pre>
<div class="block">Uses the client config, and looks for a clerk called "default"</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>returns getServiceLocator(null);</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="getServiceLocator-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServiceLocator</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/juddi/v3/client/mapping/ServiceLocator.html" title="class in org.apache.juddi.v3.client.mapping">ServiceLocator</a>&nbsp;getServiceLocator(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;clerkName)
throws org.apache.commons.configuration.ConfigurationException</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clerkName</code> - - if null defaults to "default"</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a serviceLocator object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public&nbsp;void&nbsp;stop()
throws org.apache.commons.configuration.ConfigurationException</pre>
<div class="block">Stops the clerks. If transport is InVM, all database resources are
released. If anything was auto registered, it will be removed prior
to shutdown</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public&nbsp;void&nbsp;start()
throws org.apache.commons.configuration.ConfigurationException</pre>
<div class="block">Initializes the UDDI Clerk. If transport is set to InVM, this will
initialize all database connections, other it will trigger all
background registration threads</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="startEmbeddedServer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startEmbeddedServer</h4>
<pre>protected&nbsp;void&nbsp;startEmbeddedServer()
throws org.apache.commons.configuration.ConfigurationException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="stopEmbeddedServer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopEmbeddedServer</h4>
<pre>protected&nbsp;void&nbsp;stopEmbeddedServer()
throws org.apache.commons.configuration.ConfigurationException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="restart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restart</h4>
<pre>public&nbsp;void&nbsp;restart()
throws org.apache.commons.configuration.ConfigurationException</pre>
<div class="block">calls stop and start again</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="saveClerkAndNodeInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveClerkAndNodeInfo</h4>
<pre>public&nbsp;void&nbsp;saveClerkAndNodeInfo()</pre>
<div class="block">Saves the clerk and node info from the uddi.xml to the home jUDDI
registry. This info is needed if you want to JUDDI Server to do
XRegistration/"replication".</div>
</li>
</ul>
<a name="xRegister--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>xRegister</h4>
<pre>public&nbsp;void&nbsp;xRegister()</pre>
<div class="block">X-Register services listed in the uddi.xml</div>
</li>
</ul>
<a name="registerAnnotatedServices--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerAnnotatedServices</h4>
<pre>public&nbsp;void&nbsp;registerAnnotatedServices()</pre>
<div class="block">Registers services to UDDI using a clerk, and the uddi.xml
configuration.</div>
</li>
</ul>
<a name="unRegisterAnnotatedServices--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unRegisterAnnotatedServices</h4>
<pre>public&nbsp;void&nbsp;unRegisterAnnotatedServices()</pre>
<div class="block">Removes the service and all of its bindingTemplates of the annotated
classes.</div>
</li>
</ul>
<a name="unRegisterBindingsOfAnnotatedServices-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unRegisterBindingsOfAnnotatedServices</h4>
<pre>public&nbsp;void&nbsp;unRegisterBindingsOfAnnotatedServices(boolean&nbsp;removeServiceWithNoBindingTemplates)</pre>
<div class="block">Removes the bindings of the services in the annotated classes.
Multiple nodes may register the same service using different
BindingTempates. If the last BindingTemplate is removed the service
can be removed as well.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>removeServiceWithNoBindingTemplates</code> - - if set to true it will
remove the service if there are no other BindingTemplates.</dd>
</dl>
</li>
</ul>
<a name="getClientConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientConfig</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/juddi/v3/client/config/ClientConfig.html" title="class in org.apache.juddi.v3.client.config">ClientConfig</a>&nbsp;getClientConfig()</pre>
<div class="block">Returns a live instance of the raw configuration file</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the client config loaded from file</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">returns getClientConfig().getClientName()</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>getClientConfig().getClientName()</dd>
</dl>
</li>
</ul>
<a name="getClientCallbackUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientCallbackUrl</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getClientCallbackUrl()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use SubscriptionCallbackListener</span></div>
<div class="block">maps to config file client[@callbackUrl] Not currently used</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>client[@callbackUrl]</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html" title="class in org.apache.juddi.v3.client.subscription"><code>SubscriptionCallbackListener</code></a></dd>
</dl>
</li>
</ul>
<a name="getTransport--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransport</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/juddi/v3/client/transport/Transport.html" title="class in org.apache.juddi.v3.client.transport">Transport</a>&nbsp;getTransport()
throws org.apache.commons.configuration.ConfigurationException</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use the getTransport(String nodeName) instead. Returns
the "default" jUDDI nodes Transport. Note: this will always return a
new instance of Transport</span></div>
<div class="block">Returns the transport defined for the node with the given name
"default". deprecated, use the getTransport(String nodeName) instead.
Returns the "default" jUDDI nodes Transport.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a transport object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="getTransport-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransport</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/juddi/v3/client/transport/Transport.html" title="class in org.apache.juddi.v3.client.transport">Transport</a>&nbsp;getTransport(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeName)
throws org.apache.commons.configuration.ConfigurationException</pre>
<div class="block">Returns the transport defined for the node with the given nodeName.
Note: this will always return a new instance of Transport</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeName</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a transport object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<a name="getClerk-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClerk</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClerk.html" title="class in org.apache.juddi.v3.client.config">UDDIClerk</a>&nbsp;getClerk(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;clerkName)</pre>
<div class="block">Gets the UDDI Clerk, the entry point into many functions of the juddi
client</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clerkName</code> - - This references the uddi/client/clerk@name of the
juddi client config file. it stores credentials if necessary and
associates it with a particular UDDI node (server/cluster) If not
specified, the value of "default" will be used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A clerk instance if the clerk is defined in the config file
or NULL if not found</dd>
</dl>
</li>
</ul>
<a name="registerWSDLs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerWSDLs</h4>
<pre>public&nbsp;void&nbsp;registerWSDLs()</pre>
<div class="block">Registers services to UDDI using a clerk, and the uddi.xml
configuration.</div>
</li>
</ul>
<a name="unRegisterWSDLs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unRegisterWSDLs</h4>
<pre>public&nbsp;void&nbsp;unRegisterWSDLs()</pre>
<div class="block">unregisters all config defined wsdls</div>
</li>
</ul>
<a name="addSOAPtModels-org.uddi.api_v3.BindingTemplate-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSOAPtModels</h4>
<pre>public static&nbsp;<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;addSOAPtModels(<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;bt)</pre>
<div class="block">adds the typical SOAP tmodel references, but only if they aren't
already present</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bt</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a modified instance of the source binding template</dd>
</dl>
</li>
</ul>
<a name="addRESTtModels-org.uddi.api_v3.BindingTemplate-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addRESTtModels</h4>
<pre>public static&nbsp;<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;addRESTtModels(<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;bt)</pre>
<div class="block">adds the typical REST tmodel references, but only if they aren't
already present</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bt</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a modified instance of the source binding template</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="class-use/UDDIClient.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/juddi/v3/client/config/UDDIClerkServlet.html" title="class in org.apache.juddi.v3.client.config"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClientContainer.html" title="class in org.apache.juddi.v3.client.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/juddi/v3/client/config/UDDIClient.html" target="_top">Frames</a></li>
<li><a href="UDDIClient.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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>