blob: d8664b8401fcbddb577d7f3d40766ffd3f7fb917 [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>javax.xml.registry</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="javax.xml.registry";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/bind/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../javax/xml/registry/infomodel/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/registry/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;javax.xml.registry</h1>
<div class="docSummary">
<div class="block">
This package and its sub-packages describe the API classes and interfaces
for the JAXR API.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/BulkResponse.html" title="interface in javax.xml.registry">BulkResponse</a></td>
<td class="colLast">
<div class="block">Contains the response of a method in the API that performs a bulk
operation and returns a bulk response.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/xml/registry/BusinessLifeCycleManager.html" title="interface in javax.xml.registry">BusinessLifeCycleManager</a></td>
<td class="colLast">
<div class="block">The BusinessLifeCycleManager interface, which is exposed by the Registry Service, implements the
life cycle management functionality of the Registry as part of a business level API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/BusinessQueryManager.html" title="interface in javax.xml.registry">BusinessQueryManager</a></td>
<td class="colLast">
<div class="block">The BusinessQueryManager interface, which is exposed by the Registry Service, implements the business style query interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/xml/registry/CapabilityProfile.html" title="interface in javax.xml.registry">CapabilityProfile</a></td>
<td class="colLast">
<div class="block">Provides information about the capabilities of a JAXR provider.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/Connection.html" title="interface in javax.xml.registry">Connection</a></td>
<td class="colLast">
<div class="block">This class represents a connection between a JAXR client and a
JAXR provider.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/xml/registry/DeclarativeQueryManager.html" title="interface in javax.xml.registry">DeclarativeQueryManager</a></td>
<td class="colLast">
<div class="block">This interface provides the ability to execute declarative queries (e.g.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/FederatedConnection.html" title="interface in javax.xml.registry">FederatedConnection</a></td>
<td class="colLast">
<div class="block">Represents a single logical connection to a federation or group of
registry providers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/xml/registry/FindQualifier.html" title="interface in javax.xml.registry">FindQualifier</a></td>
<td class="colLast">
<div class="block">FindQualifier provides various constants
that identify options that effect find method behavior.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/JAXRResponse.html" title="interface in javax.xml.registry">JAXRResponse</a></td>
<td class="colLast">
<div class="block">A JAXR requests' response.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/xml/registry/LifeCycleManager.html" title="interface in javax.xml.registry">LifeCycleManager</a></td>
<td class="colLast">
<div class="block">The LifeCycleManager interface is the main interface in the API for managing life cycle
operations on objects defined by the information model.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/Query.html" title="interface in javax.xml.registry">Query</a></td>
<td class="colLast">
<div class="block">The Query interface encapsulates a query in a declarative query language.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/xml/registry/QueryManager.html" title="interface in javax.xml.registry">QueryManager</a></td>
<td class="colLast">
<div class="block">This is the common base interface for all QueryManagers in the API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/RegistryService.html" title="interface in javax.xml.registry">RegistryService</a></td>
<td class="colLast">
<div class="block">This is the principal interface implemented by a JAXR provider.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/ConnectionFactory.html" title="class in javax.xml.registry">ConnectionFactory</a></td>
<td class="colLast">
<div class="block">This is the abstract base class for factory classes for creating a JAXR connection.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/DeleteException.html" title="class in javax.xml.registry">DeleteException</a></td>
<td class="colLast">
<div class="block">A RegistryException that occurs during a delete action.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/xml/registry/FindException.html" title="class in javax.xml.registry">FindException</a></td>
<td class="colLast">
<div class="block">A RegistryException that occurs during a find action.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/InvalidRequestException.html" title="class in javax.xml.registry">InvalidRequestException</a></td>
<td class="colLast">
<div class="block">This exception is thrown when a JAXR client attempts to invoke an API method
that is not valid for some reason.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></td>
<td class="colLast">
<div class="block">Signals that a JAXR exception has occurred.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/RegistryException.html" title="class in javax.xml.registry">RegistryException</a></td>
<td class="colLast">
<div class="block">This is the common base class for all Exceptions that are detected on the registry
provider side rather than the JAXR client side.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/xml/registry/SaveException.html" title="class in javax.xml.registry">SaveException</a></td>
<td class="colLast">
<div class="block">A RegistryException that occurs during a save action.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/xml/registry/UnexpectedObjectException.html" title="class in javax.xml.registry">UnexpectedObjectException</a></td>
<td class="colLast">
<div class="block">This exception is thrown when the JAXR provider finds a Object that is
out-of-place or of the wrong type within the context of a user request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/xml/registry/UnsupportedCapabilityException.html" title="class in javax.xml.registry">UnsupportedCapabilityException</a></td>
<td class="colLast">
<div class="block">This exception must be thrown when a JAXR client attempts to invoke an API method
that is not supported by the capability profile that is supported by the
JAXR provider.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package javax.xml.registry Description">Package javax.xml.registry Description</h2>
<div class="block"><P>
This package and its sub-packages describe the API classes and interfaces
for the JAXR API. In this package are the high-level interfaces and classes
that a client uses to interact with a registry via a JAXR provider.
</p>
<p>Figure 1 shows the primary interfaces in the JAXR API.</p>
<p>
<center><img SRC="../../../resources/images/apiClasses.gif" ALT="Primary Interfaces in the JAXR API">
<br><b>Figure 1. Primary Interfaces in the JAXR API</b>
</center>
</p>
<p>Figure 2 shows the response and exception classes in the JAXR API.</p>
<p>
<center><img SRC="../../../resources/images/responsesAndException.gif" ALT="Response and Exception Classes in the JAXR API">
<br><b>Figure 2. Response and Exception Classes in the JAXR API</b>
</center>
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</dd>
</dl>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/bind/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../javax/xml/registry/infomodel/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/registry/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>