blob: 5f21d056e7616d1708ed11a310b1eb28baa66fc9 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>MiniAccumuloConfig (Apache Accumulo Project 2.1.4 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.accumulo.minicluster, class: MiniAccumuloConfig">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/MiniAccumuloConfig.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../new-list.html">New</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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.accumulo.minicluster</a></div>
<h1 title="Class MiniAccumuloConfig" class="title">Class MiniAccumuloConfig</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.accumulo.minicluster.MiniAccumuloConfig</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MiniAccumuloConfig</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Holds configuration for <a href="MiniAccumuloCluster.html" title="class in org.apache.accumulo.minicluster"><code>MiniAccumuloCluster</code></a>. Required configurations must be passed to
constructor(s) and all other configurations are optional.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>1.5.0</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.io.File,java.lang.String)" class="member-name-link">MiniAccumuloConfig</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;dir,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;rootPassword)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefaultMemory()" class="member-name-link">getDefaultMemory</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDir()" class="member-name-link">getDir</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInstanceName()" class="member-name-link">getInstanceName</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMemory(org.apache.accumulo.minicluster.ServerType)" class="member-name-link">getMemory</a><wbr>(<a href="ServerType.html" title="enum in org.apache.accumulo.minicluster">ServerType</a>&nbsp;serverType)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNativeLibPaths()" class="member-name-link">getNativeLibPaths</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumTservers()" class="member-name-link">getNumTservers</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRootPassword()" class="member-name-link">getRootPassword</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSiteConfig()" class="member-name-link">getSiteConfig</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getZooKeeperPort()" class="member-name-link">getZooKeeperPort</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isJDWPEnabled()" class="member-name-link">isJDWPEnabled</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setClasspath(java.lang.String...)" class="member-name-link">setClasspath</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;classpathItems)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the classpath elements to use when spawning processes.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDefaultMemory(long,org.apache.accumulo.minicluster.MemoryUnit)" class="member-name-link">setDefaultMemory</a><wbr>(long&nbsp;memory,
<a href="MemoryUnit.html" title="enum in org.apache.accumulo.minicluster">MemoryUnit</a>&nbsp;memoryUnit)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the default memory size to use.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setExistingZooKeepers(java.lang.String)" class="member-name-link">setExistingZooKeepers</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;existingZooKeepers)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure an existing ZooKeeper instance to use.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInstanceName(java.lang.String)" class="member-name-link">setInstanceName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;instanceName)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Calling this method is optional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setJDWPEnabled(boolean)" class="member-name-link">setJDWPEnabled</a><wbr>(boolean&nbsp;jdwpEnabled)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMemory(org.apache.accumulo.minicluster.ServerType,long,org.apache.accumulo.minicluster.MemoryUnit)" class="member-name-link">setMemory</a><wbr>(<a href="ServerType.html" title="enum in org.apache.accumulo.minicluster">ServerType</a>&nbsp;serverType,
long&nbsp;memory,
<a href="MemoryUnit.html" title="enum in org.apache.accumulo.minicluster">MemoryUnit</a>&nbsp;memoryUnit)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the amount of memory to use in the manager process.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNativeLibPaths(java.lang.String...)" class="member-name-link">setNativeLibPaths</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;nativePathItems)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the path for processes to use for loading native libraries</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNumScanServers(int)" class="member-name-link">setNumScanServers</a><wbr>(int&nbsp;numScanServers)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Calling this method is optional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNumTservers(int)" class="member-name-link">setNumTservers</a><wbr>(int&nbsp;numTservers)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Calling this method is optional.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSiteConfig(java.util.Map)" class="member-name-link">setSiteConfig</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;siteConfig)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Calling this method is optional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setZooKeeperPort(int)" class="member-name-link">setZooKeeperPort</a><wbr>(int&nbsp;zooKeeperPort)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Calling this method is optional.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setZooKeeperStartupTime(long)" class="member-name-link">setZooKeeperStartupTime</a><wbr>(long&nbsp;zooKeeperStartupTime)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure the time to wait for ZooKeeper to startup.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.io.File,java.lang.String)">
<h3>MiniAccumuloConfig</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">MiniAccumuloConfig</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;dir,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;rootPassword)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dir</code> - An empty or nonexistent directory that Accumulo and Zookeeper can store data in.
Creating the directory is left to the user. Java 7, Guava, and Junit provide methods for
creating temporary directories.</dd>
<dd><code>rootPassword</code> - The initial password for the Accumulo root user</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="setNumTservers(int)">
<h3>setNumTservers</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setNumTservers</span><wbr><span class="parameters">(int&nbsp;numTservers)</span></div>
<div class="block">Calling this method is optional. If not set, it defaults to two.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>numTservers</code> - the number of tablet servers that mini accumulo cluster should start</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setNumScanServers(int)">
<h3>setNumScanServers</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setNumScanServers</span><wbr><span class="parameters">(int&nbsp;numScanServers)</span></div>
<div class="block">Calling this method is optional. If not set, it defaults to zero.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>numScanServers</code> - the number of scan servers that mini accumulo cluster should start</dd>
<dt>Since:</dt>
<dd>2.1.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setInstanceName(java.lang.String)">
<h3>setInstanceName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setInstanceName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;instanceName)</span></div>
<div class="block">Calling this method is optional. If not set, defaults to 'miniInstance'</div>
<dl class="notes">
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setSiteConfig(java.util.Map)">
<h3>setSiteConfig</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setSiteConfig</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;siteConfig)</span></div>
<div class="block">Calling this method is optional. If not set, it defaults to an empty map.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>siteConfig</code> - key/values that you normally put in accumulo.properties can be put here.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setZooKeeperPort(int)">
<h3>setZooKeeperPort</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setZooKeeperPort</span><wbr><span class="parameters">(int&nbsp;zooKeeperPort)</span></div>
<div class="block">Calling this method is optional. A random port is generated by default</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>zooKeeperPort</code> - A valid (and unused) port to use for the zookeeper</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setExistingZooKeepers(java.lang.String)">
<h3>setExistingZooKeepers</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setExistingZooKeepers</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;existingZooKeepers)</span></div>
<div class="block">Configure an existing ZooKeeper instance to use. Calling this method is optional. If not set, a
new ZooKeeper instance is created.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>existingZooKeepers</code> - Connection string for a already-running ZooKeeper instance. A null
value will turn off this feature.</dd>
<dt>Since:</dt>
<dd>2.1.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setZooKeeperStartupTime(long)">
<h3>setZooKeeperStartupTime</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setZooKeeperStartupTime</span><wbr><span class="parameters">(long&nbsp;zooKeeperStartupTime)</span></div>
<div class="block">Configure the time to wait for ZooKeeper to startup. Calling this method is optional. The
default is 20000 milliseconds</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>zooKeeperStartupTime</code> - Time to wait for ZooKeeper to startup, in milliseconds</dd>
<dt>Since:</dt>
<dd>1.6.1</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setMemory(org.apache.accumulo.minicluster.ServerType,long,org.apache.accumulo.minicluster.MemoryUnit)">
<h3>setMemory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setMemory</span><wbr><span class="parameters">(<a href="ServerType.html" title="enum in org.apache.accumulo.minicluster">ServerType</a>&nbsp;serverType,
long&nbsp;memory,
<a href="MemoryUnit.html" title="enum in org.apache.accumulo.minicluster">MemoryUnit</a>&nbsp;memoryUnit)</span></div>
<div class="block">Sets the amount of memory to use in the manager process. Calling this method is optional.
Default memory is 128M</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>serverType</code> - the type of server to apply the memory settings</dd>
<dd><code>memory</code> - amount of memory to set</dd>
<dd><code>memoryUnit</code> - the units for which to apply with the memory size</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setDefaultMemory(long,org.apache.accumulo.minicluster.MemoryUnit)">
<h3>setDefaultMemory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setDefaultMemory</span><wbr><span class="parameters">(long&nbsp;memory,
<a href="MemoryUnit.html" title="enum in org.apache.accumulo.minicluster">MemoryUnit</a>&nbsp;memoryUnit)</span></div>
<div class="block">Sets the default memory size to use. This value is also used when a ServerType has not been
configured explicitly. Calling this method is optional. Default memory is 128M</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>memory</code> - amount of memory to set</dd>
<dd><code>memoryUnit</code> - the units for which to apply with the memory size</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSiteConfig()">
<h3>getSiteConfig</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getSiteConfig</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>a copy of the site config</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getInstanceName()">
<h3>getInstanceName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getInstanceName</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>name of configured instance</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getZooKeeperPort()">
<h3>getZooKeeperPort</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getZooKeeperPort</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The configured zookeeper port</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getMemory(org.apache.accumulo.minicluster.ServerType)">
<h3>getMemory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getMemory</span><wbr><span class="parameters">(<a href="ServerType.html" title="enum in org.apache.accumulo.minicluster">ServerType</a>&nbsp;serverType)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>serverType</code> - get configuration for this server type</dd>
<dt>Returns:</dt>
<dd>memory configured in bytes, returns default if this server type is not configured</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDefaultMemory()">
<h3>getDefaultMemory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getDefaultMemory</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>memory configured in bytes</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDir()">
<h3>getDir</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></span>&nbsp;<span class="element-name">getDir</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the base directory of the cluster configuration</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getRootPassword()">
<h3>getRootPassword</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getRootPassword</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the root password of this cluster configuration</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNumTservers()">
<h3>getNumTservers</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getNumTservers</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the number of tservers configured for this cluster</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isJDWPEnabled()">
<h3>isJDWPEnabled</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isJDWPEnabled</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>is the current configuration in jdwpEnabled mode?</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setJDWPEnabled(boolean)">
<h3>setJDWPEnabled</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setJDWPEnabled</span><wbr><span class="parameters">(boolean&nbsp;jdwpEnabled)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jdwpEnabled</code> - should the processes run remote jdwpEnabled servers?</dd>
<dt>Returns:</dt>
<dd>the current instance</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNativeLibPaths()">
<h3>getNativeLibPaths</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span>&nbsp;<span class="element-name">getNativeLibPaths</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the paths to use for loading native libraries</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setNativeLibPaths(java.lang.String...)">
<h3>setNativeLibPaths</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setNativeLibPaths</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;nativePathItems)</span></div>
<div class="block">Sets the path for processes to use for loading native libraries</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>nativePathItems</code> - the nativePathItems to set</dd>
<dt>Since:</dt>
<dd>1.6.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setClasspath(java.lang.String...)">
<h3>setClasspath</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MiniAccumuloConfig.html" title="class in org.apache.accumulo.minicluster">MiniAccumuloConfig</a></span>&nbsp;<span class="element-name">setClasspath</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;classpathItems)</span></div>
<div class="block">Sets the classpath elements to use when spawning processes.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>classpathItems</code> - the classpathItems to set</dd>
<dt>Returns:</dt>
<dd>the current instance</dd>
<dt>Since:</dt>
<dd>2.0.0</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2011&#x2013;2025 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>