http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/ZooKeeperInstance.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/ZooKeeperInstance.html b/1.8/apidocs/org/apache/accumulo/core/client/ZooKeeperInstance.html new file mode 100644 index 0000000..72ddccb --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/ZooKeeperInstance.html @@ -0,0 +1,683 @@ +<!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:21 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ZooKeeperInstance (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="ZooKeeperInstance (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/ZooKeeperInstance.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/TimedOutException.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ZooKeeperInstance.html" target="_top">Frames</a></li> +<li><a href="ZooKeeperInstance.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 ZooKeeperInstance" class="title">Class ZooKeeperInstance</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>org.apache.accumulo.core.client.ZooKeeperInstance</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/accumulo/minicluster/MiniAccumuloInstance.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloInstance</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ZooKeeperInstance</span> +extends <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> +implements <a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></pre> +<div class="block">An implementation of instance that looks in zookeeper to find information needed to connect to an instance of accumulo. + + <p> + The advantage of using zookeeper to obtain information about accumulo is that zookeeper is highly available, very responsive, and supports caching. + + <p> + Because it is possible for multiple instances of accumulo to share a single set of zookeeper servers, all constructors require an accumulo instance name. + + If you do not know the instance names then run accumulo org.apache.accumulo.server.util.ListInstances on an accumulo server.</div> +</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/ZooKeeperInstance.html#ZooKeeperInstance(org.apache.commons.configuration.Configuration)">ZooKeeperInstance</a></strong>(org.apache.commons.configuration.Configuration config)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#ZooKeeperInstance(java.lang.String,%20java.lang.String)">ZooKeeperInstance</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> instanceName, + <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> zooKeepers)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#ZooKeeperInstance(java.lang.String,%20java.lang.String,%20int)">ZooKeeperInstance</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> instanceName, + <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> zooKeepers, + int sessionTimeout)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.6.0; Use <a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#ZooKeeperInstance(org.apache.commons.configuration.Configuration)"><code>ZooKeeperInstance(Configuration)</code></a> instead.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#ZooKeeperInstance(java.util.UUID,%20java.lang.String)">ZooKeeperInstance</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/UUID.html?is-external=true"; title="class or interface in java.util">UUID</a> instanceId, + <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> zooKeepers)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.6.0; Use <a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#ZooKeeperInstance(org.apache.commons.configuration.Configuration)"><code>ZooKeeperInstance(Configuration)</code></a> instead.</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#ZooKeeperInstance(java.util.UUID,%20java.lang.String,%20int)">ZooKeeperInstance</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/UUID.html?is-external=true"; title="class or interface in java.util">UUID</a> instanceId, + <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> zooKeepers, + int sessionTimeout)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.6.0; Use <a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#ZooKeeperInstance(org.apache.commons.configuration.Configuration)"><code>ZooKeeperInstance(Configuration)</code></a> instead.</i></div> +</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.conf.AccumuloConfiguration</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#getConfiguration()">getConfiguration</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#getConnector(java.lang.String,%20org.apache.accumulo.core.client.security.tokens.AuthenticationToken)">getConnector</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> principal, + <a href="../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a> token)</code> +<div class="block">Returns a connection to this instance of accumulo.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#getConnector(java.lang.String,%20byte[])">getConnector</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> principal, + byte[] pass)</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#getConnector(java.lang.String,%20java.nio.ByteBuffer)">getConnector</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, + <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"; title="class or interface in java.nio">ByteBuffer</a> pass)</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#getConnector(java.lang.String,%20java.lang.CharSequence)">getConnector</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, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a> pass)</code> +<div class="block"><strong>Deprecated.</strong> </div> +</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/ZooKeeperInstance.html#getInstanceID()">getInstanceID</a></strong>()</code> +<div class="block">Returns a unique string that identifies this instance of accumulo.</div> +</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/ZooKeeperInstance.html#getInstanceName()">getInstanceName</a></strong>()</code> +<div class="block">Returns the instance name given at system initialization time.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<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/ZooKeeperInstance.html#getMasterLocations()">getMasterLocations</a></strong>()</code> +<div class="block">Returns the location(s) of the accumulo master and any redundant servers.</div> +</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/ZooKeeperInstance.html#getRootTabletLocation()">getRootTabletLocation</a></strong>()</code> +<div class="block">Returns the location of the tablet server that is serving the root tablet.</div> +</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/ZooKeeperInstance.html#getZooKeepers()">getZooKeepers</a></strong>()</code> +<div class="block">Returns a comma-separated list of zookeeper servers the instance is using.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#getZooKeepersSessionTimeOut()">getZooKeepersSessionTimeOut</a></strong>()</code> +<div class="block">Returns the zookeeper connection timeout.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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/ZooKeeperInstance.html#lookupInstanceName(org.apache.accumulo.fate.zookeeper.ZooCache,%20java.util.UUID)">lookupInstanceName</a></strong>(org.apache.accumulo.fate.zookeeper.ZooCache zooCache, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/UUID.html?is-external=true"; title="class or interface in java.util">UUID</a> instanceId)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.7.0 <code>ZooCache</code> is not part of the public API, but its a parameter to this method. Therefore code that uses this method is not + guaranteed to be stable. This method was deprecated to discourage its use.</i></div> +</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/ZooKeeperInstance.html#setConfiguration(org.apache.accumulo.core.conf.AccumuloConfiguration)">setConfiguration</a></strong>(org.apache.accumulo.core.conf.AccumuloConfiguration conf)</code> +<div class="block"><strong>Deprecated.</strong> </div> +</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/ZooKeeperInstance.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<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="ZooKeeperInstance(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeperInstance</h4> +<pre>public ZooKeeperInstance(<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> instanceName, + <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> zooKeepers)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instanceName</code> - The name of specific accumulo instance. This is set at initialization time.</dd><dd><code>zooKeepers</code> - A comma separated list of zoo keeper server locations. Each location can contain an optional port, of the format host:port.</dd></dl> +</li> +</ul> +<a name="ZooKeeperInstance(java.lang.String, java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeperInstance</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public ZooKeeperInstance(<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> instanceName, + <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> zooKeepers, + int sessionTimeout)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>since 1.6.0; Use <a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#ZooKeeperInstance(org.apache.commons.configuration.Configuration)"><code>ZooKeeperInstance(Configuration)</code></a> instead.</i></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instanceName</code> - The name of specific accumulo instance. This is set at initialization time.</dd><dd><code>zooKeepers</code> - A comma separated list of zoo keeper server locations. Each location can contain an optional port, of the format host:port.</dd><dd><code>sessionTimeout</code> - zoo keeper session time out in milliseconds.</dd></dl> +</li> +</ul> +<a name="ZooKeeperInstance(java.util.UUID, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeperInstance</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public ZooKeeperInstance(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/UUID.html?is-external=true"; title="class or interface in java.util">UUID</a> instanceId, + <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> zooKeepers)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>since 1.6.0; Use <a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#ZooKeeperInstance(org.apache.commons.configuration.Configuration)"><code>ZooKeeperInstance(Configuration)</code></a> instead.</i></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instanceId</code> - The UUID that identifies the accumulo instance you want to connect to.</dd><dd><code>zooKeepers</code> - A comma separated list of zoo keeper server locations. Each location can contain an optional port, of the format host:port.</dd></dl> +</li> +</ul> +<a name="ZooKeeperInstance(java.util.UUID, java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeperInstance</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public ZooKeeperInstance(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/UUID.html?is-external=true"; title="class or interface in java.util">UUID</a> instanceId, + <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> zooKeepers, + int sessionTimeout)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>since 1.6.0; Use <a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html#ZooKeeperInstance(org.apache.commons.configuration.Configuration)"><code>ZooKeeperInstance(Configuration)</code></a> instead.</i></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instanceId</code> - The UUID that identifies the accumulo instance you want to connect to.</dd><dd><code>zooKeepers</code> - A comma separated list of zoo keeper server locations. Each location can contain an optional port, of the format host:port.</dd><dd><code>sessionTimeout</code> - zoo keeper session time out in milliseconds.</dd></dl> +</li> +</ul> +<a name="ZooKeeperInstance(org.apache.commons.configuration.Configuration)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ZooKeeperInstance</h4> +<pre>public ZooKeeperInstance(org.apache.commons.configuration.Configuration config)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Client configuration for specifying connection options. See <a href="../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client"><code>ClientConfiguration</code></a> which extends Configuration with convenience methods + specific to Accumulo.</dd><dt><span class="strong">Since:</span></dt> + <dd>1.6.0</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="getInstanceID()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstanceID</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> getInstanceID()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getInstanceID()">Instance</a></code></strong></div> +<div class="block">Returns a unique string that identifies this instance of accumulo.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getInstanceID()">getInstanceID</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a UUID</dd></dl> +</li> +</ul> +<a name="getMasterLocations()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMasterLocations</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<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>> getMasterLocations()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getMasterLocations()">Instance</a></code></strong></div> +<div class="block">Returns the location(s) of the accumulo master and any redundant servers.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getMasterLocations()">getMasterLocations</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a list of locations in "hostname:port" form</dd></dl> +</li> +</ul> +<a name="getRootTabletLocation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRootTabletLocation</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> getRootTabletLocation()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getRootTabletLocation()">Instance</a></code></strong></div> +<div class="block">Returns the location of the tablet server that is serving the root tablet.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getRootTabletLocation()">getRootTabletLocation</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>location in "hostname:port" form</dd></dl> +</li> +</ul> +<a name="getInstanceName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstanceName</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> getInstanceName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getInstanceName()">Instance</a></code></strong></div> +<div class="block">Returns the instance name given at system initialization time.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getInstanceName()">getInstanceName</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>current instance name</dd></dl> +</li> +</ul> +<a name="getZooKeepers()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getZooKeepers</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> getZooKeepers()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getZooKeepers()">Instance</a></code></strong></div> +<div class="block">Returns a comma-separated list of zookeeper servers the instance is using.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getZooKeepers()">getZooKeepers</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the zookeeper servers this instance is using in "hostname:port" form</dd></dl> +</li> +</ul> +<a name="getZooKeepersSessionTimeOut()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getZooKeepersSessionTimeOut</h4> +<pre>public int getZooKeepersSessionTimeOut()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getZooKeepersSessionTimeOut()">Instance</a></code></strong></div> +<div class="block">Returns the zookeeper connection timeout.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getZooKeepersSessionTimeOut()">getZooKeepersSessionTimeOut</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the configured timeout to connect to zookeeper</dd></dl> +</li> +</ul> +<a name="getConnector(java.lang.String, java.lang.CharSequence)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnector</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public <a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a> getConnector(<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, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a> pass) + throws <a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector(java.lang.String,%20java.lang.CharSequence)">Instance</a></code></strong></div> +<div class="block">Returns a connection to this instance of accumulo.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector(java.lang.String,%20java.lang.CharSequence)">getConnector</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>user</code> - a valid accumulo user</dd><dd><code>pass</code> - If a mutable CharSequence is passed in, it may be cleared after this call.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the accumulo Connector</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code> - when a generic exception occurs</dd> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code> - when a user's credentials are invalid</dd></dl> +</li> +</ul> +<a name="getConnector(java.lang.String, java.nio.ByteBuffer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnector</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public <a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a> getConnector(<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, + <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"; title="class or interface in java.nio">ByteBuffer</a> pass) + throws <a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector(java.lang.String,%20java.nio.ByteBuffer)">Instance</a></code></strong></div> +<div class="block">Returns a connection to accumulo.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector(java.lang.String,%20java.nio.ByteBuffer)">getConnector</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>user</code> - a valid accumulo user</dd><dd><code>pass</code> - A UTF-8 encoded password. The password may be cleared after making this call.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the accumulo Connector</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code> - when a generic exception occurs</dd> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code> - when a user's credentials are invalid</dd></dl> +</li> +</ul> +<a name="getConnector(java.lang.String, org.apache.accumulo.core.client.security.tokens.AuthenticationToken)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnector</h4> +<pre>public <a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a> getConnector(<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> principal, + <a href="../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a> token) + throws <a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector(java.lang.String,%20org.apache.accumulo.core.client.security.tokens.AuthenticationToken)">Instance</a></code></strong></div> +<div class="block">Returns a connection to this instance of accumulo.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector(java.lang.String,%20org.apache.accumulo.core.client.security.tokens.AuthenticationToken)">getConnector</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - a valid accumulo user</dd><dd><code>token</code> - Use the token type configured for the Accumulo instance you are connecting to. An Accumulo instance with default configurations will use + <a href="../../../../../org/apache/accumulo/core/client/security/tokens/PasswordToken.html" title="class in org.apache.accumulo.core.client.security.tokens"><code>PasswordToken</code></a></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code></dd> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code></dd></dl> +</li> +</ul> +<a name="getConnector(java.lang.String, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnector</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public <a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a> getConnector(<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> principal, + byte[] pass) + throws <a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector(java.lang.String,%20byte[])">Instance</a></code></strong></div> +<div class="block">Returns a connection to accumulo.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector(java.lang.String,%20byte[])">getConnector</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - a valid accumulo user</dd><dd><code>pass</code> - A UTF-8 encoded password. The password may be cleared after making this call.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the accumulo Connector</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code> - when a generic exception occurs</dd> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code> - when a user's credentials are invalid</dd></dl> +</li> +</ul> +<a name="getConfiguration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfiguration</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public org.apache.accumulo.core.conf.AccumuloConfiguration getConfiguration()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConfiguration()">Instance</a></code></strong></div> +<div class="block">Returns the AccumuloConfiguration to use when interacting with this instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConfiguration()">getConfiguration</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the AccumuloConfiguration that specifies properties related to interacting with this instance</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#getSystemConfiguration()"><code>for client-side reading of the server-side configuration.</code></a></dd></dl> +</li> +</ul> +<a name="setConfiguration(org.apache.accumulo.core.conf.AccumuloConfiguration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfiguration</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public void setConfiguration(org.apache.accumulo.core.conf.AccumuloConfiguration conf)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#setConfiguration(org.apache.accumulo.core.conf.AccumuloConfiguration)">Instance</a></code></strong></div> +<div class="block">Set the AccumuloConfiguration to use when interacting with this instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Instance.html#setConfiguration(org.apache.accumulo.core.conf.AccumuloConfiguration)">setConfiguration</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - accumulo configuration</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#setProperty(java.lang.String,%20java.lang.String)"><code>InstanceOperations.setProperty(String, String)</code></a></dd></dl> +</li> +</ul> +<a name="lookupInstanceName(org.apache.accumulo.fate.zookeeper.ZooCache, java.util.UUID)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lookupInstanceName</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public static <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> lookupInstanceName(org.apache.accumulo.fate.zookeeper.ZooCache zooCache, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/UUID.html?is-external=true"; title="class or interface in java.util">UUID</a> instanceId)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>since 1.7.0 <code>ZooCache</code> is not part of the public API, but its a parameter to this method. Therefore code that uses this method is not + guaranteed to be stable. This method was deprecated to discourage its use.</i></div> +<div class="block">Given a zooCache and instanceId, look up the instance name.</div> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</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> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><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></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/ZooKeeperInstance.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/TimedOutException.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ZooKeeperInstance.html" target="_top">Frames</a></li> +<li><a href="ZooKeeperInstance.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/admin/ActiveCompaction.CompactionReason.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html b/1.8/apidocs/org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html new file mode 100644 index 0000000..482c8b8 --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html @@ -0,0 +1,376 @@ +<!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>ActiveCompaction.CompactionReason (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="ActiveCompaction.CompactionReason (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/ActiveCompaction.CompactionReason.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/admin/ActiveCompaction.html" title="class in org.apache.accumulo.core.client.admin"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionType.html" title="enum in org.apache.accumulo.core.client.admin"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" target="_top">Frames</a></li> +<li><a href="ActiveCompaction.CompactionReason.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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.admin</div> +<h2 title="Enum ActiveCompaction.CompactionReason" class="title">Enum ActiveCompaction.CompactionReason</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/Enum.html?is-external=true"; title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.admin.ActiveCompaction.CompactionReason</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>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.html" title="class in org.apache.accumulo.core.client.admin">ActiveCompaction</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">ActiveCompaction.CompactionReason</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html#CHOP">CHOP</a></strong></code> +<div class="block">Compaction initiated by merge operation</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html#CLOSE">CLOSE</a></strong></code> +<div class="block">Compaction initiated to close a unload a tablet</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html#IDLE">IDLE</a></strong></code> +<div class="block">idle compaction</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html#SYSTEM">SYSTEM</a></strong></code> +<div class="block">Compaction initiated by system</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html#USER">USER</a></strong></code> +<div class="block">compaction initiated by user</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>static <a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html#valueOf(java.lang.String)">valueOf</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> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.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/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang">valueOf</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#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#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"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="USER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>USER</h4> +<pre>public static final <a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a> USER</pre> +<div class="block">compaction initiated by user</div> +</li> +</ul> +<a name="SYSTEM"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SYSTEM</h4> +<pre>public static final <a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a> SYSTEM</pre> +<div class="block">Compaction initiated by system</div> +</li> +</ul> +<a name="CHOP"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CHOP</h4> +<pre>public static final <a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a> CHOP</pre> +<div class="block">Compaction initiated by merge operation</div> +</li> +</ul> +<a name="IDLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IDLE</h4> +<pre>public static final <a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a> IDLE</pre> +<div class="block">idle compaction</div> +</li> +</ul> +<a name="CLOSE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CLOSE</h4> +<pre>public static final <a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a> CLOSE</pre> +<div class="block">Compaction initiated to close a unload a tablet</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (ActiveCompaction.CompactionReason c : ActiveCompaction.CompactionReason.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" title="enum in org.apache.accumulo.core.client.admin">ActiveCompaction.CompactionReason</a> valueOf(<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> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the argument is 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/ActiveCompaction.CompactionReason.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/admin/ActiveCompaction.html" title="class in org.apache.accumulo.core.client.admin"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionType.html" title="enum in org.apache.accumulo.core.client.admin"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/admin/ActiveCompaction.CompactionReason.html" target="_top">Frames</a></li> +<li><a href="ActiveCompaction.CompactionReason.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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>
