blob: 57006b2c38bed335bb11c9a87142ff21a9fe13dd [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Thu Apr 11 20:05:14 EDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Instance (Apache Accumulo Project 1.9.3 API)</title>
<meta name="date" content="2019-04-11">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Instance (Apache Accumulo Project 1.9.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":38,"i1":6,"i2":38,"i3":38,"i4":38,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":38};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Instance.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/Durability.html" title="enum in org.apache.accumulo.core.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html" title="class in org.apache.accumulo.core.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/accumulo/core/client/Instance.html" target="_top">Frames</a></li>
<li><a href="Instance.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.accumulo.core.client</div>
<h2 title="Interface Instance" class="title">Interface Instance</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/accumulo/minicluster/MiniAccumuloInstance.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloInstance</a>, <a href="../../../../../org/apache/accumulo/core/client/mock/MockInstance.html" title="class in org.apache.accumulo.core.client.mock">MockInstance</a>, <a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html" title="class in org.apache.accumulo.core.client">ZooKeeperInstance</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Instance</span></pre>
<div class="block">This class represents the information a client needs to know to connect to an instance of
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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>org.apache.accumulo.core.conf.AccumuloConfiguration</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConfiguration--">getConfiguration</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 1.6.0. This method makes very little sense in the context of the client API
and never should have been exposed.</span></div>
</div>
</td>
</tr>
<tr id="i1" 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><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-">getConnector</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;principal,
<a href="../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a>&nbsp;token)</code>
<div class="block">Returns a connection to this instance of accumulo.</div>
</td>
</tr>
<tr id="i2" 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><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector-java.lang.String-byte:A-">getConnector</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
byte[]&nbsp;pass)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 1.5, use <a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-"><code>getConnector(String, AuthenticationToken)</code></a> with
<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></span></div>
</div>
</td>
</tr>
<tr id="i3" 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><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector-java.lang.String-java.nio.ByteBuffer-">getConnector</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;pass)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 1.5, use <a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-"><code>getConnector(String, AuthenticationToken)</code></a> with
<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></span></div>
</div>
</td>
</tr>
<tr id="i4" 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><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector-java.lang.String-java.lang.CharSequence-">getConnector</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</a>&nbsp;pass)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 1.5, use <a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-"><code>getConnector(String, AuthenticationToken)</code></a> with
<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></span></div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getInstanceID--">getInstanceID</a></span>()</code>
<div class="block">Returns a unique string that identifies this instance of accumulo.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getInstanceName--">getInstanceName</a></span>()</code>
<div class="block">Returns the instance name given at system initialization time.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getMasterLocations--">getMasterLocations</a></span>()</code>
<div class="block">Returns the location(s) of the accumulo master and any redundant servers.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getRootTabletLocation--">getRootTabletLocation</a></span>()</code>
<div class="block">Returns the location of the tablet server that is serving the root tablet.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getZooKeepers--">getZooKeepers</a></span>()</code>
<div class="block">Returns a comma-separated list of zookeeper servers the instance is using.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#getZooKeepersSessionTimeOut--">getZooKeepersSessionTimeOut</a></span>()</code>
<div class="block">Returns the zookeeper connection timeout.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/Instance.html#setConfiguration-org.apache.accumulo.core.conf.AccumuloConfiguration-">setConfiguration</a></span>(org.apache.accumulo.core.conf.AccumuloConfiguration&nbsp;conf)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 1.6.0. This method makes very little sense in the context of the client API
and never should have been exposed.</span></div>
</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRootTabletLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootTabletLocation</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getRootTabletLocation()</pre>
<div class="block">Returns the location of the tablet server that is serving the root tablet.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>location in "hostname:port" form</dd>
</dl>
</li>
</ul>
<a name="getMasterLocations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMasterLocations</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getMasterLocations()</pre>
<div class="block">Returns the location(s) of the accumulo master and any redundant servers.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of locations in "hostname:port" form</dd>
</dl>
</li>
</ul>
<a name="getInstanceID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstanceID</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getInstanceID()</pre>
<div class="block">Returns a unique string that identifies this instance of accumulo.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a UUID</dd>
</dl>
</li>
</ul>
<a name="getInstanceName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstanceName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getInstanceName()</pre>
<div class="block">Returns the instance name given at system initialization time.</div>
<dl>
<dt><span class="returnLabel">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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getZooKeepers()</pre>
<div class="block">Returns a comma-separated list of zookeeper servers the instance is using.</div>
<dl>
<dt><span class="returnLabel">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>int&nbsp;getZooKeepersSessionTimeOut()</pre>
<div class="block">Returns the zookeeper connection timeout.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured timeout to connect to zookeeper</dd>
</dl>
</li>
</ul>
<a name="getConnector-java.lang.String-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnector</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
<a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a>&nbsp;getConnector(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
byte[]&nbsp;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="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.5, use <a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-"><code>getConnector(String, AuthenticationToken)</code></a> with
<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></span></div>
<div class="block">Returns a connection to accumulo.</div>
<dl>
<dt><span class="paramLabel">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="returnLabel">Returns:</span></dt>
<dd>the accumulo Connector</dd>
<dt><span class="throwsLabel">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="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
<a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a>&nbsp;getConnector(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;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="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.5, use <a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-"><code>getConnector(String, AuthenticationToken)</code></a> with
<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></span></div>
<div class="block">Returns a connection to accumulo.</div>
<dl>
<dt><span class="paramLabel">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="returnLabel">Returns:</span></dt>
<dd>the accumulo Connector</dd>
<dt><span class="throwsLabel">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.lang.CharSequence-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnector</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
<a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a>&nbsp;getConnector(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</a>&nbsp;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="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.5, use <a href="../../../../../org/apache/accumulo/core/client/Instance.html#getConnector-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-"><code>getConnector(String, AuthenticationToken)</code></a> with
<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></span></div>
<div class="block">Returns a connection to this instance of accumulo.</div>
<dl>
<dt><span class="paramLabel">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="returnLabel">Returns:</span></dt>
<dd>the accumulo Connector</dd>
<dt><span class="throwsLabel">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="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
org.apache.accumulo.core.conf.AccumuloConfiguration&nbsp;getConfiguration()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.6.0. This method makes very little sense in the context of the client API
and never should have been exposed.</span></div>
<div class="block">Returns the AccumuloConfiguration to use when interacting with this instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the AccumuloConfiguration that specifies properties related to interacting with this
instance</dd>
<dt><span class="seeLabel">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="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
void&nbsp;setConfiguration(org.apache.accumulo.core.conf.AccumuloConfiguration&nbsp;conf)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.6.0. This method makes very little sense in the context of the client API
and never should have been exposed.</span></div>
<div class="block">Set the AccumuloConfiguration to use when interacting with this instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - accumulo configuration</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#setProperty-java.lang.String-java.lang.String-"><code>InstanceOperations.setProperty(String, String)</code></a></dd>
</dl>
</li>
</ul>
<a name="getConnector-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getConnector</h4>
<pre><a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a>&nbsp;getConnector(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;principal,
<a href="../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a>&nbsp;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">Returns a connection to this instance of accumulo.</div>
<dl>
<dt><span class="paramLabel">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="throwsLabel">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>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Instance.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/Durability.html" title="enum in org.apache.accumulo.core.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html" title="class in org.apache.accumulo.core.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/accumulo/core/client/Instance.html" target="_top">Frames</a></li>
<li><a href="Instance.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2011&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>