diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/capability | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/capability')
32 files changed, 7397 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/capability/Capability.html b/apidocs/com/amazon/carbonado/capability/Capability.html new file mode 100644 index 0000000..ad1e7db --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/Capability.html @@ -0,0 +1,172 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Capability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Capability (Carbonado 1.2.3 API)"; + } +//--> +</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/Capability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/Capability.html" target="_top">Frames</a></li> +<li><a href="Capability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.capability</div> +<h2 title="Interface Capability" class="title">Interface Capability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CheckpointCapability</a>, <a href="../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability</a>, <a href="../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a>, <a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">GroupAccessCapability</a>, <a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability</a>, <a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessCapability</a>, <a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">IndexInfoCapability</a>, <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a>, <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S>, <a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a>, <a href="../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging">LogAccessCapability</a>, <a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">RemoteProcedureCapability</a>, <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a>, <a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a>, <a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a>, <a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a>, <a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">TriggerManagerCapability</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a>, <a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Capability</span></pre> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#getCapability(java.lang.Class)"><code>Repository.getCapability(java.lang.Class<C>)</code></a></dd></dl> +</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/Capability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/Capability.html" target="_top">Frames</a></li> +<li><a href="Capability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html b/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html new file mode 100644 index 0000000..93d18e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html @@ -0,0 +1,220 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>GroupAccessCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="GroupAccessCapability (Carbonado 1.2.3 API)"; + } +//--> +</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/GroupAccessCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/GroupAccessCapability.html" target="_top">Frames</a></li> +<li><a href="GroupAccessCapability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface GroupAccessCapability" class="title">Interface GroupAccessCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">GroupAccessCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability for gaining access to replication group members.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Vishal Parakh</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html#getGroupMembers()">getGroupMembers</a></strong>()</code> +<div class="block">Return all replication group members, including this repository.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getGroupMembers()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getGroupMembers</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a> getGroupMembers()</pre> +<div class="block">Return all replication group members, including this repository. + Returned instance remains the same unless group membership changes.</div> +</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/GroupAccessCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/GroupAccessCapability.html" target="_top">Frames</a></li> +<li><a href="GroupAccessCapability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/GroupMembers.html b/apidocs/com/amazon/carbonado/capability/GroupMembers.html new file mode 100644 index 0000000..e0b5336 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/GroupMembers.html @@ -0,0 +1,215 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>GroupMembers (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="GroupMembers (Carbonado 1.2.3 API)"; + } +//--> +</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/GroupMembers.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/GroupMembers.html" target="_top">Frames</a></li> +<li><a href="GroupMembers.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface GroupMembers" class="title">Interface GroupMembers</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">GroupMembers</span></pre> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Vishal Parakh, Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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>java.util.SortedMap<java.lang.Object,<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html#getReadWriteMembers()">getReadWriteMembers</a></strong>()</code> +<div class="block">Returns members intended for read and write access.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getReadWriteMembers()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getReadWriteMembers</h4> +<pre>java.util.SortedMap<java.lang.Object,<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> getReadWriteMembers()</pre> +<div class="block">Returns members intended for read and write access. Keys must uniquely + identify group members, must be serializable, and must have appropriate + implementations of the hashCode and equals methods.</div> +</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/GroupMembers.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/GroupMembers.html" target="_top">Frames</a></li> +<li><a href="GroupMembers.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/IndexInfo.html b/apidocs/com/amazon/carbonado/capability/IndexInfo.html new file mode 100644 index 0000000..28f8e06 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/IndexInfo.html @@ -0,0 +1,294 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IndexInfo (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="IndexInfo (Carbonado 1.2.3 API)"; + } +//--> +</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/IndexInfo.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/IndexInfo.html" target="_top">Frames</a></li> +<li><a href="IndexInfo.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface IndexInfo" class="title">Interface IndexInfo</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IndexInfo</span></pre> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>. + + <p>IndexInfo instances are thread-safe and immutable.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of this index, or null if not applicable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> +<div class="block">Returns the directions of all the properties in this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()">getPropertyNames</a></strong>()</code> +<div class="block">Returns the properties in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isClustered()">isClustered</a></strong>()</code> +<div class="block">Returns true if index is clustered, which means it defines the physical + ordering of storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isUnique()">isUnique</a></strong>()</code> +<div class="block">Returns true if index entries are unique.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block">Returns the name of this index, or null if not applicable.</div> +</li> +</ul> +<a name="isUnique()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUnique</h4> +<pre>boolean isUnique()</pre> +<div class="block">Returns true if index entries are unique.</div> +</li> +</ul> +<a name="isClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClustered</h4> +<pre>boolean isClustered()</pre> +<div class="block">Returns true if index is clustered, which means it defines the physical + ordering of storables.</div> +</li> +</ul> +<a name="getPropertyNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyNames</h4> +<pre>java.lang.String[] getPropertyNames()</pre> +<div class="block">Returns the properties in this index. The array might be empty, but it + is never null. The array is a copy, and so it may be safely modified.</div> +</li> +</ul> +<a name="getPropertyDirections()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPropertyDirections</h4> +<pre><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] getPropertyDirections()</pre> +<div class="block">Returns the directions of all the properties in this index. The length + of the array matches the length returned by <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()"><code>getPropertyNames()</code></a>. The array is a copy, and so it may be safely + modified.</div> +</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/IndexInfo.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/IndexInfo.html" target="_top">Frames</a></li> +<li><a href="IndexInfo.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html b/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html new file mode 100644 index 0000000..2e416fe --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html @@ -0,0 +1,225 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IndexInfoCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="IndexInfoCapability (Carbonado 1.2.3 API)"; + } +//--> +</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/IndexInfoCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/IndexInfoCapability.html" target="_top">Frames</a></li> +<li><a href="IndexInfoCapability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface IndexInfoCapability" class="title">Interface IndexInfoCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IndexInfoCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability for getting information about physical indexes for storables.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html#getIndexInfo(java.lang.Class)">getIndexInfo</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns information about the known indexes for the given storable + type.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getIndexInfo(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getIndexInfo</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[] getIndexInfo(java.lang.Class<S> storableType) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns information about the known indexes for the given storable + type. The array might be empty, but it is never null. The array is a + copy, and so it may be safely modified.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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/IndexInfoCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/IndexInfoCapability.html" target="_top">Frames</a></li> +<li><a href="IndexInfoCapability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html new file mode 100644 index 0000000..f4dd965 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html @@ -0,0 +1,383 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RemoteProcedure.Call (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="RemoteProcedure.Call (Carbonado 1.2.3 API)"; + } +//--> +</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/RemoteProcedure.Call.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Call.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Call.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface RemoteProcedure.Call" class="title">Interface RemoteProcedure.Call<R,D></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd><dd><code>D</code> - request data object type</dd></dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">RemoteProcedure.Call<R,D></span></pre> +<div class="block">Client-side call into a remote procedure. To avoid leaking resources, + the finish method must be invoked or all reply data be fully read. If an + exception is thrown by a method defined in this interface, resources are + automatically released.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)"><code>RemoteProcedureCapability.beginCall(com.amazon.carbonado.capability.RemoteProcedure<R, D>)</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#execute()">execute</a></strong>()</code> +<div class="block">Executes the call without expecting a reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#executeAsync()">executeAsync</a></strong>()</code> +<div class="block">Executes the call without expecting a reply.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#fetchReply()">fetchReply</a></strong>()</code> +<div class="block">Executes the call and receive a reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#flush()">flush</a></strong>()</code> +<div class="block">Flushes all the data sent so far.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the call, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#send(D)">send</a></strong>(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a> data)</code> +<div class="block">Send data to the remote procedure.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> cursor)</code> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> iterable)</code> +<div class="block">Send all data from the given iterable to the remote procedure.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="send(java.lang.Object)"> +<!-- --> +</a><a name="send(D)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>send</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> send(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a> data) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send data to the remote procedure.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if data is null</dd> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="sendAll(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendAll</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> sendAll(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> iterable) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send all data from the given iterable to the remote procedure.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if data is null</dd> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="sendAll(com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendAll</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> sendAll(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> cursor) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if data is null</dd> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="reset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> reset() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reset the internal object stream of the call, allowing cached + objects to get freed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="flush()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flush</h4> +<pre>void flush() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Flushes all the data sent so far. Flush is invoked automatically + when call is executed.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="fetchReply()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchReply</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>> fetchReply() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Executes the call and receive a reply. Calling this method does not + block, but methods on the returned Cursor may block waiting for + data.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="execute()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>void execute() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Executes the call without expecting a reply. Method blocks waiting + for procedure to finish.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="executeAsync()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executeAsync</h4> +<pre>void executeAsync() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Executes the call without expecting a reply. Method does not block + waiting for procedure to finish. Asynchronous execution is not + allowed if the current thread is in a transaction. This is because + transaction ownership becomes ambiguous.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed or if + current thread is in a transaction</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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/RemoteProcedure.Call.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Call.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Call.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html new file mode 100644 index 0000000..5f140a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html @@ -0,0 +1,330 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RemoteProcedure.Reply (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="RemoteProcedure.Reply (Carbonado 1.2.3 API)"; + } +//--> +</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/RemoteProcedure.Reply.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Reply.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Reply.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface RemoteProcedure.Reply" class="title">Interface RemoteProcedure.Reply<R></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd></dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">RemoteProcedure.Reply<R></span></pre> +<div class="block">Reply from remote procedure implementation. To avoid leaking resources, + the finish method must always be invoked. If an exception is thrown by a + method defined in this interface, resources are automatically released.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#finish()">finish</a></strong>()</code> +<div class="block">Finish the reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#flush()">flush</a></strong>()</code> +<div class="block">Flushes all the data sent so far.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the reply, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#send(R)">send</a></strong>(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a> data)</code> +<div class="block">Send reply data to the caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> cursor)</code> +<div class="block">Reply with all data from the given cursor to the caller.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> iterable)</code> +<div class="block">Reply with all data from the given iterable to the caller.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="send(java.lang.Object)"> +<!-- --> +</a><a name="send(R)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>send</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> send(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a> data) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send reply data to the caller.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Reply instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply is finished</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="sendAll(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendAll</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> sendAll(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> iterable) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reply with all data from the given iterable to the caller.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Reply instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply is finished</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="sendAll(com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendAll</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> sendAll(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> cursor) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reply with all data from the given cursor to the caller.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Reply instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply is finished</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="reset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> reset() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reset the internal object stream of the reply, allowing cached + objects to get freed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Reply instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply is finished</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="flush()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flush</h4> +<pre>void flush() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Flushes all the data sent so far. Flush is invoked automatically + when reply is finished.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="finish()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>finish</h4> +<pre>void finish() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Finish the reply.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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/RemoteProcedure.Reply.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Reply.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Reply.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html new file mode 100644 index 0000000..04a63b8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html @@ -0,0 +1,288 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RemoteProcedure.Request (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="RemoteProcedure.Request (Carbonado 1.2.3 API)"; + } +//--> +</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/RemoteProcedure.Request.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Request.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Request.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface RemoteProcedure.Request" class="title">Interface RemoteProcedure.Request<R,D></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd><dd><code>D</code> - request data object type</dd></dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">RemoteProcedure.Request<R,D></span></pre> +<div class="block">Request into a remote procedure, as seen by procedure implementation. To + avoid leaking resources, the request or reply object must always be + finished. If an exception is thrown by a method defined in this + interface, resources are automatically released.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#beginReply()">beginReply</a></strong>()</code> +<div class="block">Begin a reply after receiving all data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#finish()">finish</a></strong>()</code> +<div class="block">Reply and immediately finish, without sending any data to caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#receive()">receive</a></strong>()</code> +<div class="block">Receive data from caller.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#receiveInto(java.util.Collection)">receiveInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a>> c)</code> +<div class="block">Receive all remaining data from caller.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="receive()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>receive</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a> receive() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Receive data from caller.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no more data</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="receiveInto(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>receiveInto</h4> +<pre>int receiveInto(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a>> c) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Receive all remaining data from caller.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - collection to receive data</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount received</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="beginReply()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beginReply</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>> beginReply() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Begin a reply after receiving all data. If no data is expected, + reply can be made without calling receive.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply was already begun, or if + request is finished, or if more data must be received</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="finish()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>finish</h4> +<pre>void finish() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reply and immediately finish, without sending any data to caller.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a reply was already begun or if + more data must be received</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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/RemoteProcedure.Request.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Request.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Request.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html new file mode 100644 index 0000000..4b64cbb --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html @@ -0,0 +1,268 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RemoteProcedure (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="RemoteProcedure (Carbonado 1.2.3 API)"; + } +//--> +</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/RemoteProcedure.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.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: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface RemoteProcedure" class="title">Interface RemoteProcedure<R,D></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd><dd><code>D</code> - request data object type</dd></dl> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">RemoteProcedure<R,D></span> +extends java.io.Serializable</pre> +<div class="block">Defines a remote procedure which can be executed by <a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedureCapability</code></a>. Any data within the procedure instance is + serialized to the remote host, and possibly the class definition + too. Execution might have security restrictions applied. + + <p>The RemoteProcedure instance is Serializable, and so any serializable + parameters can be passed with it. Storables and extra data can be sent + through the <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedure.Request</code></a> object. Any data returned by procedure + implementation must be sent through the <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedure.Reply</code></a> object.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></strong></code> +<div class="block">Client-side call into a remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></strong></code> +<div class="block">Reply from remote procedure implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a>></strong></code> +<div class="block">Request into a remote procedure, as seen by procedure implementation.</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"> </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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html#handleRequest(com.amazon.carbonado.Repository, com.amazon.carbonado.capability.RemoteProcedure.Request)">handleRequest</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>> request)</code> +<div class="block">Request handler for remote procedure implementation.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="handleRequest(com.amazon.carbonado.Repository, com.amazon.carbonado.capability.RemoteProcedure.Request)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>handleRequest</h4> +<pre>boolean handleRequest(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>> request) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Request handler for remote procedure implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - repository as seen by host that procedure is running from</dd><dd><code>request</code> - non-null request object</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if request is still active when this method returns; + request must eventually be explicitly finished</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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/RemoteProcedure.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.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: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html new file mode 100644 index 0000000..141e802 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html @@ -0,0 +1,237 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RemoteProcedureCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="RemoteProcedureCapability (Carbonado 1.2.3 API)"; + } +//--> +</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/RemoteProcedureCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedureCapability.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedureCapability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface RemoteProcedureCapability" class="title">Interface RemoteProcedureCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">RemoteProcedureCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability which allows arbitrary code to run on a remote host and access + its repository. The remote procedure might have security restrictions + applied to it. + + <p>Examples:<pre> + RemoteProcedureCapability cap = ... + Cursor<MyRecord> c1 = cap.beginCall(new CustomQuery<MyRecord>(params)).fetchReply(); + ... + + Cursor<InputRecord> c2 = ... + cap.beginCall(new Importer<InputRecord>()).sendAll(c2).finish(); + </pre></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedure</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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><R,D> <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)">beginCall</a></strong>(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D> proc)</code> +<div class="block">Begins a call to execute the given procedure on a remote host.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="beginCall(com.amazon.carbonado.capability.RemoteProcedure)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>beginCall</h4> +<pre><R,D> <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D> beginCall(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D> proc) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Begins a call to execute the given procedure on a remote host. + Execution commences when the Call object is instructed to do so.</div> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd><dd><code>D</code> - request data object type</dd><dt><span class="strong">Parameters:</span></dt><dd><code>proc</code> - procedure to execute</dd> +<dt><span class="strong">Returns:</span></dt><dd>object for defining the call and receiving a reply</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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/RemoteProcedureCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedureCapability.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedureCapability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html b/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html new file mode 100644 index 0000000..b82045d --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html @@ -0,0 +1,561 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ResyncCapability.Listener (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="ResyncCapability.Listener (Carbonado 1.2.3 API)"; + } +//--> +</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/ResyncCapability.Listener.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ResyncCapability.Listener.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.Listener.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: </li> +<li><a href="#nested_classes_inherited_from_class_com.amazon.carbonado.Trigger">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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">com.amazon.carbonado.capability</div> +<h2 title="Class ResyncCapability.Listener" class="title">Class ResyncCapability.Listener<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">com.amazon.carbonado.Trigger</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.capability.ResyncCapability.Listener<S></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">ResyncCapability.Listener<S></span> +extends <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S></pre> +<div class="block">Trigger which is invoked as storables get re-sync'd. Callbacks are + invoked in the scope of the resync transaction. If any unchecked + exception is thrown, the immediate changes are rolled back and the + entire repository resync operation is aborted. + + <p>The listener implementation should return quickly from the callback + methods, to avoid lingering transactions. If the listener is used to + invoke special repair operations, they should be placed into a task + queue. A separate thread can then perform the repairs outside the resync + transaction.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.Trigger"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></h3> +<code><a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</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"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#ResyncCapability.Listener()">ResyncCapability.Listener</a></strong>()</code> </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"> </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="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterDelete(S, java.lang.Object)">afterDelete</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + java.lang.Object state)</code> +<div class="block">Called right after a bogus storable has been successfully deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterInsert(S, java.lang.Object)">afterInsert</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</code> +<div class="block">Called right after a sync'd storable has been successfully inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</code> +<div class="block">Called right after a sync'd storable has been successfully updated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeDelete(S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable)</code> +<div class="block">Called before a bogus storable is to be deleted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeInsert(S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable)</code> +<div class="block">Called before a sync'd storable is to be inserted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeUpdate(S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable)</code> +<div class="block">Called before a sync'd storable is to be updated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeUpdate(S, S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable)</code> +<div class="block">Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#failedDelete(S, java.lang.Object)">failedDelete</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + java.lang.Object state)</code> +<div class="block">Called when a delete operation failed because an exception was + thrown.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#failedInsert(S, java.lang.Object)">failedInsert</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</code> +<div class="block">Called when an insert operation failed because an exception was + thrown.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#failedUpdate(S, java.lang.Object)">failedUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</code> +<div class="block">Called when an update operation failed because an exception was + thrown.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Trigger"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></h3> +<code><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()">abortTry</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#afterLoad(S)">afterLoad</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#afterTryDelete(S, java.lang.Object)">afterTryDelete</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#afterTryInsert(S, java.lang.Object)">afterTryInsert</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)">beforeTryDelete</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)">beforeTryInsert</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)">beforeTryUpdate</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</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 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="ResyncCapability.Listener()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ResyncCapability.Listener</h4> +<pre>public ResyncCapability.Listener()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="beforeInsert(java.lang.Object)"> +<!-- --> +</a><a name="beforeInsert(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeInsert</h4> +<pre>public java.lang.Object beforeInsert(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a sync'd storable is to be inserted. Changes can be + made to the storable at this point, possibly to define independent + properties.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)">beforeInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterInsert or failedInsert method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="afterInsert(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterInsert</h4> +<pre>public void afterInsert(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a sync'd storable has been successfully inserted.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)">afterInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable after being inserted</dd><dd><code>state</code> - object returned by beforeInsert method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="failedInsert(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="failedInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedInsert</h4> +<pre>public void failedInsert(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</pre> +<div class="block">Called when an insert operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedInsert(S, java.lang.Object)">failedInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable which failed to be inserted</dd><dd><code>state</code> - object returned by beforeInsert method, but it may be null</dd></dl> +</li> +</ul> +<a name="beforeUpdate(java.lang.Object)"> +<!-- --> +</a><a name="beforeUpdate(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeUpdate</h4> +<pre>public java.lang.Object beforeUpdate(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a sync'd storable is to be updated. Changes can be + made to the storable at this point, possibly to update independent + properties.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)">beforeUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterUpdate or failedUpdate method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="beforeUpdate(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="beforeUpdate(S, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeUpdate</h4> +<pre>public java.lang.Object beforeUpdate(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states. Changes can be made + to the storable at this point, possibly to update independent + properties. + + <p>The default implementation calls the single argument beforeUpdate + method, only passing the newly sync'd storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>oldStorable</code> - storable prior to being sync'd</dd><dd><code>newStorable</code> - sync'd storable before being updated</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="afterUpdate(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterUpdate</h4> +<pre>public void afterUpdate(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a sync'd storable has been successfully updated.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable after being updated</dd><dd><code>state</code> - optional object returned by beforeUpdate method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="failedUpdate(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="failedUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedUpdate</h4> +<pre>public void failedUpdate(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</pre> +<div class="block">Called when an update operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedUpdate(S, java.lang.Object)">failedUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable which failed to be updated</dd><dd><code>state</code> - object returned by beforeUpdate method, but it may be null</dd></dl> +</li> +</ul> +<a name="beforeDelete(java.lang.Object)"> +<!-- --> +</a><a name="beforeDelete(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeDelete</h4> +<pre>public java.lang.Object beforeDelete(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a bogus storable is to be deleted.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)">beforeDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>oldStorable</code> - bogus storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterDelete or failedDelete method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="afterDelete(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterDelete</h4> +<pre>public void afterDelete(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a bogus storable has been successfully deleted.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)">afterDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>oldStorable</code> - bogus storable after being deleted</dd><dd><code>state</code> - optional object returned by beforeDelete method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="failedDelete(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="failedDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>failedDelete</h4> +<pre>public void failedDelete(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + java.lang.Object state)</pre> +<div class="block">Called when a delete operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedDelete(S, java.lang.Object)">failedDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>oldStorable</code> - bogus storable which failed to be deleted</dd><dd><code>state</code> - object returned by beforeDelete method, but it may be null</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/ResyncCapability.Listener.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ResyncCapability.Listener.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.Listener.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: </li> +<li><a href="#nested_classes_inherited_from_class_com.amazon.carbonado.Trigger">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/ResyncCapability.html b/apidocs/com/amazon/carbonado/capability/ResyncCapability.html new file mode 100644 index 0000000..9233805 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ResyncCapability.html @@ -0,0 +1,300 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ResyncCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="ResyncCapability (Carbonado 1.2.3 API)"; + } +//--> +</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/ResyncCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ResyncCapability.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.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: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface ResyncCapability" class="title">Interface ResyncCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ResyncCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability of replicating repositories for re-synchronizing to the master + repository. A re-sync operation can be used to fill up a fresh replication + repository or to repair inconsistencies.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></strong></code> +<div class="block">Trigger which is invoked as storables get re-sync'd.</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"> </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><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#getMasterRepository()">getMasterRepository</a></strong>()</code> +<div class="block">Returns the immediate master Repository, for manual comparison.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, double, java.lang.String, java.lang.Object...)">resync</a></strong>(java.lang.Class<S> type, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, com.amazon.carbonado.capability.ResyncCapability.Listener, double, java.lang.String, java.lang.Object...)">resync</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><? super S> listener, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="resync(java.lang.Class, double, java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resync</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> void resync(java.lang.Class<S> type, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to re-sync</dd><dd><code>desiredSpeed</code> - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc</dd><dd><code>filter</code> - optional query filter to limit which objects get re-sync'ed</dd><dd><code>filterValues</code> - filter values for optional filter</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="resync(java.lang.Class, com.amazon.carbonado.capability.ResyncCapability.Listener, double, java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resync</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> void resync(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><? super S> listener, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to re-sync</dd><dd><code>listener</code> - optional listener which gets notified as storables are re-sync'd</dd><dd><code>desiredSpeed</code> - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc</dd><dd><code>filter</code> - optional query filter to limit which objects get re-sync'ed</dd><dd><code>filterValues</code> - filter values for optional filter</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getMasterRepository()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMasterRepository</h4> +<pre><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> getMasterRepository()</pre> +<div class="block">Returns the immediate master Repository, for manual comparison. Direct + updates to the master will likely create inconsistencies.</div> +</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/ResyncCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ResyncCapability.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.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: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html b/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html new file mode 100644 index 0000000..278f1da --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html @@ -0,0 +1,277 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ShutdownCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="ShutdownCapability (Carbonado 1.2.3 API)"; + } +//--> +</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/ShutdownCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ShutdownCapability.html" target="_top">Frames</a></li> +<li><a href="ShutdownCapability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface ShutdownCapability" class="title">Interface ShutdownCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ShutdownCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability for repositories that require special attention with the Java + virtual machine exits.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#isAutoShutdownEnabled()">isAutoShutdownEnabled</a></strong>()</code> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#setAutoShutdownEnabled(boolean)">setAutoShutdownEnabled</a></strong>(boolean enabled)</code> +<div class="block">Request to enable or disable the automatic shutdown hook.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#shutdown()">shutdown</a></strong>()</code> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isAutoShutdownEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAutoShutdownEnabled</h4> +<pre>boolean isAutoShutdownEnabled()</pre> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +</li> +</ul> +<a name="setAutoShutdownEnabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoShutdownEnabled</h4> +<pre>void setAutoShutdownEnabled(boolean enabled)</pre> +<div class="block">Request to enable or disable the automatic shutdown hook. Repository may + ignore this request if shutdown is in progress.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.SecurityException</code> - if caller does not have permission</dd></dl> +</li> +</ul> +<a name="shutdown()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>void shutdown()</pre> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down. Calling + close may cause spurious exceptions to be thrown by other threads which + may be interacting with the repository. Shutdown tries to reduce these + exceptions from being thrown by effectively <i>suspending</i> any + threads which continue to interact with this repository. <b>For this + reason, this method should only ever be called during a virtual machine + shutdown.</b> + + <p>Repositories may choose to implement this method by simply calling + close. There is no guarantee that shutdown will reduce exceptions, and + it might not suspend any threads. Also, repositories that require proper + shutdown should automatically register runtime hooks, and so this method + usually doesn't need to be called manually.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.SecurityException</code> - if caller does not have permission</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/ShutdownCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ShutdownCapability.html" target="_top">Frames</a></li> +<li><a href="ShutdownCapability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html b/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html new file mode 100644 index 0000000..2e7263e --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html @@ -0,0 +1,265 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorableInfoCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="StorableInfoCapability (Carbonado 1.2.3 API)"; + } +//--> +</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/StorableInfoCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/StorableInfoCapability.html" target="_top">Frames</a></li> +<li><a href="StorableInfoCapability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface StorableInfoCapability" class="title">Interface StorableInfoCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableInfoCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability that returns information about known storable types in a + repository.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html#getUserStorableTypeNames()">getUserStorableTypeNames</a></strong>()</code> +<div class="block">Returns an array of storable type class names for user-level storables + known to the repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html#isPropertySupported(java.lang.Class, java.lang.String)">isPropertySupported</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + java.lang.String name)</code> +<div class="block">Returns true if the given property exists and is supported.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html#isSupported(java.lang.Class)">isSupported</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns true if the given storable type is supported.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getUserStorableTypeNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserStorableTypeNames</h4> +<pre>java.lang.String[] getUserStorableTypeNames() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns an array of storable type class names for user-level storables + known to the repository. The array might be empty, but it is never + null. The array is a copy, and so it may be safely modified. + <p> + This method returns class names instead of class instances because the + repository may not be able to load the classes.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="isSupported(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSupported</h4> +<pre>boolean isSupported(java.lang.Class<<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</pre> +<div class="block">Returns true if the given storable type is supported.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - storable type to examine</dd></dl> +</li> +</ul> +<a name="isPropertySupported(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isPropertySupported</h4> +<pre>boolean isPropertySupported(java.lang.Class<<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + java.lang.String name)</pre> +<div class="block">Returns true if the given property exists and is supported.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - storable type to examine</dd><dd><code>name</code> - name of property to examine</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/StorableInfoCapability.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/StorableInfoCapability.html" target="_top">Frames</a></li> +<li><a href="StorableInfoCapability.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/Capability.html b/apidocs/com/amazon/carbonado/capability/class-use/Capability.html new file mode 100644 index 0000000..a55397f --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/Capability.html @@ -0,0 +1,478 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.Capability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.Capability (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/Capability.html" target="_top">Frames</a></li> +<li><a href="Capability.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.Capability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.Capability</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with type parameters of type <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><C extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>> <br>C</code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../../com/amazon/carbonado/Repository.html#getCapability(java.lang.Class)">getCapability</a></strong>(java.lang.Class<C> capabilityType)</code> +<div class="block">Requests a specific capability of this Repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">GroupAccessCapability</a></strong></code> +<div class="block">Capability for gaining access to replication group members.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">IndexInfoCapability</a></strong></code> +<div class="block">Capability for getting information about physical indexes for storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">RemoteProcedureCapability</a></strong></code> +<div class="block">Capability which allows arbitrary code to run on a remote host and access + its repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a></strong></code> +<div class="block">Capability of replicating repositories for re-synchronizing to the master + repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></strong></code> +<div class="block">Capability for repositories that require special attention with the Java + virtual machine exits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a></strong></code> +<div class="block">Capability that returns information about known storable types in a + repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></strong></code> +<div class="block">Capability to get layout information on any storable generation.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that implement <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></strong></code> +<div class="block">Factory for obtaining references to storable layouts.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessCapability</a></strong></code> +<div class="block">Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></strong></code> +<div class="block">Capability to directly access the JDBC connection being used by the current + transaction, which is thread-local.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging">LogAccessCapability</a></strong></code> +<div class="block">Provides access to the Log.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CheckpointCapability</a></strong></code> +<div class="block">Capability to control BDB checkpointing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability</a></strong></code> +<div class="block">Capability to compact a BDB database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></strong></code> +<div class="block">Capability to provide direct access to the underlying BDB environment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability</a></strong></code> +<div class="block">Capability for performing a backup of an active BDB environment.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></strong></code> +<div class="block">Capability to use sequences.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">TriggerManagerCapability</a></strong></code> +<div class="block">Provides the capability to get the <a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> from a <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a><Txn></strong></code> +<div class="block">Implements basic functionality required by a core Repository.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with type parameters of type <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><C extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>> <br>C</code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html#getCapability(java.lang.Class)">getCapability</a></strong>(java.lang.Class<C> capabilityType)</code> +<div class="block">Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/Capability.html" target="_top">Frames</a></li> +<li><a href="Capability.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html new file mode 100644 index 0000000..ae015ef --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html @@ -0,0 +1,117 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.GroupAccessCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.GroupAccessCapability (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/GroupAccessCapability.html" target="_top">Frames</a></li> +<li><a href="GroupAccessCapability.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.GroupAccessCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.GroupAccessCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.capability.GroupAccessCapability</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/GroupAccessCapability.html" target="_top">Frames</a></li> +<li><a href="GroupAccessCapability.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html b/apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html new file mode 100644 index 0000000..e329c4f --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html @@ -0,0 +1,161 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.GroupMembers (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.GroupMembers (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/GroupMembers.html" target="_top">Frames</a></li> +<li><a href="GroupMembers.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.GroupMembers" class="title">Uses of Interface<br>com.amazon.carbonado.capability.GroupMembers</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></code></td> +<td class="colLast"><span class="strong">GroupAccessCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/GroupAccessCapability.html#getGroupMembers()">getGroupMembers</a></strong>()</code> +<div class="block">Return all replication group members, including this repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/GroupMembers.html" target="_top">Frames</a></li> +<li><a href="GroupMembers.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html new file mode 100644 index 0000000..08d3155 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html @@ -0,0 +1,266 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.IndexInfo (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.IndexInfo (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/IndexInfo.html" target="_top">Frames</a></li> +<li><a href="IndexInfo.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.IndexInfo" class="title">Uses of Interface<br>com.amazon.carbonado.capability.IndexInfo</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><span class="strong">IndexInfoCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html#getIndexInfo(java.lang.Class)">getIndexInfo</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns information about the known indexes for the given storable + type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(java.lang.Class, com.amazon.carbonado.capability.IndexInfo)">StorableIndex</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> type, + <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> indexInfo)</code> +<div class="block">Creates a StorableIndex from an IndexInfo.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><span class="strong">JDBCStorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getIndexInfo()">getIndexInfo</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></strong></code> +<div class="block">Basic implementation of an <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfo</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/IndexInfo.html" target="_top">Frames</a></li> +<li><a href="IndexInfo.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html new file mode 100644 index 0000000..e461469 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html @@ -0,0 +1,117 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.IndexInfoCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.IndexInfoCapability (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/IndexInfoCapability.html" target="_top">Frames</a></li> +<li><a href="IndexInfoCapability.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.IndexInfoCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.IndexInfoCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.capability.IndexInfoCapability</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/IndexInfoCapability.html" target="_top">Frames</a></li> +<li><a href="IndexInfoCapability.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html new file mode 100644 index 0000000..f245205 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html @@ -0,0 +1,186 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Call (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Call (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Call.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Call" class="title">Uses of Interface<br>com.amazon.carbonado.capability.RemoteProcedure.Call</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><R,D> <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D></code></td> +<td class="colLast"><span class="strong">RemoteProcedureCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)">beginCall</a></strong>(<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D> proc)</code> +<div class="block">Begins a call to execute the given procedure on a remote host.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the call, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#send(D)">send</a></strong>(<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a> data)</code> +<div class="block">Send data to the remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> cursor)</code> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> iterable)</code> +<div class="block">Send all data from the given iterable to the remote procedure.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Call.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html new file mode 100644 index 0000000..10f2da8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html @@ -0,0 +1,186 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Reply (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Reply (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Reply.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Reply" class="title">Uses of Interface<br>com.amazon.carbonado.capability.RemoteProcedure.Reply</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Request.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#beginReply()">beginReply</a></strong>()</code> +<div class="block">Begin a reply after receiving all data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the reply, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#send(R)">send</a></strong>(<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a> data)</code> +<div class="block">Send reply data to the caller.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> cursor)</code> +<div class="block">Reply with all data from the given cursor to the caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> iterable)</code> +<div class="block">Reply with all data from the given iterable to the caller.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Reply.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html new file mode 100644 index 0000000..f26f2b6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html @@ -0,0 +1,162 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Request (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Request (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Request.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Request" class="title">Uses of Interface<br>com.amazon.carbonado.capability.RemoteProcedure.Request</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> with parameters of type <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html#handleRequest(com.amazon.carbonado.Repository, com.amazon.carbonado.capability.RemoteProcedure.Request)">handleRequest</a></strong>(<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>> request)</code> +<div class="block">Request handler for remote procedure implementation.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Request.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html new file mode 100644 index 0000000..a9831e7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html @@ -0,0 +1,161 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.RemoteProcedure (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure" class="title">Uses of Interface<br>com.amazon.carbonado.capability.RemoteProcedure</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> with parameters of type <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><R,D> <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D></code></td> +<td class="colLast"><span class="strong">RemoteProcedureCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)">beginCall</a></strong>(<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D> proc)</code> +<div class="block">Begins a call to execute the given procedure on a remote host.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html new file mode 100644 index 0000000..6da012c --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html @@ -0,0 +1,117 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.RemoteProcedureCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.RemoteProcedureCapability (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedureCapability.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.RemoteProcedureCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.RemoteProcedureCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.capability.RemoteProcedureCapability</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedureCapability.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html new file mode 100644 index 0000000..ab27e14 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html @@ -0,0 +1,165 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.capability.ResyncCapability.Listener (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Class com.amazon.carbonado.capability.ResyncCapability.Listener (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.Listener.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.capability.ResyncCapability.Listener" class="title">Uses of Class<br>com.amazon.carbonado.capability.ResyncCapability.Listener</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> with parameters of type <a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><span class="strong">ResyncCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, com.amazon.carbonado.capability.ResyncCapability.Listener, double, java.lang.String, java.lang.Object...)">resync</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><? super S> listener, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.Listener.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html new file mode 100644 index 0000000..369f856 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html @@ -0,0 +1,117 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.ResyncCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.ResyncCapability (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ResyncCapability.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.ResyncCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.ResyncCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.capability.ResyncCapability</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ResyncCapability.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html new file mode 100644 index 0000000..5b8e69b --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html @@ -0,0 +1,161 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.ShutdownCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.ShutdownCapability (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ShutdownCapability.html" target="_top">Frames</a></li> +<li><a href="ShutdownCapability.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.ShutdownCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.ShutdownCapability</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a><Txn></strong></code> +<div class="block">Implements basic functionality required by a core Repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ShutdownCapability.html" target="_top">Frames</a></li> +<li><a href="ShutdownCapability.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html new file mode 100644 index 0000000..887aad2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html @@ -0,0 +1,117 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.StorableInfoCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Interface com.amazon.carbonado.capability.StorableInfoCapability (Carbonado 1.2.3 API)"; + } +//--> +</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><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/StorableInfoCapability.html" target="_top">Frames</a></li> +<li><a href="StorableInfoCapability.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.StorableInfoCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.StorableInfoCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.capability.StorableInfoCapability</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/StorableInfoCapability.html" target="_top">Frames</a></li> +<li><a href="StorableInfoCapability.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/package-frame.html b/apidocs/com/amazon/carbonado/capability/package-frame.html new file mode 100644 index 0000000..4891a36 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-frame.html @@ -0,0 +1,36 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.capability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/capability/package-summary.html" target="classFrame">com.amazon.carbonado.capability</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="Capability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>Capability</i></a></li> +<li><a href="GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>GroupAccessCapability</i></a></li> +<li><a href="GroupMembers.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>GroupMembers</i></a></li> +<li><a href="IndexInfo.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>IndexInfo</i></a></li> +<li><a href="IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>IndexInfoCapability</i></a></li> +<li><a href="RemoteProcedure.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>RemoteProcedure</i></a></li> +<li><a href="RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>RemoteProcedure.Call</i></a></li> +<li><a href="RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>RemoteProcedure.Reply</i></a></li> +<li><a href="RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>RemoteProcedure.Request</i></a></li> +<li><a href="RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>RemoteProcedureCapability</i></a></li> +<li><a href="ResyncCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>ResyncCapability</i></a></li> +<li><a href="ShutdownCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>ShutdownCapability</i></a></li> +<li><a href="StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>StorableInfoCapability</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability" target="classFrame">ResyncCapability.Listener</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/package-summary.html b/apidocs/com/amazon/carbonado/capability/package-summary.html new file mode 100644 index 0000000..af0b7c6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-summary.html @@ -0,0 +1,238 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.capability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="com.amazon.carbonado.capability (Carbonado 1.2.3 API)"; + } +//--> +</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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/adapter/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package com.amazon.carbonado.capability</h1> +<div class="docSummary"> +<div class="block">Common capabilities for repositories.</div> +</div> +<p>See: <a href="#package_description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </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="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></td> +<td class="colLast"> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">GroupAccessCapability</a></td> +<td class="colLast"> +<div class="block">Capability for gaining access to replication group members.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></td> +<td class="colLast"> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">IndexInfoCapability</a></td> +<td class="colLast"> +<div class="block">Capability for getting information about physical indexes for storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D></td> +<td class="colLast"> +<div class="block">Defines a remote procedure which can be executed by <a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedureCapability</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D></td> +<td class="colLast"> +<div class="block">Client-side call into a remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><R></td> +<td class="colLast"> +<div class="block">Reply from remote procedure implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><R,D></td> +<td class="colLast"> +<div class="block">Request into a remote procedure, as seen by procedure implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">RemoteProcedureCapability</a></td> +<td class="colLast"> +<div class="block">Capability which allows arbitrary code to run on a remote host and access + its repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a></td> +<td class="colLast"> +<div class="block">Capability of replicating repositories for re-synchronizing to the master + repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></td> +<td class="colLast"> +<div class="block">Capability for repositories that require special attention with the Java + virtual machine exits.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a></td> +<td class="colLast"> +<div class="block">Capability that returns information about known storable types in a + repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </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="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><S></td> +<td class="colLast"> +<div class="block">Trigger which is invoked as storables get re-sync'd.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.capability Description">Package com.amazon.carbonado.capability Description</h2> +<div class="block">Common capabilities for repositories.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#getCapability(java.lang.Class)"><code>Repository.getCapability(java.lang.Class<C>)</code></a></dd></dl> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/adapter/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/package-tree.html b/apidocs/com/amazon/carbonado/capability/package-tree.html new file mode 100644 index 0000000..94bd294 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-tree.html @@ -0,0 +1,157 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.capability Class Hierarchy (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="com.amazon.carbonado.capability Class Hierarchy (Carbonado 1.2.3 API)"; + } +//--> +</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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/adapter/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package com.amazon.carbonado.capability</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Trigger</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">ResyncCapability.Listener</span></a><S></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">GroupAccessCapability</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">IndexInfoCapability</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedureCapability</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">ResyncCapability</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">ShutdownCapability</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">StorableInfoCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">GroupMembers</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">IndexInfo</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure.Call</span></a><R,D></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure.Reply</span></a><R></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure.Request</span></a><R,D></li> +<li type="circle">java.io.Serializable +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure</span></a><R,D></li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/adapter/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/package-use.html b/apidocs/com/amazon/carbonado/capability/package-use.html new file mode 100644 index 0000000..30c510b --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-use.html @@ -0,0 +1,420 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.capability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="Uses of Package com.amazon.carbonado.capability (Carbonado 1.2.3 API)"; + } +//--> +</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</li> +<li class="navBarCell1Rev">Use</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Uses of Package com.amazon.carbonado.capability" class="title">Uses of Package<br>com.amazon.carbonado.capability</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.capability">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/GroupMembers.html#com.amazon.carbonado.capability">GroupMembers</a> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/IndexInfo.html#com.amazon.carbonado.capability">IndexInfo</a> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/RemoteProcedure.html#com.amazon.carbonado.capability">RemoteProcedure</a> +<div class="block">Defines a remote procedure which can be executed by <a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedureCapability</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html#com.amazon.carbonado.capability">RemoteProcedure.Call</a> +<div class="block">Client-side call into a remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html#com.amazon.carbonado.capability">RemoteProcedure.Reply</a> +<div class="block">Reply from remote procedure implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html#com.amazon.carbonado.capability">RemoteProcedure.Request</a> +<div class="block">Request into a remote procedure, as seen by procedure implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html#com.amazon.carbonado.capability">ResyncCapability.Listener</a> +<div class="block">Trigger which is invoked as storables get re-sync'd.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/IndexInfo.html#com.amazon.carbonado.info">IndexInfo</a> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.layout">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.repo.indexed">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/IndexInfo.html#com.amazon.carbonado.repo.indexed">IndexInfo</a> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.repo.jdbc">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/IndexInfo.html#com.amazon.carbonado.repo.jdbc">IndexInfo</a> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.repo.logging">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.repo.sleepycat">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.sequence">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.spi">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/IndexInfo.html#com.amazon.carbonado.spi">IndexInfo</a> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/ShutdownCapability.html#com.amazon.carbonado.spi">ShutdownCapability</a> +<div class="block">Capability for repositories that require special attention with the Java + virtual machine exits.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Use</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |