<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_75) on Fri May 13 13:32:16 PDT 2016 -->
<title>ReplicationManagerSite (Oracle - Berkeley DB Java API)</title>
<meta name="date" content="2016-05-13">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ReplicationManagerSite (Oracle - Berkeley DB Java API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReplicationManagerSite.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"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/db/ReplicationManagerMessageDispatch.html" title="interface in com.sleepycat.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/db/ReplicationManagerSiteConfig.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/db/ReplicationManagerSite.html" target="_top">Frames</a></li>
<li><a href="ReplicationManagerSite.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.db</div>
<h2 title="Class ReplicationManagerSite" class="title">Class ReplicationManagerSite</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.db.ReplicationManagerSite</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ReplicationManagerSite</span>
extends java.lang.Object</pre>
<div class="block">A ReplicationManagerSite handle is used to manage a site in a replication group.
ReplicationManagerSite handles are opened using the <a href="../../../com/sleepycat/db/Environment.html#getReplicationManagerSite(int)"><code>Environment.getReplicationManagerSite</code></a> method.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#close()">close</a></strong>()</code>
<div class="block">Close the site.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/ReplicationHostAddress.html" title="class in com.sleepycat.db">ReplicationHostAddress</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#getAddress()">getAddress</a></strong>()</code>
<div class="block">Get the address of the site.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#getBootstrapHelper()">getBootstrapHelper</a></strong>()</code>
<div class="block">Return if the site is a helper for the local site.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/ReplicationManagerSiteConfig.html" title="class in com.sleepycat.db">ReplicationManagerSiteConfig</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#getConfig()">getConfig</a></strong>()</code>
<div class="block">Get the address and configuration of the site.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#getEid()">getEid</a></strong>()</code>
<div class="block">Get the environment id of the site.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#getGroupCreator()">getGroupCreator</a></strong>()</code>
<div class="block">Return if the site is a group creator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#getLegacy()">getLegacy</a></strong>()</code>
<div class="block">Return if the site is in a legacy group.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#getLocalSite()">getLocalSite</a></strong>()</code>
<div class="block">Return if the site is the local site.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#getPeer()">getPeer</a></strong>()</code>
<div class="block">Return if the site is peer to local site.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#remove()">remove</a></strong>()</code>
<div class="block">Remove the site.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#setBootstrapHelper(boolean)">setBootstrapHelper</a></strong>(boolean helper)</code>
<div class="block">Set the site to be a helper site.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#setGroupCreator(boolean)">setGroupCreator</a></strong>(boolean groupCreator)</code>
<div class="block">Set the site to be a group creator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#setLegacy(boolean)">setLegacy</a></strong>(boolean legacy)</code>
<div class="block">Specify the site in a legacy group.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#setLocalSite(boolean)">setLocalSite</a></strong>(boolean localSite)</code>
<div class="block">Set the site to be the local site.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/ReplicationManagerSite.html#setPeer(boolean)">setPeer</a></strong>(boolean peer)</code>
<div class="block">Set the site to be peer to local site.</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 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Close the site.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddress</h4>
<pre>public <a href="../../../com/sleepycat/db/ReplicationHostAddress.html" title="class in com.sleepycat.db">ReplicationHostAddress</a> getAddress()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Get the address of the site.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the address of the site.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getConfig()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre>public <a href="../../../com/sleepycat/db/ReplicationManagerSiteConfig.html" title="class in com.sleepycat.db">ReplicationManagerSiteConfig</a> getConfig()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Get the address and configuration of the site.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the configuration of the site.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getEid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEid</h4>
<pre>public int getEid()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Get the environment id of the site.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the environment id of the site.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="setBootstrapHelper(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBootstrapHelper</h4>
<pre>public void setBootstrapHelper(boolean helper)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Set the site to be a helper site.
<p>
A remote site may be used as a helper when the local site first joins the
replication group. Once the local site has been established as a member of
the group, this config setting is ignored.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>helper</code> - If true, the site will be a helper.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getBootstrapHelper()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBootstrapHelper</h4>
<pre>public boolean getBootstrapHelper()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Return if the site is a helper for the local site.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>If the site is a helper for the local site.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="setGroupCreator(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGroupCreator</h4>
<pre>public void setGroupCreator(boolean groupCreator)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Set the site to be a group creator.
<p>
Only the local site could be applied as a group creator. The group creator
would create the initial membership database, defining a replication group
of just the one site, rather than trying to join an existing group when it
starts for the first time.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>groupCreator</code> - If true, set the site to be a group creator.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getGroupCreator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupCreator</h4>
<pre>public boolean getGroupCreator()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Return if the site is a group creator.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>If the the site is a group creator.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="setLegacy(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLegacy</h4>
<pre>public void setLegacy(boolean legacy)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Specify the site in a legacy group. It would be considered as part of an
existing group, upgrading from a previous version of BDB. All sites in the
legacy group must specify this for themselves (the local site) and for all
other sites initially in the group.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>legacy</code> - If true, specify the site in a legacy group.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getLegacy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLegacy</h4>
<pre>public boolean getLegacy()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Return if the site is in a legacy group.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>If the site is in a legacy group.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="setLocalSite(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocalSite</h4>
<pre>public void setLocalSite(boolean localSite)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Set the site to be the local site.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>localSite</code> - If true, it is local site.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getLocalSite()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalSite</h4>
<pre>public boolean getLocalSite()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Return if the site is the local site.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>If the site is the local site.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="setPeer(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPeer</h4>
<pre>public void setPeer(boolean peer)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Set the site to be peer to local site.
<p>
A peer site may be used as a target for "client-to-client" synchronization
messages. It only makes sense to specify this for a remote site.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>peer</code> - If true, it is peer to loca site.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getPeer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPeer</h4>
<pre>public boolean getPeer()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Return if the site is peer to local site.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>If the site is peer to local site.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="remove()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>remove</h4>
<pre>public void remove()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Remove the site.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReplicationManagerSite.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"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/db/ReplicationManagerMessageDispatch.html" title="interface in com.sleepycat.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/db/ReplicationManagerSiteConfig.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/db/ReplicationManagerSite.html" target="_top">Frames</a></li>
<li><a href="ReplicationManagerSite.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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) 1996, 2016 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
