http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/index.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/index.html b/1.8/apidocs/index.html new file mode 100644 index 0000000..853a19e --- /dev/null +++ b/1.8/apidocs/index.html @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc on Tue Sep 06 14:11:24 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Apache Accumulo Project 1.8.0 API</title> +<script type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage))) + targetPage = "undefined"; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()"> +<frame src="overview-frame.html" name="packageListFrame" title="All Packages"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</frameset> +<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/AccumuloException.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/AccumuloException.html b/1.8/apidocs/org/apache/accumulo/core/client/AccumuloException.html new file mode 100644 index 0000000..14a35fc --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/AccumuloException.html @@ -0,0 +1,286 @@ +<!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_79) on Tue Sep 06 14:11:20 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AccumuloException (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<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="AccumuloException (Apache Accumulo Project 1.8.0 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/AccumuloException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/AccumuloException.html" target="_top">Frames</a></li> +<li><a href="AccumuloException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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">org.apache.accumulo.core.client</div> +<h2 title="Class AccumuloException" class="title">Class AccumuloException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.AccumuloException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client">MutationsRejectedException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">AccumuloException</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">A generic Accumulo Exception for general accumulo failures.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.accumulo.core.client.AccumuloException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="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="../../../../../org/apache/accumulo/core/client/AccumuloException.html#AccumuloException(java.lang.String)">AccumuloException</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> why)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html#AccumuloException(java.lang.String,%20java.lang.Throwable)">AccumuloException</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> why, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html#AccumuloException(java.lang.Throwable)">AccumuloException</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace()" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage()" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace()" title="class or inter face in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed()" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#initCause(java.lang.Throwable)" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace()" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lan g/Throwable.html?is-external=true#setStackTrace(java.lang.StackTraceElement[])" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#toString()" title="class or interface in java.lang">toString</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AccumuloException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AccumuloException</h4> +<pre>public AccumuloException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> why)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>why</code> - is the reason for the error being thrown</dd></dl> +</li> +</ul> +<a name="AccumuloException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AccumuloException</h4> +<pre>public AccumuloException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cause</code> - is the exception that this exception wraps</dd></dl> +</li> +</ul> +<a name="AccumuloException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AccumuloException</h4> +<pre>public AccumuloException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> why, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>why</code> - is the reason for the error being thrown</dd><dd><code>cause</code> - is the exception that this exception wraps</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/AccumuloException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/AccumuloException.html" target="_top">Frames</a></li> +<li><a href="AccumuloException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011–2016 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/AccumuloSecurityException.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/AccumuloSecurityException.html b/1.8/apidocs/org/apache/accumulo/core/client/AccumuloSecurityException.html new file mode 100644 index 0000000..e929924 --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/AccumuloSecurityException.html @@ -0,0 +1,440 @@ +<!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_79) on Tue Sep 06 14:11:20 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AccumuloSecurityException (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<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="AccumuloSecurityException (Apache Accumulo Project 1.8.0 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/AccumuloSecurityException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/AccumuloSecurityException.html" target="_top">Frames</a></li> +<li><a href="AccumuloSecurityException.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><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">org.apache.accumulo.core.client</div> +<h2 title="Class AccumuloSecurityException" class="title">Class AccumuloSecurityException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.AccumuloSecurityException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">AccumuloSecurityException</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">An Accumulo Exception for security violations, authentication failures, authorization failures, etc.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.accumulo.core.client.AccumuloSecurityException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="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="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#AccumuloSecurityException(java.lang.String,%20org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode)">AccumuloSecurityException</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user, + org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode errorcode)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#AccumuloSecurityException(java.lang.String,%20org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode,%20java.lang.String)">AccumuloSecurityException</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user, + org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode errorcode, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableInfo)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#AccumuloSecurityException(java.lang.String,%20org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode,%20java.lang.String,%20java.lang.Throwable)">AccumuloSecurityException</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user, + org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode errorcode, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableInfo, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#AccumuloSecurityException(java.lang.String,%20org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode,%20java.lang.Throwable)">AccumuloSecurityException</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user, + org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode errorcode, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#AccumuloSecurityException(org.apache.accumulo.core.client.impl.thrift.ThriftSecurityException)">AccumuloSecurityException</a></strong>(org.apache.accumulo.core.client.impl.thrift.ThriftSecurityException thrift)</code> +<div class="block">Construct a user-facing exception from a serialized version.</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>org.apache.accumulo.core.client.impl.thrift.ThriftSecurityException</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#asThriftException()">asThriftException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#getMessage()">getMessage</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/client/security/SecurityErrorCode.html" title="enum in org.apache.accumulo.core.client.security">SecurityErrorCode</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#getSecurityErrorCode()">getSecurityErrorCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#getTableInfo()">getTableInfo</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#getUser()">getUser</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#setTableInfo(java.lang.String)">setTableInfo</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableInfo)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html#setUser(java.lang.String)">setUser</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> s)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace()" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage()" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace()" title="class or interface in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed()" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#initCause(java.lang.Throwable)" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace()" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace(java.lang.StackTraceElement[])" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.or acle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#toString()" title="class or interface in java.lang">toString</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AccumuloSecurityException(org.apache.accumulo.core.client.impl.thrift.ThriftSecurityException)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AccumuloSecurityException</h4> +<pre>public AccumuloSecurityException(org.apache.accumulo.core.client.impl.thrift.ThriftSecurityException thrift)</pre> +<div class="block">Construct a user-facing exception from a serialized version.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>thrift</code> - a serialized version</dd></dl> +</li> +</ul> +<a name="AccumuloSecurityException(java.lang.String, org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AccumuloSecurityException</h4> +<pre>public AccumuloSecurityException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user, + org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode errorcode, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>user</code> - the relevant user for the security violation</dd><dd><code>errorcode</code> - the specific reason for this exception</dd><dd><code>cause</code> - the exception that caused this violation</dd></dl> +</li> +</ul> +<a name="AccumuloSecurityException(java.lang.String, org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode, java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AccumuloSecurityException</h4> +<pre>public AccumuloSecurityException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user, + org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode errorcode, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableInfo, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>user</code> - the relevant user for the security violation</dd><dd><code>errorcode</code> - the specific reason for this exception</dd><dd><code>tableInfo</code> - the relevant tableInfo for the security violation</dd><dd><code>cause</code> - the exception that caused this violation</dd></dl> +</li> +</ul> +<a name="AccumuloSecurityException(java.lang.String, org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AccumuloSecurityException</h4> +<pre>public AccumuloSecurityException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user, + org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode errorcode)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>user</code> - the relevant user for the security violation</dd><dd><code>errorcode</code> - the specific reason for this exception</dd></dl> +</li> +</ul> +<a name="AccumuloSecurityException(java.lang.String, org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AccumuloSecurityException</h4> +<pre>public AccumuloSecurityException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user, + org.apache.accumulo.core.client.impl.thrift.SecurityErrorCode errorcode, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableInfo)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>user</code> - the relevant user for the security violation</dd><dd><code>errorcode</code> - the specific reason for this exception</dd><dd><code>tableInfo</code> - the relevant tableInfo for the security violation</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="asThriftException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asThriftException</h4> +<pre>public org.apache.accumulo.core.client.impl.thrift.ThriftSecurityException asThriftException()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>this exception as a thrift exception</dd></dl> +</li> +</ul> +<a name="getUser()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUser</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getUser()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the relevant user for the security violation</dd></dl> +</li> +</ul> +<a name="setUser(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUser</h4> +<pre>public void setUser(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> s)</pre> +</li> +</ul> +<a name="getTableInfo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTableInfo</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getTableInfo()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the relevant tableInfo for the security violation</dd></dl> +</li> +</ul> +<a name="setTableInfo(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTableInfo</h4> +<pre>public void setTableInfo(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableInfo)</pre> +</li> +</ul> +<a name="getSecurityErrorCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSecurityErrorCode</h4> +<pre>public <a href="../../../../../org/apache/accumulo/core/client/security/SecurityErrorCode.html" title="enum in org.apache.accumulo.core.client.security">SecurityErrorCode</a> getSecurityErrorCode()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the specific reason for this exception</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="getMessage()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getMessage()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang">getMessage</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</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/AccumuloSecurityException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/AccumuloSecurityException.html" target="_top">Frames</a></li> +<li><a href="AccumuloSecurityException.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><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 © 2011–2016 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/BatchDeleter.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/BatchDeleter.html b/1.8/apidocs/org/apache/accumulo/core/client/BatchDeleter.html new file mode 100644 index 0000000..bc8d50f --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/BatchDeleter.html @@ -0,0 +1,273 @@ +<!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_79) on Tue Sep 06 14:11:20 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>BatchDeleter (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<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="BatchDeleter (Apache Accumulo Project 1.8.0 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/BatchDeleter.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/BatchDeleter.html" target="_top">Frames</a></li> +<li><a href="BatchDeleter.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">org.apache.accumulo.core.client</div> +<h2 title="Interface BatchDeleter" class="title">Interface BatchDeleter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/accumulo/core/client/mock/MockBatchDeleter.html" title="class in org.apache.accumulo.core.client.mock">MockBatchDeleter</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">BatchDeleter</span> +extends <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></pre> +<div class="block">Implementations of BatchDeleter support efficient deletion of ranges in accumulo.</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="../../../../../org/apache/accumulo/core/client/BatchDeleter.html#close()">close</a></strong>()</code> +<div class="block">Closes any underlying connections on the scanner.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/BatchDeleter.html#delete()">delete</a></strong>()</code> +<div class="block">Deletes the ranges specified by <a href="../../../../../org/apache/accumulo/core/client/BatchDeleter.html#setRanges(java.util.Collection)"><code>setRanges(java.util.Collection<org.apache.accumulo.core.data.Range>)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/BatchDeleter.html#setRanges(java.util.Collection)">setRanges</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>> ranges)</code> +<div class="block">Allows deleting multiple ranges efficiently.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.accumulo.core.client.ScannerBase"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.accumulo.core.client.<a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></h3> +<code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)">addScanIterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearClassLoaderContext()">clearClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearColumns()">clearColumns</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearSamplerConfiguration()">clearSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearScanIterators()">clearScanIterators</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumn(org.apache.accumulo.core.client.IteratorSetting.Column)">fetchColumn</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumn(org.apache.hadoop.io.Text,%20org.apache.hadoop.io.Text)">fetchColumn</a>, <a href="../../../../../o rg/apache/accumulo/core/client/ScannerBase.html#fetchColumnFamily(org.apache.hadoop.io.Text)">fetchColumnFamily</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getAuthorizations()">getAuthorizations</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getBatchTimeout(java.util.concurrent.TimeUnit)">getBatchTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getClassLoaderContext()">getClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getSamplerConfiguration()">getSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getTimeout(java.util.concurrent.TimeUnit)">getTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator()">iterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#removeScanIterator(java.lang.String)">removeScanIterator</a>, < a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setBatchTimeout(long,%20java.util.concurrent.TimeUnit)">setBatchTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setClassLoaderContext(java.lang.String)">setClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setSamplerConfiguration(org.apache.accumulo.core.client.sample.SamplerConfiguration)">setSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setTimeout(long,%20java.util.concurrent.TimeUnit)">setTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#updateScanIteratorOption(java.lang.String,%20java.lang.String,%20java.lang.String)">updateScanIteratorOption</a></code></li> +</ul> +</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="delete()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>void delete() + throws <a href="../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client">MutationsRejectedException</a>, + <a href="../../../../../org/apache/accumulo/core/client/TableNotFoundException.html" title="class in org.apache.accumulo.core.client">TableNotFoundException</a></pre> +<div class="block">Deletes the ranges specified by <a href="../../../../../org/apache/accumulo/core/client/BatchDeleter.html#setRanges(java.util.Collection)"><code>setRanges(java.util.Collection<org.apache.accumulo.core.data.Range>)</code></a>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client">MutationsRejectedException</a></code> - this can be thrown when deletion mutations fail</dd> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/TableNotFoundException.html" title="class in org.apache.accumulo.core.client">TableNotFoundException</a></code> - when the table does not exist</dd></dl> +</li> +</ul> +<a name="setRanges(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRanges</h4> +<pre>void setRanges(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>> ranges)</pre> +<div class="block">Allows deleting multiple ranges efficiently.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ranges</code> - specifies the non-overlapping ranges to query</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#close()">ScannerBase</a></code></strong></div> +<div class="block">Closes any underlying connections on the scanner. This may invalidate any iterators derived from the Scanner, causing them to throw exceptions.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#close()">close</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</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/BatchDeleter.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/BatchDeleter.html" target="_top">Frames</a></li> +<li><a href="BatchDeleter.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 © 2011–2016 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/BatchScanner.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/BatchScanner.html b/1.8/apidocs/org/apache/accumulo/core/client/BatchScanner.html new file mode 100644 index 0000000..78812e1 --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/BatchScanner.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_79) on Tue Sep 06 14:11:20 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>BatchScanner (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<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="BatchScanner (Apache Accumulo Project 1.8.0 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/BatchScanner.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/BatchWriter.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/BatchScanner.html" target="_top">Frames</a></li> +<li><a href="BatchScanner.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">org.apache.accumulo.core.client</div> +<h2 title="Interface BatchScanner" class="title">Interface BatchScanner</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/accumulo/core/client/mock/MockBatchDeleter.html" title="class in org.apache.accumulo.core.client.mock">MockBatchDeleter</a>, <a href="../../../../../org/apache/accumulo/core/client/mock/MockBatchScanner.html" title="class in org.apache.accumulo.core.client.mock">MockBatchScanner</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">BatchScanner</span> +extends <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></pre> +<div class="block">In exchange for possibly <b>returning scanned entries out of order</b>, BatchScanner implementations may scan an Accumulo table more efficiently by + <ul> + <li>Looking up multiple ranges in parallel. Parallelism is constrained by the number of threads available to the BatchScanner, set in its constructor.</li> + <li>Breaking up large ranges into subranges. Often the number and boundaries of subranges are determined by a table's split points.</li> + <li>Combining multiple ranges into a single RPC call to a tablet server.</li> + </ul> + + The above techniques lead to better performance than a <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client"><code>Scanner</code></a> in use cases such as + <ul> + <li>Retrieving many small ranges</li> + <li>Scanning a large range that returns many entries</li> + <li>Running server-side iterators that perform computation, even if few entries are returned from the scan itself</li> + </ul> + + To re-emphasize, only use a BatchScanner when you do not care whether returned data is in sorted order. Use a <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client"><code>Scanner</code></a> instead when sorted order is + important. + + <p> + A BatchScanner instance will use no more threads than provided in the construction of the BatchScanner implementation. Multiple invocations of + <code>iterator()</code> will all share the same resources of the instance. A new BatchScanner instance should be created to use allocate additional threads.</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="../../../../../org/apache/accumulo/core/client/BatchScanner.html#close()">close</a></strong>()</code> +<div class="block">Closes any underlying connections on the scanner.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/BatchScanner.html#setRanges(java.util.Collection)">setRanges</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>> ranges)</code> +<div class="block">Allows scanning over multiple ranges efficiently.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/BatchScanner.html#setTimeout(long,%20java.util.concurrent.TimeUnit)">setTimeout</a></strong>(long timeout, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code> +<div class="block">This setting determines how long a scanner will automatically retry when a failure occurs.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.accumulo.core.client.ScannerBase"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.accumulo.core.client.<a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></h3> +<code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)">addScanIterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearClassLoaderContext()">clearClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearColumns()">clearColumns</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearSamplerConfiguration()">clearSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearScanIterators()">clearScanIterators</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumn(org.apache.accumulo.core.client.IteratorSetting.Column)">fetchColumn</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumn(org.apache.hadoop.io.Text,%20org.apache.hadoop.io.Text)">fetchColumn</a>, <a href="../../../../../o rg/apache/accumulo/core/client/ScannerBase.html#fetchColumnFamily(org.apache.hadoop.io.Text)">fetchColumnFamily</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getAuthorizations()">getAuthorizations</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getBatchTimeout(java.util.concurrent.TimeUnit)">getBatchTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getClassLoaderContext()">getClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getSamplerConfiguration()">getSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getTimeout(java.util.concurrent.TimeUnit)">getTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator()">iterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#removeScanIterator(java.lang.String)">removeScanIterator</a>, < a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setBatchTimeout(long,%20java.util.concurrent.TimeUnit)">setBatchTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setClassLoaderContext(java.lang.String)">setClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setSamplerConfiguration(org.apache.accumulo.core.client.sample.SamplerConfiguration)">setSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#updateScanIteratorOption(java.lang.String,%20java.lang.String,%20java.lang.String)">updateScanIteratorOption</a></code></li> +</ul> +</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="setRanges(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRanges</h4> +<pre>void setRanges(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>> ranges)</pre> +<div class="block">Allows scanning over multiple ranges efficiently.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ranges</code> - specifies the non-overlapping ranges to query</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#close()">ScannerBase</a></code></strong></div> +<div class="block">Closes any underlying connections on the scanner. This may invalidate any iterators derived from the Scanner, causing them to throw exceptions.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#close()">close</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></code></dd> +</dl> +</li> +</ul> +<a name="setTimeout(long, java.util.concurrent.TimeUnit)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setTimeout</h4> +<pre>void setTimeout(long timeout, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre> +<div class="block">This setting determines how long a scanner will automatically retry when a failure occurs. By default, a scanner will retry forever. + + <p> + Setting the timeout to zero (with any time unit) or <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE"; title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> (with <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true#MILLISECONDS"; title="class or interface in java.util.concurrent"><code>TimeUnit.MILLISECONDS</code></a>) means no timeout. + + <p> + The batch scanner will accomplish as much work as possible before throwing an exception. BatchScanner iterators will throw a <a href="../../../../../org/apache/accumulo/core/client/TimedOutException.html" title="class in org.apache.accumulo.core.client"><code>TimedOutException</code></a> when + all needed servers timeout.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setTimeout(long,%20java.util.concurrent.TimeUnit)">setTimeout</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - the length of the timeout</dd><dd><code>timeUnit</code> - the units of the timeout</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/BatchScanner.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/BatchWriter.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/BatchScanner.html" target="_top">Frames</a></li> +<li><a href="BatchScanner.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 © 2011–2016 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
