diff options
Diffstat (limited to 'content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/controller/ControllerServerConfig.html')
| -rw-r--r-- | content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/controller/ControllerServerConfig.html | 492 |
1 files changed, 492 insertions, 0 deletions
diff --git a/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/controller/ControllerServerConfig.html b/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/controller/ControllerServerConfig.html new file mode 100644 index 000000000..8dc503d5e --- /dev/null +++ b/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/controller/ControllerServerConfig.html @@ -0,0 +1,492 @@ +<!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_352) on Wed Jan 25 17:31:44 CET 2023 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ControllerServerConfig (Apache ZooKeeper - Server 3.8.1 API)</title> +<meta name="date" content="2023-01-25"> +<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="ControllerServerConfig (Apache ZooKeeper - Server 3.8.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/ControllerServerConfig.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/zookeeper/server/controller/ControllableConnectionFactory.html" title="class in org.apache.zookeeper.server.controller"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/zookeeper/server/controller/ControllerService.html" title="class in org.apache.zookeeper.server.controller"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/zookeeper/server/controller/ControllerServerConfig.html" target="_top">Frames</a></li> +<li><a href="ControllerServerConfig.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.classes.inherited.from.class.org.apache.zookeeper.server.quorum.QuorumPeerConfig">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.zookeeper.server.controller</div> +<h2 title="Class ControllerServerConfig" class="title">Class ControllerServerConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/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="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html" title="class in org.apache.zookeeper.server.quorum">org.apache.zookeeper.server.quorum.QuorumPeerConfig</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.zookeeper.server.controller.ControllerServerConfig</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ControllerServerConfig</span> +extends <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeerConfig</a></pre> +<div class="block">Config for the ControllerService. Responsible for providing the minimum set of configurations + that's required to spin up a single member ensemble.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.zookeeper.server.quorum.QuorumPeerConfig"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.zookeeper.server.quorum.<a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeerConfig</a></h3> +<code><a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.ConfigException.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeerConfig.ConfigException</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <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/zookeeper/server/controller/ControllerServerConfig.html#CLIENT_PORT_KEY">CLIENT_PORT_KEY</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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/zookeeper/server/controller/ControllerServerConfig.html#CONTROLLER_PORT_KEY">CONTROLLER_PORT_KEY</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.zookeeper.server.quorum.QuorumPeerConfig"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.zookeeper.server.quorum.<a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeerConfig</a></h3> +<code><a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#clientPortAddress">clientPortAddress</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#clientPortListenBacklog">clientPortListenBacklog</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#configFileStr">configFileStr</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#connectToLearnerMasterLimit">connectToLearnerMasterLimit</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#dataDir">dataDir</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#dataLogDir">dataLogDir</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#dynamicConfigFileStr">dynamicConfigFileStr</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#electionAlg">electionAlg</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#electionPort">electionPort</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#initialConfig">initialConfig</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#initLimit">initLimit</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#jvmPauseInfoThresholdMs">jvmPauseInfoThresholdMs</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#jvmPauseMonitorToRun">jvmPauseMonitorToRun</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#jvmPauseSleepTimeMs">jvmPauseSleepTimeMs</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#jvmPauseWarnThresholdMs">jvmPauseWarnThresholdMs</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#lastSeenQuorumVerifier">lastSeenQuorumVerifier</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#localSessionsEnabled">localSessionsEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#localSessionsUpgradingEnabled">localSessionsUpgradingEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#maxClientCnxns">maxClientCnxns</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#maxSessionTimeout">maxSessionTimeout</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#metricsProviderClassName">metricsProviderClassName</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#metricsProviderConfiguration">metricsProviderConfiguration</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#minSessionTimeout">minSessionTimeout</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#nextDynamicConfigFileSuffix">nextDynamicConfigFileSuffix</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#observerMasterPort">observerMasterPort</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#oraclePath">oraclePath</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#peerType">peerType</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#purgeInterval">purgeInterval</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#quorumCnxnThreadsSize">quorumCnxnThreadsSize</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#quorumEnableSasl">quorumEnableSasl</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#quorumLearnerLoginContext">quorumLearnerLoginContext</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#quorumLearnerRequireSasl">quorumLearnerRequireSasl</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#quorumListenOnAllIPs">quorumListenOnAllIPs</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#quorumServerLoginContext">quorumServerLoginContext</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#quorumServerRequireSasl">quorumServerRequireSasl</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#quorumServicePrincipal">quorumServicePrincipal</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#quorumVerifier">quorumVerifier</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#secureClientPortAddress">secureClientPortAddress</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#serverId">serverId</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#shouldUsePortUnification">shouldUsePortUnification</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#snapRetainCount">snapRetainCount</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#sslQuorum">sslQuorum</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#sslQuorumReloadCertFiles">sslQuorumReloadCertFiles</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#syncEnabled">syncEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#syncLimit">syncLimit</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#tickTime">tickTime</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/ControllerServerConfig.html#ControllerServerConfig-java.net.InetAddress-int-int-java.lang.String-">ControllerServerConfig</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> hostAddress, + int controllerPort, + int zkServerPort, + <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> dataDirPath)</code> +<div class="block">Instantiate a config object with required parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/ControllerServerConfig.html#ControllerServerConfig-int-int-java.lang.String-">ControllerServerConfig</a></span>(int controllerPort, + int zkServerPort, + <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> dataDirPath)</code> +<div class="block">Instantiate a config object with required parameters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/ControllerServerConfig.html#ControllerServerConfig-java.lang.String-">ControllerServerConfig</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> configFile)</code> +<div class="block">Instantiate a new config via a zk config file.</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="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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/ControllerServerConfig.html#ensureComplete--">ensureComplete</a></span>()</code> +<div class="block">Ensure config is acceptable by filling in default values for any missing quorum configuration + (specifically in the case of a single machine ensemble)</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/ControllerServerConfig.html#getControllerAddress--">getControllerAddress</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/zookeeper/server/ServerConfig.html" title="class in org.apache.zookeeper.server">ServerConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/ControllerServerConfig.html#getZooKeeperServerConfig--">getZooKeeperServerConfig</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/controller/ControllerServerConfig.html#parse-java.lang.String-">parse</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> configFile)</code> +<div class="block">Parse a ZooKeeper configuration file</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.zookeeper.server.quorum.QuorumPeerConfig"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.zookeeper.server.quorum.<a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeerConfig</a></h3> +<code><a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#areLocalSessionsEnabled--">areLocalSessionsEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#checkValidity--">checkValidity</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#configureSSLAuth--">configureSSLAuth</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#deleteFile-java.lang.String-">deleteFile</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#editStaticConfig-java.lang.String-java.lang.String-boolean-">editStaticConfig</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getClientPortAddress--">getClientPortAddress</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getClientPortListenBacklog--">getClientPortListenBacklog</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getConfigFilename--">getConfigFilename</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getConnectToLearnerMasterLimit--">getConnectToLearnerMasterLimit</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getDataDir--">getDataDir</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getDataLogDir--">getDataLogDir</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getElectionAlg--">getElectionAlg</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getElectionPort--">getElectionPort</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getInitialConfig--">getInitialConfig</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getInitLimit--">getInitLimit</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getJvmPauseInfoThresholdMs--">getJvmPauseInfoThresholdMs</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getJvmPauseSleepTimeMs--">getJvmPauseSleepTimeMs</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getJvmPauseWarnThresholdMs--">getJvmPauseWarnThresholdMs</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getLastSeenQuorumVerifier--">getLastSeenQuorumVerifier</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getMaxClientCnxns--">getMaxClientCnxns</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getMaxSessionTimeout--">getMaxSessionTimeout</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getMetricsProviderClassName--">getMetricsProviderClassName</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getMetricsProviderConfiguration--">getMetricsProviderConfiguration</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getMinSessionTimeout--">getMinSessionTimeout</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getMultiAddressReachabilityCheckTimeoutMs--">getMultiAddressReachabilityCheckTimeoutMs</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getObserverMasterPort--">getObserverMasterPort</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getPeerType--">getPeerType</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getPurgeInterval--">getPurgeInterval</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getQuorumListenOnAllIPs--">getQuorumListenOnAllIPs</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getQuorumVerifier--">getQuorumVerifier</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getSecureClientPortAddress--">getSecureClientPortAddress</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getServerId--">getServerId</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getServers--">getServers</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getSnapRetainCount--">getSnapRetainCount</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getSyncEnabled--">getSyncEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getSyncLimit--">getSyncLimit</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getTickTime--">getTickTime</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#getVersionFromFilename-java.lang.String-">getVersionFromFilename</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#isDistributed--">isDistributed</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#isJvmPauseMonitorToRun--">isJvmPauseMonitorToRun</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#isLocalSessionsUpgradingEnabled--">isLocalSessionsUpgradingEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#isMultiAddressEnabled--">isMultiAddressEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#isMultiAddressReachabilityCheckEnabled--">isMultiAddressReachabilityCheckEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#isReconfigEnabled--">isReconfigEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#isSslQuorum--">isSslQuorum</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#isStandaloneEnabled--">isStandaloneEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#parseDynamicConfig-java.util.Properties-int-boolean-boolean-java.lang.String-">parseDynamicConfig</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#parseProperties-java.util.Properties-">parseProperties</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#setReconfigEnabled-boolean-">setReconfigEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#setStandaloneEnabled-boolean-">setStandaloneEnabled</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#shouldUsePortUnification--">shouldUsePortUnification</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#writeDynamicConfig-java.lang.String-org.apache.zookeeper.server.quorum.flexible.QuorumVerifier-boolean-">writeDynamicConfig</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="CONTROLLER_PORT_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONTROLLER_PORT_KEY</h4> +<pre>public static final <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> CONTROLLER_PORT_KEY</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.zookeeper.server.controller.ControllerServerConfig.CONTROLLER_PORT_KEY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CLIENT_PORT_KEY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CLIENT_PORT_KEY</h4> +<pre>public static final <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> CLIENT_PORT_KEY</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.zookeeper.server.controller.ControllerServerConfig.CLIENT_PORT_KEY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ControllerServerConfig-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ControllerServerConfig</h4> +<pre>public ControllerServerConfig(<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> configFile) + throws <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.ConfigException.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeerConfig.ConfigException</a></pre> +<div class="block">Instantiate a new config via a zk config file.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>configFile</code> - path to the configuration file</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>ConfigException</code></dd> +<dd><code><a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.ConfigException.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeerConfig.ConfigException</a></code></dd> +</dl> +</li> +</ul> +<a name="ControllerServerConfig-java.net.InetAddress-int-int-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ControllerServerConfig</h4> +<pre>public ControllerServerConfig(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> hostAddress, + int controllerPort, + int zkServerPort, + <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> dataDirPath)</pre> +<div class="block">Instantiate a config object with required parameters.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>hostAddress</code> - The address to bind to (likely loopback or localhost)</dd> +<dd><code>controllerPort</code> - Port the controller will listen for incoming control command sent from CommandClient.</dd> +<dd><code>zkServerPort</code> - Port the ZooKeeper server will listen on.</dd> +<dd><code>dataDirPath</code> - Path to the data directory that ZooKeeperServer uses.</dd> +</dl> +</li> +</ul> +<a name="ControllerServerConfig-int-int-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ControllerServerConfig</h4> +<pre>public ControllerServerConfig(int controllerPort, + int zkServerPort, + <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> dataDirPath)</pre> +<div class="block">Instantiate a config object with required parameters.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>controllerPort</code> - Port the controller will listen for incoming control command sent from CommandClient.</dd> +<dd><code>zkServerPort</code> - Port the ZooKeeper server will listen on.</dd> +<dd><code>dataDirPath</code> - Path to the data directory that ZooKeeperServer uses.</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="getControllerAddress--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getControllerAddress</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a> getControllerAddress()</pre> +</li> +</ul> +<a name="getZooKeeperServerConfig--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getZooKeeperServerConfig</h4> +<pre>public <a href="../../../../../org/apache/zookeeper/server/ServerConfig.html" title="class in org.apache.zookeeper.server">ServerConfig</a> getZooKeeperServerConfig()</pre> +</li> +</ul> +<a name="parse-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public void parse(<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> configFile) + throws <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.ConfigException.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeerConfig.ConfigException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#parse-java.lang.String-">QuorumPeerConfig</a></code></span></div> +<div class="block">Parse a ZooKeeper configuration file</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html#parse-java.lang.String-">parse</a></code> in class <code><a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeerConfig</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>configFile</code> - the patch of the configuration file</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeerConfig.ConfigException.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeerConfig.ConfigException</a></code> - error processing configuration</dd> +</dl> +</li> +</ul> +<a name="ensureComplete--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ensureComplete</h4> +<pre>public void ensureComplete() + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Ensure config is acceptable by filling in default values for any missing quorum configuration + (specifically in the case of a single machine ensemble)</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</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> +<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/ControllerServerConfig.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/zookeeper/server/controller/ControllableConnectionFactory.html" title="class in org.apache.zookeeper.server.controller"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/zookeeper/server/controller/ControllerService.html" title="class in org.apache.zookeeper.server.controller"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/zookeeper/server/controller/ControllerServerConfig.html" target="_top">Frames</a></li> +<li><a href="ControllerServerConfig.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.classes.inherited.from.class.org.apache.zookeeper.server.quorum.QuorumPeerConfig">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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 © 2008–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |