stasis/je-7.5.11/docs/java/com/sleepycat/je/rep/util/DbGroupAdmin.html

430 lines
18 KiB
HTML
Raw Normal View History

2019-06-25 20:12:40 +00:00
<!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_151) on Tue Oct 31 17:36:46 EDT 2017 -->
<title>DbGroupAdmin (Oracle - Berkeley DB Java Edition API)</title>
<meta name="date" content="2017-10-31">
<link rel="stylesheet" type="text/css" href="../../../../../style.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="DbGroupAdmin (Oracle - Berkeley DB Java Edition API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/DbGroupAdmin.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 class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/sleepycat/je/rep/util/DbEnableReplication.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/sleepycat/je/rep/util/DbPing.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/sleepycat/je/rep/util/DbGroupAdmin.html" target="_top">Frames</a></li>
<li><a href="DbGroupAdmin.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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">com.sleepycat.je.rep.util</div>
<h2 title="Class DbGroupAdmin" class="title">Class DbGroupAdmin</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.je.rep.util.DbGroupAdmin</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">DbGroupAdmin</span>
extends java.lang.Object</pre>
<div class="block">DbGroupAdmin supplies the functionality of the administrative class <a href="../../../../../com/sleepycat/je/rep/util/ReplicationGroupAdmin.html" title="class in com.sleepycat.je.rep.util"><code>ReplicationGroupAdmin</code></a> in a convenient command line utility. For example, it
can be used to display replication group information, or to remove a node
from the replication group.
<p>
Note: This utility does not handle security and authorization. It is left
to the user to ensure that the utility is invoked with proper authorization.
<p>
See <a href="../../../../../com/sleepycat/je/rep/util/DbGroupAdmin.html#main-java.lang.String...-"><code>main(java.lang.String...)</code></a> for a full description of the command line
arguments.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</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="../../../../../com/sleepycat/je/rep/util/DbGroupAdmin.html#DbGroupAdmin-java.lang.String-java.util.Set-">DbGroupAdmin</a></span>(java.lang.String&nbsp;groupName,
java.util.Set&lt;java.net.InetSocketAddress&gt;&nbsp;helperSockets)</code>
<div class="block">Create a DbGroupAdmin instance for programmatic use.</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/sleepycat/je/rep/util/DbGroupAdmin.html#dumpGroup--">dumpGroup</a></span>()</code>
<div class="block">Display group information.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/sleepycat/je/rep/util/DbGroupAdmin.html#main-java.lang.String...-">main</a></span>(java.lang.String...&nbsp;args)</code>
<div class="block">Usage:</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/sleepycat/je/rep/util/DbGroupAdmin.html#removeMember-java.lang.String-">removeMember</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Remove a node from the replication group.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/sleepycat/je/rep/util/DbGroupAdmin.html#transferMaster-java.lang.String-java.lang.String-">transferMaster</a></span>(java.lang.String&nbsp;nodeList,
java.lang.String&nbsp;timeout)</code>
<div class="block">Transfers the master role from the current master to one of the
electable replicas specified in the argument list.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/sleepycat/je/rep/util/DbGroupAdmin.html#updateAddress-java.lang.String-java.lang.String-int-">updateAddress</a></span>(java.lang.String&nbsp;nodeName,
java.lang.String&nbsp;newHostName,
int&nbsp;newPort)</code>
<div class="block">Update the network address for a specified node.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DbGroupAdmin-java.lang.String-java.util.Set-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DbGroupAdmin</h4>
<pre>public&nbsp;DbGroupAdmin(java.lang.String&nbsp;groupName,
java.util.Set&lt;java.net.InetSocketAddress&gt;&nbsp;helperSockets)</pre>
<div class="block">Create a DbGroupAdmin instance for programmatic use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>groupName</code> - replication group name</dd>
<dd><code>helperSockets</code> - set of host and port pairs for group members which
can be queried to obtain group information.</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="main-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(java.lang.String...&nbsp;args)
throws java.lang.Exception</pre>
<div class="block">Usage:
<pre>
java {com.sleepycat.je.rep.util.DbGroupAdmin |
-jar je-&lt;version&gt;.jar DbGroupAdmin}
-groupName &lt;group name&gt; # name of replication group
-helperHosts &lt;host:port&gt; # identifier for one or more members
# of the replication group which can be
# contacted for group information, in
# this format:
# hostname[:port][,hostname[:port]]*
-dumpGroup # dump group information
-removeMember &lt;node name&gt;# node to be removed
-updateAddress &lt;node name&gt; &lt;new host:port&gt;
# update the network address for a specified
# node. The node should not be alive when
# updating address
-transferMaster [-force] &lt;node1,node2,...&gt; &lt;timeout&gt;
# transfer master role to one of the
# specified nodes.
</pre></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="dumpGroup--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dumpGroup</h4>
<pre>public&nbsp;void&nbsp;dumpGroup()</pre>
<div class="block">Display group information. Lists all members and the group master. Can
be used when reviewing the <a
href="http://www.oracle.com/technetwork/database/berkeleydb/je-faq-096044.html#HAChecklist">group configuration. </a></div>
</li>
</ul>
<a name="removeMember-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMember</h4>
<pre>public&nbsp;void&nbsp;removeMember(java.lang.String&nbsp;name)</pre>
<div class="block">Remove a node from the replication group. Once removed, a
node cannot be added again to the group under the same node name.
<p><a href="../../../../../com/sleepycat/je/rep/NodeType.html#SECONDARY"><code>Secondary</code></a> nodes cannot be removed; they
automatically leave the group when they are shut down or become
disconnected from the master.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the node to be removed</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../com/sleepycat/je/rep/util/ReplicationGroupAdmin.html#removeMember-java.lang.String-"><code>ReplicationGroupAdmin.removeMember(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="updateAddress-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateAddress</h4>
<pre>public&nbsp;void&nbsp;updateAddress(java.lang.String&nbsp;nodeName,
java.lang.String&nbsp;newHostName,
int&nbsp;newPort)</pre>
<div class="block">Update the network address for a specified node. When updating the
address of a node, the node cannot be alive. See <a href="../../../../../com/sleepycat/je/rep/util/ReplicationGroupAdmin.html#updateAddress-java.lang.String-java.lang.String-int-"><code>ReplicationGroupAdmin.updateAddress(java.lang.String, java.lang.String, int)</code></a> for more information.
<p>The address of a <a href="../../../../../com/sleepycat/je/rep/NodeType.html#SECONDARY"><code>NodeType.SECONDARY</code></a> node cannot be updated
with this method, since nodes must be members but not alive to be
updated, and secondary nodes are not members when they are not alive.
To change the address of a secondary node, restart the node with the
updated address.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeName</code> - the name of the node whose address will be updated</dd>
<dd><code>newHostName</code> - the new host name of the node</dd>
<dd><code>newPort</code> - the new port number of the node</dd>
</dl>
</li>
</ul>
<a name="transferMaster-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>transferMaster</h4>
<pre>public&nbsp;void&nbsp;transferMaster(java.lang.String&nbsp;nodeList,
java.lang.String&nbsp;timeout)</pre>
<div class="block">Transfers the master role from the current master to one of the
electable replicas specified in the argument list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeList</code> - comma-separated list of nodes</dd>
<dd><code>timeout</code> - in <a href="../../EnvironmentConfig.html#timeDuration">
same form</a> as accepted by duration config params</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../com/sleepycat/je/rep/ReplicatedEnvironment.html#transferMaster-java.util.Set-int-java.util.concurrent.TimeUnit-"><code>ReplicatedEnvironment.transferMaster(java.util.Set&lt;java.lang.String&gt;, int, java.util.concurrent.TimeUnit)</code></a></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/DbGroupAdmin.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 class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/sleepycat/je/rep/util/DbEnableReplication.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/sleepycat/je/rep/util/DbPing.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/sleepycat/je/rep/util/DbGroupAdmin.html" target="_top">Frames</a></li>
<li><a href="DbGroupAdmin.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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><font size=1>Copyright (c) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
</body>
</html>