2412 lines
107 KiB
HTML
2412 lines
107 KiB
HTML
<!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>ReplicationConfig (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="ReplicationConfig (Oracle - Berkeley DB Java Edition API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":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/ReplicationConfig.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/ReplicatedEnvironmentStats.html" title="class in com.sleepycat.je.rep"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/sleepycat/je/rep/ReplicationGroup.html" title="class in com.sleepycat.je.rep"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/sleepycat/je/rep/ReplicationConfig.html" target="_top">Frames</a></li>
|
|
<li><a href="ReplicationConfig.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><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">com.sleepycat.je.rep</div>
|
|
<h2 title="Class ReplicationConfig" class="title">Class ReplicationConfig</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html" title="class in com.sleepycat.je.rep">com.sleepycat.je.rep.ReplicationMutableConfig</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.sleepycat.je.rep.ReplicationConfig</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd>com.sleepycat.je.dbi.RepConfigProxy, java.io.Serializable, java.lang.Cloneable</dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="typeNameLabel">ReplicationConfig</span>
|
|
extends <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html" title="class in com.sleepycat.je.rep">ReplicationMutableConfig</a>
|
|
implements com.sleepycat.je.dbi.RepConfigProxy</pre>
|
|
<div class="block">Specifies the immutable attributes of a replicated environment.
|
|
<p>
|
|
To change the default settings for a replicated environment, an application
|
|
creates a configuration object, customizes settings and uses it for <a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.html" title="class in com.sleepycat.je.rep"><code>ReplicatedEnvironment</code></a> construction. The set methods of this class validate
|
|
the configuration values when the method is invoked. An
|
|
IllegalArgumentException is thrown if the value is not valid for that
|
|
attribute.
|
|
<p>
|
|
Note that ReplicationConfig only describes those attributes which must be
|
|
set at <code>ReplicatedEnvironment</code> construction time, while its superclass
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html" title="class in com.sleepycat.je.rep"><code>ReplicationMutableConfig</code></a> describes attributes that may be modified
|
|
during the life of the replication group.
|
|
<p>
|
|
ReplicationConfig follows precedence rules similar to those of
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html" title="class in com.sleepycat.je"><code>EnvironmentConfig</code></a>.
|
|
<ol>
|
|
<li>Configuration parameters specified
|
|
in <environmentHome>/je.properties take first precedence.</li>
|
|
<li>Configuration parameters set in the ReplicationConfig object used
|
|
at <code>ReplicatedEnvironment</code> construction are next.</li>
|
|
<li>Any configuration parameters not set by the application are set to
|
|
system defaults, described along with the parameter name String constants
|
|
in this class.</li>
|
|
</ol>
|
|
<p>
|
|
After a <code>ReplicatedEnvironment</code> has been constructed, its mutable
|
|
properties may be changed using <code>ReplicatedEnvironment#setMutableConfig</code>. See <code>ReplicationMutableConfig</code> for a list of mutable properties; all other
|
|
properties are immutable. Whether a property is mutable or immutable is
|
|
also described along with the parameter name String constants in this class.
|
|
|
|
<h4>Getting the Current ReplicatedEnvironment Properties</h4>
|
|
|
|
To get the current "live" properties of a replicated environment after
|
|
constructing it or changing its properties, you must call <a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.html#getRepConfig--"><code>ReplicatedEnvironment.getRepConfig()</code></a> or <a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.html#getRepMutableConfig--"><code>ReplicatedEnvironment.getRepMutableConfig()</code></a>. The original ReplicationConfig
|
|
or ReplicationMutableConfig object used to set the properties is not kept up
|
|
to date as properties are changed, and does not reflect property validation
|
|
or properties that are computed.</div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../serialized-form.html#com.sleepycat.je.rep.ReplicationConfig">Serialized Form</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== 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 java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ARBITER_OUTPUT_QUEUE_SIZE">ARBITER_OUTPUT_QUEUE_SIZE</a></span></code>
|
|
<div class="block">The size of the the queue used to hold commit records that the Feeder
|
|
uses to request acknowledgment from an Arbiter.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#BIND_INADDR_ANY">BIND_INADDR_ANY</a></span></code>
|
|
<div class="block">When this configuration parameter is set to true, it binds the HA socket
|
|
to INADDR_ANY, so that HA services are available on all network
|
|
interfaces.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#CONSISTENCY_POLICY">CONSISTENCY_POLICY</a></span></code>
|
|
<div class="block">The default consistency policy used by a replica.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#DEFAULT_PORT">DEFAULT_PORT</a></span></code>
|
|
<div class="block">The default port used for replication.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ELECTIONS_PRIMARY_RETRIES">ELECTIONS_PRIMARY_RETRIES</a></span></code>
|
|
<div class="block">The number of times an unsuccessful election will be retried by a
|
|
designated <code>Primary</code> in a two node group before it is
|
|
activated and becomes the Master.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ELECTIONS_REBROADCAST_PERIOD">ELECTIONS_REBROADCAST_PERIOD</a></span></code>
|
|
<div class="block">The time interval between rebroadcasts of election results by the master
|
|
node to all nodes not currently connected to it.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ENV_CONSISTENCY_TIMEOUT">ENV_CONSISTENCY_TIMEOUT</a></span></code>
|
|
<div class="block">The amount of time to wait for a Replica to become consistent with the
|
|
Master, when a <code>ReplicatedEnvironment</code> handle is created and
|
|
no <code>ConsistencyPolicy</code> is specified.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ENV_SETUP_TIMEOUT">ENV_SETUP_TIMEOUT</a></span></code>
|
|
<div class="block">The maximum amount of time for the internal housekeeping, like
|
|
elections, syncup with the master, etc.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ENV_UNKNOWN_STATE_TIMEOUT">ENV_UNKNOWN_STATE_TIMEOUT</a></span></code>
|
|
<div class="block">Permits opening of a ReplicatedEnvironment handle in the
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.State.html#UNKNOWN"><code>ReplicatedEnvironment.State.UNKNOWN</code></a> state, if a Master cannot be
|
|
determined within this timeout period.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#FEEDER_TIMEOUT">FEEDER_TIMEOUT</a></span></code>
|
|
<div class="block">A heartbeat is exchanged between the feeder and replica to ensure they
|
|
are alive.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#GROUP_NAME">GROUP_NAME</a></span></code>
|
|
<div class="block">The name for the replication group.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#HELPER_HOSTS">HELPER_HOSTS</a></span></code>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="block"><span class="deprecationComment">replaced by <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#HELPER_HOSTS"><code>ReplicationMutableConfig.HELPER_HOSTS</code></a>.</span></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#INSUFFICIENT_REPLICAS_TIMEOUT">INSUFFICIENT_REPLICAS_TIMEOUT</a></span></code>
|
|
<div class="block">The amount of time that a
|
|
<a href="../../../../com/sleepycat/je/Environment.html#beginTransaction-com.sleepycat.je.Transaction-com.sleepycat.je.TransactionConfig-"><code>Environment.beginTransaction(com.sleepycat.je.Transaction, com.sleepycat.je.TransactionConfig)</code></a>
|
|
on the Master will wait for a sufficient number of electable Replicas,
|
|
as determined by the default <code>Durability</code> policy, to contact
|
|
the Master.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#MAX_CLOCK_DELTA">MAX_CLOCK_DELTA</a></span></code>
|
|
<div class="block">Sets the maximum acceptable clock skew between this Replica and its
|
|
Feeder, which is the node that is the source of its replication stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#MAX_MESSAGE_SIZE">MAX_MESSAGE_SIZE</a></span></code>
|
|
<div class="block">The maximum message size which will be accepted by a node (to prevent
|
|
DOS attacks).</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#NODE_HOST_PORT">NODE_HOST_PORT</a></span></code>
|
|
<div class="block">Names the hostname and port associated with this node in the
|
|
replication group, e.g.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#NODE_NAME">NODE_NAME</a></span></code>
|
|
<div class="block">The node name uniquely identifies this node within the replication
|
|
group.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#NODE_TYPE">NODE_TYPE</a></span></code>
|
|
<div class="block">The type of this node.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#PROTOCOL_OLD_STRING_ENCODING">PROTOCOL_OLD_STRING_ENCODING</a></span></code>
|
|
<div class="block">When set to <code>true</code>, which is currently the default, the
|
|
replication network protocol will use the JVM platform default charset
|
|
(text encoding) for node names and host names.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REP_STREAM_TIMEOUT">REP_STREAM_TIMEOUT</a></span></code>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="block"><span class="deprecationComment">and no longer used as of JE 7.5. Reserved files are now
|
|
retained based on available disk space -- see
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#MAX_DISK"><code>EnvironmentConfig.MAX_DISK</code></a> and
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#FREE_DISK"><code>EnvironmentConfig.FREE_DISK</code></a> should be used instead.
|
|
However, this param is still used when some, but not all, nodes in a
|
|
group have been upgraded to 7.5 or later.</span></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLAY_COST_PERCENT">REPLAY_COST_PERCENT</a></span></code>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="block"><span class="deprecationComment">and no longer used as of JE 7.5. Reserved files are now
|
|
retained based on available disk space -- see
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#MAX_DISK"><code>EnvironmentConfig.MAX_DISK</code></a> and
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#FREE_DISK"><code>EnvironmentConfig.FREE_DISK</code></a> should be used instead.</span></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLAY_DB_HANDLE_TIMEOUT">REPLAY_DB_HANDLE_TIMEOUT</a></span></code>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="block"><span class="deprecationComment">replaced by <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#REPLAY_DB_HANDLE_TIMEOUT"><code>ReplicationMutableConfig.REPLAY_DB_HANDLE_TIMEOUT</code></a>.</span></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLAY_FREE_DISK_PERCENT">REPLAY_FREE_DISK_PERCENT</a></span></code>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="block"><span class="deprecationComment">and no longer needed as of JE 7.5. Reserved files are now
|
|
retained based on available disk space -- see
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#MAX_DISK"><code>EnvironmentConfig.MAX_DISK</code></a> and
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#FREE_DISK"><code>EnvironmentConfig.FREE_DISK</code></a> should be used instead.
|
|
However, this param is still used when it has been specified and
|
|
is non-zero, and FREE_DISK has not been specified. In this case,
|
|
REPLAY_FREE_DISK_PERCENT overrides the FREE_DISK default value. If
|
|
both REPLAY_FREE_DISK_PERCENT and FREE_DISK are specified, an
|
|
IllegalArgumentException is thrown.</span></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLAY_MAX_OPEN_DB_HANDLES">REPLAY_MAX_OPEN_DB_HANDLES</a></span></code>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="block"><span class="deprecationComment">replaced by <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#REPLAY_MAX_OPEN_DB_HANDLES"><code>ReplicationMutableConfig.REPLAY_MAX_OPEN_DB_HANDLES</code></a>.</span></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLAY_TXN_LOCK_TIMEOUT">REPLAY_TXN_LOCK_TIMEOUT</a></span></code>
|
|
<div class="block">The maximum amount of time for a replay transaction to wait for a lock.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLICA_ACK_TIMEOUT">REPLICA_ACK_TIMEOUT</a></span></code>
|
|
<div class="block">The amount of time that the
|
|
<a href="../../../../com/sleepycat/je/Transaction.html#commit-com.sleepycat.je.Durability-"><code>Transaction.commit(com.sleepycat.je.Durability)</code></a>
|
|
on the Master will wait for a sufficient number of acknowledgments from
|
|
electable Replicas.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLICA_GROUP_COMMIT_INTERVAL">REPLICA_GROUP_COMMIT_INTERVAL</a></span></code>
|
|
<div class="block">The time interval during which transactions may be grouped to amortize
|
|
the cost of fsync when a transaction commits with SyncPolicy#SYNC on the
|
|
Replica.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLICA_MAX_GROUP_COMMIT">REPLICA_MAX_GROUP_COMMIT</a></span></code>
|
|
<div class="block">The maximum number of transactions that can be grouped to amortize the
|
|
cost of an fsync when a transaction commits with SyncPolicy#SYNC on the
|
|
Replica.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLICA_RECEIVE_BUFFER_SIZE">REPLICA_RECEIVE_BUFFER_SIZE</a></span></code>
|
|
<div class="block">The size of the the TCP receive buffer associated with the socket used
|
|
by the replica to transfer the replication stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLICA_TIMEOUT">REPLICA_TIMEOUT</a></span></code>
|
|
<div class="block">A heartbeat is exchanged between the feeder and replica to ensure they
|
|
are alive.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#TXN_ROLLBACK_DISABLED">TXN_ROLLBACK_DISABLED</a></span></code>
|
|
<div class="block">In rare cases, a node may need to rollback committed transactions in
|
|
order to rejoin a replication group.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#TXN_ROLLBACK_LIMIT">TXN_ROLLBACK_LIMIT</a></span></code>
|
|
<div class="block">In rare cases, a node may need to rollback committed transactions in
|
|
order to rejoin a replication group.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields.inherited.from.class.com.sleepycat.je.rep.ReplicationMutableConfig">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from class com.sleepycat.je.rep.<a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html" title="class in com.sleepycat.je.rep">ReplicationMutableConfig</a></h3>
|
|
<code><a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#ALLOW_ARBITER_ACK">ALLOW_ARBITER_ACK</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#DESIGNATED_PRIMARY">DESIGNATED_PRIMARY</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#ELECTABLE_GROUP_SIZE_OVERRIDE">ELECTABLE_GROUP_SIZE_OVERRIDE</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#LOG_FLUSH_TASK_INTERVAL">LOG_FLUSH_TASK_INTERVAL</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#NODE_PRIORITY">NODE_PRIORITY</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#RUN_LOG_FLUSH_TASK">RUN_LOG_FLUSH_TASK</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="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ReplicationConfig--">ReplicationConfig</a></span>()</code>
|
|
<div class="block">Creates a ReplicationConfig initialized with the system default
|
|
settings.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ReplicationConfig-java.util.Properties-">ReplicationConfig</a></span>(java.util.Properties properties)</code>
|
|
<div class="block">Creates a ReplicationConfig which includes the properties specified in
|
|
the properties parameter.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ReplicationConfig-java.lang.String-java.lang.String-java.lang.String-">ReplicationConfig</a></span>(java.lang.String groupName,
|
|
java.lang.String nodeName,
|
|
java.lang.String hostPort)</code>
|
|
<div class="block">Creates a ReplicationConfig initialized with the system default
|
|
settings and the specified group name, node name, and hostname/port
|
|
values.</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><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#clone--">clone</a></span>()</code>
|
|
<div class="block">Returns a copy of this configuration object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/ReplicaConsistencyPolicy.html" title="interface in com.sleepycat.je">ReplicaConsistencyPolicy</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getConsistencyPolicy--">getConsistencyPolicy</a></span>()</code>
|
|
<div class="block">Returns the default consistency policy associated with the
|
|
configuration.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getGroupName--">getGroupName</a></span>()</code>
|
|
<div class="block">Gets the name associated with the replication group.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getMaxClockDelta-java.util.concurrent.TimeUnit-">getMaxClockDelta</a></span>(java.util.concurrent.TimeUnit unit)</code>
|
|
<div class="block">Returns the maximum acceptable clock skew between this Replica and its
|
|
Feeder, which is the node that is the source of its replication stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getNodeHostname--">getNodeHostname</a></span>()</code>
|
|
<div class="block">Returns the hostname component of the nodeHost property.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getNodeHostPort--">getNodeHostPort</a></span>()</code>
|
|
<div class="block">Returns the hostname and port associated with this node.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getNodeName--">getNodeName</a></span>()</code>
|
|
<div class="block">Returns the unique name associated with this node.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getNodePort--">getNodePort</a></span>()</code>
|
|
<div class="block">Returns the port component of the nodeHost property.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/NodeType.html" title="enum in com.sleepycat.je.rep">NodeType</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getNodeType--">getNodeType</a></span>()</code>
|
|
<div class="block">Returns the <a href="../../../../com/sleepycat/je/rep/NodeType.html" title="enum in com.sleepycat.je.rep"><code>NodeType</code></a> of this node.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getReplicaAckTimeout-java.util.concurrent.TimeUnit-">getReplicaAckTimeout</a></span>(java.util.concurrent.TimeUnit unit)</code>
|
|
<div class="block">Returns the configured replica timeout value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je">ProgressListener</a><<a href="../../../../com/sleepycat/je/rep/SyncupProgress.html" title="enum in com.sleepycat.je.rep">SyncupProgress</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getSyncupProgressListener--">getSyncupProgressListener</a></span>()</code>
|
|
<div class="block">Return the ProgressListener to be used at this environment startup.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setConfigParam-java.lang.String-java.lang.String-">setConfigParam</a></span>(java.lang.String paramName,
|
|
java.lang.String value)</code>
|
|
<div class="block">Set this configuration parameter with this value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setConsistencyPolicy-com.sleepycat.je.ReplicaConsistencyPolicy-">setConsistencyPolicy</a></span>(<a href="../../../../com/sleepycat/je/ReplicaConsistencyPolicy.html" title="interface in com.sleepycat.je">ReplicaConsistencyPolicy</a> policy)</code>
|
|
<div class="block">Sets the consistency policy to be associated with the configuration.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setGroupName-java.lang.String-">setGroupName</a></span>(java.lang.String groupName)</code>
|
|
<div class="block">Sets the name for the replication group.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setMaxClockDelta-long-java.util.concurrent.TimeUnit-">setMaxClockDelta</a></span>(long maxClockDelta,
|
|
java.util.concurrent.TimeUnit unit)</code>
|
|
<div class="block">Sets the maximum acceptable clock skew between this Replica and its
|
|
Feeder, which is the node that is the source of its replication
|
|
stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setNodeHostPort-java.lang.String-">setNodeHostPort</a></span>(java.lang.String hostPort)</code>
|
|
<div class="block">Sets the hostname and port associated with this node.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setNodeName-java.lang.String-">setNodeName</a></span>(java.lang.String nodeName)</code>
|
|
<div class="block">Sets the name to be associated with this node.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setNodeType-com.sleepycat.je.rep.NodeType-">setNodeType</a></span>(<a href="../../../../com/sleepycat/je/rep/NodeType.html" title="enum in com.sleepycat.je.rep">NodeType</a> nodeType)</code>
|
|
<div class="block">Sets the type of this node.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setReplicaAckTimeout-long-java.util.concurrent.TimeUnit-">setReplicaAckTimeout</a></span>(long replicaAckTimeout,
|
|
java.util.concurrent.TimeUnit unit)</code>
|
|
<div class="block">Set the replica commit timeout.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setSyncupProgressListener-com.sleepycat.je.ProgressListener-">setSyncupProgressListener</a></span>(<a href="../../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je">ProgressListener</a><<a href="../../../../com/sleepycat/je/rep/SyncupProgress.html" title="enum in com.sleepycat.je.rep">SyncupProgress</a>> progressListener)</code>
|
|
<div class="block">Configure the environment to make periodic calls to a <a href="../../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je"><code>ProgressListener</code></a> to provide feedback on replication stream sync-up.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.com.sleepycat.je.rep.ReplicationMutableConfig">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class com.sleepycat.je.rep.<a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html" title="class in com.sleepycat.je.rep">ReplicationMutableConfig</a></h3>
|
|
<code><a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#getConfigParam-java.lang.String-">getConfigParam</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#getDesignatedPrimary--">getDesignatedPrimary</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#getElectableGroupSizeOverride--">getElectableGroupSizeOverride</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#getHelperHosts--">getHelperHosts</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#getNodePriority--">getNodePriority</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#setDesignatedPrimary-boolean-">setDesignatedPrimary</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#setElectableGroupSizeOverride-int-">setElectableGroupSizeOverride</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#setHelperHosts-java.lang.String-">setHelperHosts</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#setNodePriority-int-">setNodePriority</a>, <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#toString--">toString</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.Object</h3>
|
|
<code>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="GROUP_NAME">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>GROUP_NAME</h4>
|
|
<pre>public static final java.lang.String GROUP_NAME</pre>
|
|
<div class="block">The name for the replication group.
|
|
The name should consist of letters, digits, and/or hyphen ("-"),
|
|
underscore ("_"), or period (".").
|
|
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td><td>Default</td></tr>
|
|
<tr>
|
|
<td>"je.rep.groupName"</td>
|
|
<td>String</td>
|
|
<td>No</td>
|
|
<td>"DefaultGroup"</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setGroupName-java.lang.String-"><code>setGroupName(java.lang.String)</code></a>,
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getGroupName--"><code>getGroupName()</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.GROUP_NAME">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="NODE_NAME">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>NODE_NAME</h4>
|
|
<pre>public static final java.lang.String NODE_NAME</pre>
|
|
<div class="block">The node name uniquely identifies this node within the replication
|
|
group.
|
|
The name should consist of letters, digits, and/or hyphen ("-"),
|
|
underscore ("_"), or period (".").
|
|
|
|
<p>Note that the node name is immutable. Normally the host name should
|
|
not be used as the node name, unless you intend to reuse the host
|
|
name when a machine fails and is replaced, or the node is upgraded to
|
|
new hardware.</p>
|
|
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td><td>Default</td></tr>
|
|
<tr>
|
|
<td>"je.rep.nodeName"</td>
|
|
<td>String</td>
|
|
<td>No</td>
|
|
<td>"DefaultRepNodeName"</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setNodeName-java.lang.String-"><code>setNodeName(java.lang.String)</code></a>,
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getNodeName--"><code>getNodeName()</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.NODE_NAME">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="NODE_TYPE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>NODE_TYPE</h4>
|
|
<pre>public static final java.lang.String NODE_TYPE</pre>
|
|
<div class="block">The type of this node.
|
|
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td><td>Default</td></tr>
|
|
<tr>
|
|
<td>"je.rep.nodeType"</td>
|
|
<td><a href="../../../../com/sleepycat/je/rep/NodeType.html" title="enum in com.sleepycat.je.rep"><code>NodeType</code></a></td>
|
|
<td>No</td>
|
|
<td>ELECTABLE</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setNodeType-com.sleepycat.je.rep.NodeType-"><code>setNodeType(com.sleepycat.je.rep.NodeType)</code></a>,
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getNodeType--"><code>getNodeType()</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.NODE_TYPE">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="HELPER_HOSTS">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>HELPER_HOSTS</h4>
|
|
<pre>@Deprecated
|
|
public static final java.lang.String HELPER_HOSTS</pre>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">replaced by <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#HELPER_HOSTS"><code>ReplicationMutableConfig.HELPER_HOSTS</code></a>.</span></div>
|
|
<div class="block">The string identifying one or more helper host and port pairs in
|
|
this format:
|
|
<pre>
|
|
hostname[:port][,hostname[:port]]*
|
|
</pre>
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td><td>Default</td></tr>
|
|
<tr>
|
|
<td>"je.rep.helperHosts"</td>
|
|
<td>String</td>
|
|
<td>No</td>
|
|
<td>""</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#setHelperHosts-java.lang.String-"><code>ReplicationMutableConfig.setHelperHosts(java.lang.String)</code></a>,
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#getHelperHosts--"><code>ReplicationMutableConfig.getHelperHosts()</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.HELPER_HOSTS">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="DEFAULT_PORT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>DEFAULT_PORT</h4>
|
|
<pre>public static final java.lang.String DEFAULT_PORT</pre>
|
|
<div class="block">The default port used for replication.
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td>
|
|
<td>Default</td><td>Minimum</td><td>Maximum</td></tr>
|
|
<tr>
|
|
<td>"je.rep.defaultPort"</td>
|
|
<td>Integer</td>
|
|
<td>No</td>
|
|
<td>5001</td>
|
|
<td>1024</td>
|
|
<td>Short.MAX_VALUE</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.DEFAULT_PORT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="NODE_HOST_PORT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>NODE_HOST_PORT</h4>
|
|
<pre>public static final java.lang.String NODE_HOST_PORT</pre>
|
|
<div class="block">Names the hostname and port associated with this node in the
|
|
replication group, e.g. je.rep.nodeHostPort=foo.com:5001.
|
|
<p>
|
|
The hostname is defaulted to "localhost" to make it easy to prototype
|
|
and to execute the examples, but the user should be very sure to set a
|
|
specific hostname before starting nodes on multiple machines. The value
|
|
of je.rep.nodeHostPort is saved persistently in replication group
|
|
metadata and is expected to be a unique address, and a value of
|
|
"localhost" in the replication metadata will cause severe communication
|
|
confusion.
|
|
<p>
|
|
The port portion of the host value is optional. If it's not specified,
|
|
the value of "je.rep.defaultPort" is used.
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td><td>Default</td></tr>
|
|
<tr>
|
|
<td>"je.rep.nodeHostPort"</td>
|
|
<td>String</td>
|
|
<td>No</td>
|
|
<td>"localhost"</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setNodeHostPort-java.lang.String-"><code>setNodeHostPort(java.lang.String)</code></a>,
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getNodeHostPort--"><code>getNodeHostPort()</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.NODE_HOST_PORT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="BIND_INADDR_ANY">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>BIND_INADDR_ANY</h4>
|
|
<pre>public static final java.lang.String BIND_INADDR_ANY</pre>
|
|
<div class="block">When this configuration parameter is set to true, it binds the HA socket
|
|
to INADDR_ANY, so that HA services are available on all network
|
|
interfaces. The default value (false) results in the HA socket being
|
|
bound to the specific interface specified by the <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#NODE_HOST_PORT"><code>NODE_HOST_PORT</code></a>
|
|
configuration.
|
|
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.bindInaddrAny"</td>
|
|
<td>Boolean</td>
|
|
<td>No</td>
|
|
<td>false</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.BIND_INADDR_ANY">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="CONSISTENCY_POLICY">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>CONSISTENCY_POLICY</h4>
|
|
<pre>public static final java.lang.String CONSISTENCY_POLICY</pre>
|
|
<div class="block">The default consistency policy used by a replica. This value is used
|
|
when no <a href="../../../../com/sleepycat/je/TransactionConfig.html#setConsistencyPolicy-com.sleepycat.je.ReplicaConsistencyPolicy-"><code>transaction consistency policy</code></a> is specified, including when a null
|
|
<code>Transaction</code> parameter is used for a read operation.
|
|
<p>
|
|
Only two
|
|
policies are meaningful as properties denoting environment level default
|
|
policies: <a href="../../../../com/sleepycat/je/rep/NoConsistencyRequiredPolicy.html" title="class in com.sleepycat.je.rep"><code>NoConsistencyRequiredPolicy</code></a> and
|
|
<a href="../../../../com/sleepycat/je/rep/TimeConsistencyPolicy.html" title="class in com.sleepycat.je.rep"><code>TimeConsistencyPolicy</code></a>. They
|
|
can be specified as:
|
|
<pre> NoConsistencyRequiredPolicy</pre>
|
|
or
|
|
<pre> <code> TimeConsistencyPolicy(<permissibleLag>,<timeout>)</code></pre>
|
|
where <code><permissibleLag></code> and <code><timeout></code> are <a
|
|
href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>.
|
|
<p>
|
|
For example, a time based consistency policy with a lag of one second
|
|
and a timeout of one hour is denoted by the string:
|
|
<code>TimeConsistencyPolicy(1 s,1 h)</code>
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td><td>Default</td></tr>
|
|
<tr>
|
|
<td>"je.rep.consistencyPolicy"</td>
|
|
<td>String</td>
|
|
<td>No</td>
|
|
<td>"TimeConsistencyPolicy(1 s,1 h)"</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setConsistencyPolicy-com.sleepycat.je.ReplicaConsistencyPolicy-"><code>setConsistencyPolicy(com.sleepycat.je.ReplicaConsistencyPolicy)</code></a>,
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getConsistencyPolicy--"><code>getConsistencyPolicy()</code></a>,
|
|
<a href="../../../../com/sleepycat/je/TransactionConfig.html#setConsistencyPolicy-com.sleepycat.je.ReplicaConsistencyPolicy-"><code>TransactionConfig.setConsistencyPolicy(com.sleepycat.je.ReplicaConsistencyPolicy)</code></a>,
|
|
<a href="../../../../com/sleepycat/je/TransactionConfig.html#getConsistencyPolicy--"><code>TransactionConfig.getConsistencyPolicy()</code></a>,
|
|
<a href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.CONSISTENCY_POLICY">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REP_STREAM_TIMEOUT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REP_STREAM_TIMEOUT</h4>
|
|
<pre>public static final java.lang.String REP_STREAM_TIMEOUT</pre>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">and no longer used as of JE 7.5. Reserved files are now
|
|
retained based on available disk space -- see
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#MAX_DISK"><code>EnvironmentConfig.MAX_DISK</code></a> and
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#FREE_DISK"><code>EnvironmentConfig.FREE_DISK</code></a> should be used instead.
|
|
However, this param is still used when some, but not all, nodes in a
|
|
group have been upgraded to 7.5 or later.</span></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REP_STREAM_TIMEOUT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REPLAY_COST_PERCENT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REPLAY_COST_PERCENT</h4>
|
|
<pre>public static final java.lang.String REPLAY_COST_PERCENT</pre>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">and no longer used as of JE 7.5. Reserved files are now
|
|
retained based on available disk space -- see
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#MAX_DISK"><code>EnvironmentConfig.MAX_DISK</code></a> and
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#FREE_DISK"><code>EnvironmentConfig.FREE_DISK</code></a> should be used instead.</span></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REPLAY_COST_PERCENT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REPLAY_FREE_DISK_PERCENT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REPLAY_FREE_DISK_PERCENT</h4>
|
|
<pre>public static final java.lang.String REPLAY_FREE_DISK_PERCENT</pre>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">and no longer needed as of JE 7.5. Reserved files are now
|
|
retained based on available disk space -- see
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#MAX_DISK"><code>EnvironmentConfig.MAX_DISK</code></a> and
|
|
<a href="../../../../com/sleepycat/je/EnvironmentConfig.html#FREE_DISK"><code>EnvironmentConfig.FREE_DISK</code></a> should be used instead.
|
|
However, this param is still used when it has been specified and
|
|
is non-zero, and FREE_DISK has not been specified. In this case,
|
|
REPLAY_FREE_DISK_PERCENT overrides the FREE_DISK default value. If
|
|
both REPLAY_FREE_DISK_PERCENT and FREE_DISK are specified, an
|
|
IllegalArgumentException is thrown.</span></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REPLAY_FREE_DISK_PERCENT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REPLAY_TXN_LOCK_TIMEOUT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REPLAY_TXN_LOCK_TIMEOUT</h4>
|
|
<pre>public static final java.lang.String REPLAY_TXN_LOCK_TIMEOUT</pre>
|
|
<div class="block">The maximum amount of time for a replay transaction to wait for a lock.
|
|
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td>
|
|
<td>Default</td><td>Minimum</td><td>Maximum</td></tr>
|
|
<tr>
|
|
<td>"je.rep.replayTxnLockTimeout"</td>
|
|
<td>
|
|
<a href="../EnvironmentConfig.html#timeDuration">Duration</a>
|
|
</td>
|
|
<td>No</td>
|
|
<td>500 ms</td>
|
|
<td>1 ms</td>
|
|
<td>75 min</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REPLAY_TXN_LOCK_TIMEOUT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REPLAY_MAX_OPEN_DB_HANDLES">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REPLAY_MAX_OPEN_DB_HANDLES</h4>
|
|
<pre>@Deprecated
|
|
public static final java.lang.String REPLAY_MAX_OPEN_DB_HANDLES</pre>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">replaced by <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#REPLAY_MAX_OPEN_DB_HANDLES"><code>ReplicationMutableConfig.REPLAY_MAX_OPEN_DB_HANDLES</code></a>.</span></div>
|
|
<div class="block">The maximum number of <i>most recently used</i> database handles that
|
|
are kept open during the replay of the replication stream.
|
|
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td>
|
|
<td>Default</td><td>Minimum</td><td>Maximum</td></tr>
|
|
<tr>
|
|
<td>"je.rep.replayMaxOpenDbHandles"</td>
|
|
<td>Int</td>
|
|
<td>Yes</td>
|
|
<td>10</td>
|
|
<td>1</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REPLAY_MAX_OPEN_DB_HANDLES">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REPLAY_DB_HANDLE_TIMEOUT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REPLAY_DB_HANDLE_TIMEOUT</h4>
|
|
<pre>@Deprecated
|
|
public static final java.lang.String REPLAY_DB_HANDLE_TIMEOUT</pre>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">replaced by <a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#REPLAY_DB_HANDLE_TIMEOUT"><code>ReplicationMutableConfig.REPLAY_DB_HANDLE_TIMEOUT</code></a>.</span></div>
|
|
<div class="block">The maximum amount of time that an inactive database handle is kept open
|
|
during a replay of the replication stream. Handles that are inactive for
|
|
more than this time period are automatically closed. Note that this does
|
|
not impact any handles that may have been opened by the application.
|
|
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td>
|
|
<td>Default</td><td>Minimum</td><td>Maximum</td></tr>
|
|
<tr>
|
|
<td>"je.rep.replayOpenHandleTimeout"</td>
|
|
<td><a href="#timeDuration">Duration</a></td>
|
|
<td>Yes</td>
|
|
<td>30 sec</td>
|
|
<td>1 sec</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REPLAY_DB_HANDLE_TIMEOUT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ENV_CONSISTENCY_TIMEOUT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ENV_CONSISTENCY_TIMEOUT</h4>
|
|
<pre>public static final java.lang.String ENV_CONSISTENCY_TIMEOUT</pre>
|
|
<div class="block">The amount of time to wait for a Replica to become consistent with the
|
|
Master, when a <code>ReplicatedEnvironment</code> handle is created and
|
|
no <code>ConsistencyPolicy</code> is specified. If the Replica does not
|
|
become consistent within this period, a
|
|
<code>ReplicaConsistencyException</code> is thrown by the
|
|
<code>ReplicatedEnvironment</code> constructor.
|
|
<p>
|
|
If an explicit <code>ConsistencyPolicy</code> is specified via a
|
|
constructor argument, then the timeout defined by the
|
|
<code>ConsistencyPolicy</code> argument is used instead of this default.
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.envConsistencyTimeout"</td>
|
|
<td>
|
|
<a href="../EnvironmentConfig.html#timeDuration">Duration</a>
|
|
</td>
|
|
<td>No</td>
|
|
<td>5 min</td>
|
|
<td>10 ms</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.ENV_CONSISTENCY_TIMEOUT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REPLICA_ACK_TIMEOUT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REPLICA_ACK_TIMEOUT</h4>
|
|
<pre>public static final java.lang.String REPLICA_ACK_TIMEOUT</pre>
|
|
<div class="block">The amount of time that the
|
|
<a href="../../../../com/sleepycat/je/Transaction.html#commit-com.sleepycat.je.Durability-"><code>Transaction.commit(com.sleepycat.je.Durability)</code></a>
|
|
on the Master will wait for a sufficient number of acknowledgments from
|
|
electable Replicas. If the Master does not receive a sufficient number of
|
|
acknowledgments within this timeout period, the <code>commit()</code>
|
|
will throw <a href="../../../../com/sleepycat/je/rep/InsufficientAcksException.html" title="class in com.sleepycat.je.rep"><code>InsufficientAcksException</code></a>. In the special case of a
|
|
two node group, if this node is the designated <code>Primary</code>,
|
|
the <code>Primary</code> will be <code>activated</code>, and the
|
|
<code>commit()</code> will proceed normally instead of throwing an
|
|
exception.
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.replicaAckTimeout"</td>
|
|
<td>
|
|
<a href="../EnvironmentConfig.html#timeDuration">Duration</a>
|
|
</td>
|
|
<td>No</td>
|
|
<td>5 s</td>
|
|
<td>10 ms</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>,
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#DESIGNATED_PRIMARY"><code>ReplicationMutableConfig.DESIGNATED_PRIMARY</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REPLICA_ACK_TIMEOUT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="INSUFFICIENT_REPLICAS_TIMEOUT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>INSUFFICIENT_REPLICAS_TIMEOUT</h4>
|
|
<pre>public static final java.lang.String INSUFFICIENT_REPLICAS_TIMEOUT</pre>
|
|
<div class="block">The amount of time that a
|
|
<a href="../../../../com/sleepycat/je/Environment.html#beginTransaction-com.sleepycat.je.Transaction-com.sleepycat.je.TransactionConfig-"><code>Environment.beginTransaction(com.sleepycat.je.Transaction, com.sleepycat.je.TransactionConfig)</code></a>
|
|
on the Master will wait for a sufficient number of electable Replicas,
|
|
as determined by the default <code>Durability</code> policy, to contact
|
|
the Master. If the timeout period expires before a sufficient number of
|
|
Replicas contact the Master, the
|
|
<a href="../../../../com/sleepycat/je/Environment.html#beginTransaction-com.sleepycat.je.Transaction-com.sleepycat.je.TransactionConfig-"><code>Environment.beginTransaction(com.sleepycat.je.Transaction, com.sleepycat.je.TransactionConfig)</code></a>
|
|
will throw <a href="../../../../com/sleepycat/je/rep/InsufficientReplicasException.html" title="class in com.sleepycat.je.rep"><code>InsufficientReplicasException</code></a>. In the special case of
|
|
a two node group, if this node is the designated <code>Primary</code>,
|
|
the <code>Primary</code> will be <code>activated</code>, and the
|
|
<code>beginTransaction()</code> will proceed normally instead of
|
|
throwing an exception.
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.insufficientReplicasTimeout"</td>
|
|
<td>
|
|
<a href="../EnvironmentConfig.html#timeDuration">Duration</a>
|
|
</td>
|
|
<td>No</td>
|
|
<td>10 s</td>
|
|
<td>10 ms</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>,
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#DESIGNATED_PRIMARY"><code>ReplicationMutableConfig.DESIGNATED_PRIMARY</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.INSUFFICIENT_REPLICAS_TIMEOUT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="MAX_MESSAGE_SIZE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>MAX_MESSAGE_SIZE</h4>
|
|
<pre>public static final java.lang.String MAX_MESSAGE_SIZE</pre>
|
|
<div class="block">The maximum message size which will be accepted by a node (to prevent
|
|
DOS attacks). While the default shown here is 0, it dynamically
|
|
calculated when the node is created and is set to the half of the
|
|
environment cache size. The cache size is mutable, but changing the
|
|
cache size at run time (after environment initialization) will not
|
|
change the value of this parameter. If a value other than cache size /
|
|
2 is desired, this non-mutable parameter should be specified at
|
|
initialization time.
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td>
|
|
<td>Default</td><td>Minimum</td><td>Maximum</td></tr>
|
|
<tr>
|
|
<td>"je.rep.maxMessageSize"</td>
|
|
<td>Long</td>
|
|
<td>No</td>
|
|
<td>half of cache size</td>
|
|
<td>256KB</td>
|
|
<td>Long.MAX_VALUE</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.MAX_MESSAGE_SIZE">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="MAX_CLOCK_DELTA">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>MAX_CLOCK_DELTA</h4>
|
|
<pre>public static final java.lang.String MAX_CLOCK_DELTA</pre>
|
|
<div class="block">Sets the maximum acceptable clock skew between this Replica and its
|
|
Feeder, which is the node that is the source of its replication stream.
|
|
This value is checked whenever a Replica establishes a connection to its
|
|
replication stream source. The connection is abandoned if the clock skew
|
|
is larger than this value.
|
|
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td>
|
|
<td>Default</td><td>Minimum</td><td>Maximum</td></tr>
|
|
<tr>
|
|
<td>"je.rep.maxClockDelta"</td>
|
|
<td>
|
|
<a href="../EnvironmentConfig.html#timeDuration">Duration</a>
|
|
</td>
|
|
<td>No</td>
|
|
<td>2 s</td>
|
|
<td>0 s</td>
|
|
<td>1 min</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setMaxClockDelta-long-java.util.concurrent.TimeUnit-"><code>setMaxClockDelta(long, java.util.concurrent.TimeUnit)</code></a>,
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#getMaxClockDelta-java.util.concurrent.TimeUnit-"><code>getMaxClockDelta(java.util.concurrent.TimeUnit)</code></a>,
|
|
<a href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.MAX_CLOCK_DELTA">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ELECTIONS_PRIMARY_RETRIES">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ELECTIONS_PRIMARY_RETRIES</h4>
|
|
<pre>public static final java.lang.String ELECTIONS_PRIMARY_RETRIES</pre>
|
|
<div class="block">The number of times an unsuccessful election will be retried by a
|
|
designated <code>Primary</code> in a two node group before it is
|
|
activated and becomes the Master.
|
|
|
|
<p><table border="1">
|
|
<tr><td>Name</td><td>Type</td><td>Mutable</td>
|
|
<td>Default</td><td>Minimum</td><td>Maximum</td></tr>
|
|
<tr>
|
|
<td>"je.rep.electionsPrimaryRetries"</td>
|
|
<td>Integer</td>
|
|
<td>No</td>
|
|
<td>2</td>
|
|
<td>0</td>
|
|
<td>Integer.MAX_VALUE</td>
|
|
</tr>
|
|
</table></p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#DESIGNATED_PRIMARY"><code>ReplicationMutableConfig.DESIGNATED_PRIMARY</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.ELECTIONS_PRIMARY_RETRIES">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ELECTIONS_REBROADCAST_PERIOD">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ELECTIONS_REBROADCAST_PERIOD</h4>
|
|
<pre>public static final java.lang.String ELECTIONS_REBROADCAST_PERIOD</pre>
|
|
<div class="block">The time interval between rebroadcasts of election results by the master
|
|
node to all nodes not currently connected to it. These rebroadcasts help
|
|
ensure that a replication group is fully restored after a network
|
|
partition, by permitting nodes on either side of the resolved partition
|
|
to catch up with the latest election results.
|
|
<p>
|
|
A network partition, may in some circumstances, result in a node
|
|
continuing to think it is the master, even though it is on the side of
|
|
the partition containing a minority of electable nodes, and the side
|
|
with the majority has elected a new master. Rebroadcasting election
|
|
results on a periodic basis ensures that the obsolete master is brought
|
|
up to date after the network partition has been resolved. As a result of
|
|
the update, the environment at the obsolete master will transition into
|
|
a replica state.
|
|
<p>
|
|
Decreasing the period will result in more frequent broadcasts and thus a
|
|
faster return to normal operations after a network partition has been
|
|
resolved.
|
|
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.electionsRebroadcastPeriod"</td>
|
|
<td>
|
|
<a href="../EnvironmentConfig.html#timeDuration">Duration</a></td>
|
|
<td>No</td>
|
|
<td>1 min</td>
|
|
<td>1 s</td>
|
|
<td>none</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.ELECTIONS_REBROADCAST_PERIOD">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="TXN_ROLLBACK_LIMIT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>TXN_ROLLBACK_LIMIT</h4>
|
|
<pre>public static final java.lang.String TXN_ROLLBACK_LIMIT</pre>
|
|
<div class="block">In rare cases, a node may need to rollback committed transactions in
|
|
order to rejoin a replication group. This parameter limits the number of
|
|
durable transactions that may be rolled back. Durable transactions are
|
|
transactions that were successfully committed with a durability
|
|
requiring acknowledgments from at least a simple majority of nodes. If
|
|
the number of durable committed transactions targeted for rollback
|
|
exceeds this parameter, a <a href="../../../../com/sleepycat/je/rep/RollbackProhibitedException.html" title="class in com.sleepycat.je.rep"><code>RollbackProhibitedException</code></a> will be
|
|
thrown.
|
|
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.txnRollbackLimit"</td>
|
|
<td>Integer</td>
|
|
<td>No</td>
|
|
<td>10</td>
|
|
<td>0</td>
|
|
<td>Integer.MAX_VALUE</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/RollbackProhibitedException.html" title="class in com.sleepycat.je.rep"><code>RollbackProhibitedException</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.TXN_ROLLBACK_LIMIT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="TXN_ROLLBACK_DISABLED">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>TXN_ROLLBACK_DISABLED</h4>
|
|
<pre>public static final java.lang.String TXN_ROLLBACK_DISABLED</pre>
|
|
<div class="block">In rare cases, a node may need to rollback committed transactions in
|
|
order to rejoin a replication group. If this parameter is set to true
|
|
and a rollback is necessary to rejoin the group, a <a href="../../../../com/sleepycat/je/rep/RollbackProhibitedException.html" title="class in com.sleepycat.je.rep"><code>RollbackProhibitedException</code></a> will be thrown.
|
|
|
|
<p>Unlike setting <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#TXN_ROLLBACK_LIMIT"><code>TXN_ROLLBACK_LIMIT</code></a> to zero, setting this
|
|
parameter to true disables the rollback without regard to whether the
|
|
transactions to roll back are considered durable.</p>
|
|
|
|
<p>Setting <code>TXN_ROLLBACK_DISABLED</code> to true should not be
|
|
necessary for most applications. Its intended purpose is for the rare
|
|
application that needs manual control over rollback of all transactions,
|
|
including transactions that are not considered to be durable.</p>
|
|
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.txnRollbackDisabled"</td>
|
|
<td>Boolean</td>
|
|
<td>No</td>
|
|
<td>False</td>
|
|
</tr>
|
|
</table></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.TXN_ROLLBACK_DISABLED">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="FEEDER_TIMEOUT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>FEEDER_TIMEOUT</h4>
|
|
<pre>public static final java.lang.String FEEDER_TIMEOUT</pre>
|
|
<div class="block">A heartbeat is exchanged between the feeder and replica to ensure they
|
|
are alive. This is the timeout associated with the heartbeat on the
|
|
feeder side of the connection.
|
|
<p>
|
|
Reducing this value enables the master to discover failed Replicas, and
|
|
recycle feeder connections, faster. However, it increases the chances of
|
|
false timeouts, if the network is experiencing transient problems, or
|
|
the Java GC is responsible for long pauses. In the latter case, it's
|
|
generally better to tune the GC to avoid such pauses.
|
|
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.feederTimeout"</td>
|
|
<td>
|
|
<a href="../EnvironmentConfig.html#timeDuration">Duration</a>
|
|
</td>
|
|
<td>No</td>
|
|
<td>30 s</td>
|
|
<td>2 s</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0.100</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.FEEDER_TIMEOUT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REPLICA_TIMEOUT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REPLICA_TIMEOUT</h4>
|
|
<pre>public static final java.lang.String REPLICA_TIMEOUT</pre>
|
|
<div class="block">A heartbeat is exchanged between the feeder and replica to ensure they
|
|
are alive. This is the timeout associated with the heartbeat on the
|
|
replica side of the connection.
|
|
<p>
|
|
Reducing the value means that a master failure will be discovered more
|
|
promptly in some circumstances and the overall time needed to failover
|
|
to a new master will be reduced. However, it increases the chances of
|
|
false timeouts, if the network is experiencing transient problems, or
|
|
the Java GC is responsible for long pauses. In the latter case, it's
|
|
generally better to tune the GC to avoid such pauses.
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.replicaTimeout"</td>
|
|
<td>
|
|
<a href="../EnvironmentConfig.html#timeDuration">Duration</a>
|
|
</td>
|
|
<td>No</td>
|
|
<td>30 s</td>
|
|
<td>2 s</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0.100</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REPLICA_TIMEOUT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REPLICA_RECEIVE_BUFFER_SIZE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REPLICA_RECEIVE_BUFFER_SIZE</h4>
|
|
<pre>public static final java.lang.String REPLICA_RECEIVE_BUFFER_SIZE</pre>
|
|
<div class="block">The size of the the TCP receive buffer associated with the socket used
|
|
by the replica to transfer the replication stream.
|
|
<p>
|
|
Larger values help handle incoming network traffic even when the replica
|
|
has been paused for a garbage collection. The parameter default value of
|
|
1 MB should be sufficient in most of the environments. Consider
|
|
increasing the value if network monitoring shows packet loss, or if your
|
|
JE environment contains large data values. Note that if the size
|
|
specified is larger than the operating system constrained maximum, it
|
|
will be limited to this maximum value. For example, on Linux you may
|
|
need to set the kernel parameter: net.core.rmem_max property using the
|
|
command: <i>sysctl -w net.core.rmem_max=1048576</i> to increase the
|
|
operating system imposed limit.
|
|
<p>
|
|
A parameter value of zero will result in the use of operating system
|
|
specified default socket buffer size.
|
|
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.replicaReceiveBufferSize"</td>
|
|
<td>Integer</td>
|
|
<td>No</td>
|
|
<td>1048576</td>
|
|
<td>0</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>5.0.37</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REPLICA_RECEIVE_BUFFER_SIZE">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REPLICA_MAX_GROUP_COMMIT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REPLICA_MAX_GROUP_COMMIT</h4>
|
|
<pre>public static final java.lang.String REPLICA_MAX_GROUP_COMMIT</pre>
|
|
<div class="block">The maximum number of transactions that can be grouped to amortize the
|
|
cost of an fsync when a transaction commits with SyncPolicy#SYNC on the
|
|
Replica. A value of zero effectively turns off the group commit
|
|
optimization.
|
|
<p>
|
|
Specifying larger values can result in more transactions being grouped
|
|
together decreasing average commit times.
|
|
<p>
|
|
An fsync is issued if the size of the transaction group reaches the
|
|
maximum within the time period specified by
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLICA_GROUP_COMMIT_INTERVAL"><code>REPLICA_GROUP_COMMIT_INTERVAL</code></a>.
|
|
<p>
|
|
The <a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironmentStats.html#getNReplayGroupCommitMaxExceeded--"><code>ReplicatedEnvironmentStats.getNReplayGroupCommitMaxExceeded()</code></a>
|
|
statistic may be used to tune this parameter. Large values indicate that
|
|
commit throughput could be improved by increasing the current value.
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.replicaMaxGroupCommit"</td>
|
|
<td>Integer</td>
|
|
<td>No</td>
|
|
<td>200</td>
|
|
<td>0</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>5.0.76</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLICA_GROUP_COMMIT_INTERVAL"><code>REPLICA_GROUP_COMMIT_INTERVAL</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REPLICA_MAX_GROUP_COMMIT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="REPLICA_GROUP_COMMIT_INTERVAL">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>REPLICA_GROUP_COMMIT_INTERVAL</h4>
|
|
<pre>public static final java.lang.String REPLICA_GROUP_COMMIT_INTERVAL</pre>
|
|
<div class="block">The time interval during which transactions may be grouped to amortize
|
|
the cost of fsync when a transaction commits with SyncPolicy#SYNC on the
|
|
Replica. This parameter is only meaningful if the
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLICA_MAX_GROUP_COMMIT"><code>group commit size</code></a> is greater than one.
|
|
<p>
|
|
The first (as ordered by transaction serialization) transaction in a
|
|
transaction group may be delayed by at most this amount. Subsequent
|
|
transactions in the group will have smaller delays since they are later
|
|
in the serialization order.
|
|
<p>
|
|
The <a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironmentStats.html#getNReplayGroupCommitTimeouts--"><code>ReplicatedEnvironmentStats.getNReplayGroupCommitTimeouts()</code></a>
|
|
statistic may be used to tune this parameter. Large numbers of timeouts
|
|
in conjunction with large numbers of group commits (
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironmentStats.html#getNReplayGroupCommits--"><code>ReplicatedEnvironmentStats.getNReplayGroupCommits()</code></a>) indicate
|
|
that commit throughput could be improved by increasing the time
|
|
interval.
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.replicaGroupCommitInterval"</td>
|
|
<td><a href="#timeDuration">Duration</a></td>
|
|
<td>No</td>
|
|
<td>3 ms</td>
|
|
<td>0</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>5.0.76</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#REPLICA_MAX_GROUP_COMMIT"><code>REPLICA_MAX_GROUP_COMMIT</code></a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.REPLICA_GROUP_COMMIT_INTERVAL">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ENV_SETUP_TIMEOUT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ENV_SETUP_TIMEOUT</h4>
|
|
<pre>public static final java.lang.String ENV_SETUP_TIMEOUT</pre>
|
|
<div class="block">The maximum amount of time for the internal housekeeping, like
|
|
elections, syncup with the master, etc. to be accomplished when opening
|
|
a new handle to an environment.
|
|
<p>
|
|
This timeout does not encompass the time spent making the node
|
|
consistent with the master, if it is a Replica. The timeout associated
|
|
with making a replica consistent is normally determined by the
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ENV_CONSISTENCY_TIMEOUT"><code>ENV_CONSISTENCY_TIMEOUT</code></a> parameter but can be overridden by the
|
|
timeout associated with the <code>ReplicaConsistencyPolicy</code> if a
|
|
<code>consistencyPolicy</code> argument was supplied to the handle
|
|
constructor.
|
|
<p>
|
|
Note that the default value (10 hours) is a long time to allow for cases
|
|
where elections may take a long time when other nodes are not available.
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.envSetupTimeout"</td>
|
|
<td>Duration</td>
|
|
<td>No</td>
|
|
<td>10 h</td>
|
|
<td>-none-</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../EnvironmentConfig.html#timeDuration">Time Duration
|
|
Properties</a>,
|
|
<a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.ENV_SETUP_TIMEOUT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ENV_UNKNOWN_STATE_TIMEOUT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ENV_UNKNOWN_STATE_TIMEOUT</h4>
|
|
<pre>public static final java.lang.String ENV_UNKNOWN_STATE_TIMEOUT</pre>
|
|
<div class="block">Permits opening of a ReplicatedEnvironment handle in the
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.State.html#UNKNOWN"><code>ReplicatedEnvironment.State.UNKNOWN</code></a> state, if a Master cannot be
|
|
determined within this timeout period. For the timeout to be meaningful
|
|
it must be less than <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ENV_SETUP_TIMEOUT"><code>ENV_SETUP_TIMEOUT</code></a>. This parameter is
|
|
ignored when creating a replicated environment for the first time.
|
|
<p>
|
|
A ReplicatedEnvironment handle in the
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.State.html#UNKNOWN"><code>ReplicatedEnvironment.State.UNKNOWN</code></a> state can only be used to
|
|
initiate read operations with an appropriately relaxed, e.g.
|
|
<a href="../../../../com/sleepycat/je/rep/NoConsistencyRequiredPolicy.html" title="class in com.sleepycat.je.rep"><code>NoConsistencyRequiredPolicy</code></a>; write operations will fail with a
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicaWriteException.html" title="class in com.sleepycat.je.rep"><code>ReplicaWriteException</code></a>. The handle will transition to a
|
|
<code>Master</code> or <code>Replica</code> state when it can contact a
|
|
sufficient number of other nodes in the replication group.
|
|
<p>
|
|
If the parameter is set to zero, and an election cannot be concluded
|
|
within the timeout defined by <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#ENV_SETUP_TIMEOUT"><code>ENV_SETUP_TIMEOUT</code></a>, the
|
|
ReplicatedEnvironment constructor will throw <a href="../../../../com/sleepycat/je/rep/UnknownMasterException.html" title="class in com.sleepycat.je.rep"><code>UnknownMasterException</code></a>.
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.envUnknownStateTimeout"</td>
|
|
<td>Duration</td>
|
|
<td>No</td>
|
|
<td>0</td>
|
|
<td>-none-</td>
|
|
<td><code>ENV_SETUP_TIMEOUT</code></td>
|
|
</tr></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>5.0.33</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.ENV_UNKNOWN_STATE_TIMEOUT">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="PROTOCOL_OLD_STRING_ENCODING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>PROTOCOL_OLD_STRING_ENCODING</h4>
|
|
<pre>public static final java.lang.String PROTOCOL_OLD_STRING_ENCODING</pre>
|
|
<div class="block">When set to <code>true</code>, which is currently the default, the
|
|
replication network protocol will use the JVM platform default charset
|
|
(text encoding) for node names and host names. This is incorrect, in
|
|
that it requires that the JVM for all nodes in a replication group have
|
|
the same default charset.
|
|
<p>
|
|
When this parameter is set to <code>false</code>, the UTF-8 charset is
|
|
always used in the replication protocol. In other words, the JVM
|
|
default charset has no impact on the replication protocol.
|
|
<p>
|
|
An application is <em>not</em> impacted by this issue, and does not need
|
|
to set this parameter, if it has the following characteristics.
|
|
<ul>
|
|
<li>The default charset on all JVMs is UTF-8 or ASCII, or</li>
|
|
<li>all node names and host names contain only ASCII characters, and
|
|
the default charset on all JVMs is a superset of ASCII.</li>
|
|
</ul>
|
|
<p>
|
|
In JE 5.1, the default value for this parameter will be changed to
|
|
false. In preparation for this, impacted applications should explicitly
|
|
set the parameter to false at the next available opportunity. For
|
|
applications not yet deployed, this should be done now. For deployed
|
|
applications, a hot upgrade may not be performed when changing the
|
|
parameter. Instead, a cold upgrade must be performed: all nodes must
|
|
be stopped and upgraded before bringing them up again. In other words,
|
|
for impacted applications the value of this configuration parameter must
|
|
be the same for all running nodes in a replication group.
|
|
<p>
|
|
Note that the default charset issue applies only to the replication
|
|
network protocol and not to stored data of any kind.
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.protocolOldStringEncoding"</td>
|
|
<td>Boolean</td>
|
|
<td>No</td>
|
|
<td>True</td>
|
|
</tr>
|
|
</table></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.PROTOCOL_OLD_STRING_ENCODING">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ARBITER_OUTPUT_QUEUE_SIZE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>ARBITER_OUTPUT_QUEUE_SIZE</h4>
|
|
<pre>public static final java.lang.String ARBITER_OUTPUT_QUEUE_SIZE</pre>
|
|
<div class="block">The size of the the queue used to hold commit records that the Feeder
|
|
uses to request acknowledgment from an Arbiter.
|
|
<p>
|
|
An entry is attempted to be put on the queue. If it cannot be done within
|
|
a certain amount of time, the transaction will fail due to insufficient
|
|
acks.
|
|
<p>
|
|
<table border="1">
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Mutable</td>
|
|
<td>Default</td>
|
|
<td>Minimum</td>
|
|
<td>Maximum</td>
|
|
</tr>
|
|
<tr>
|
|
<td>"je.rep.arbiterOutputQueueSize"</td>
|
|
<td>Integer</td>
|
|
<td>No</td>
|
|
<td>4096</td>
|
|
<td>0</td>
|
|
<td>-none-</td>
|
|
</tr>
|
|
</table>
|
|
</p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../constant-values.html#com.sleepycat.je.rep.ReplicationConfig.ARBITER_OUTPUT_QUEUE_SIZE">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="ReplicationConfig--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ReplicationConfig</h4>
|
|
<pre>public ReplicationConfig()</pre>
|
|
<div class="block">Creates a ReplicationConfig initialized with the system default
|
|
settings. Defaults are documented with the string constants in this
|
|
class.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="ReplicationConfig-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ReplicationConfig</h4>
|
|
<pre>public ReplicationConfig(java.lang.String groupName,
|
|
java.lang.String nodeName,
|
|
java.lang.String hostPort)</pre>
|
|
<div class="block">Creates a ReplicationConfig initialized with the system default
|
|
settings and the specified group name, node name, and hostname/port
|
|
values.
|
|
|
|
<p>Note that the node name is immutable. Normally the host name should
|
|
not be used as the node name, unless you intend to reuse the host
|
|
name when a machine fails and is replaced, or the node is upgraded to
|
|
new hardware.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>groupName</code> - the name for the replication group</dd>
|
|
<dd><code>nodeName</code> - the name for this node</dd>
|
|
<dd><code>hostPort</code> - the hostname and port for this node</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setGroupName-java.lang.String-"><code>setGroupName(java.lang.String)</code></a>,
|
|
<a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setNodeName-java.lang.String-"><code>setNodeName(java.lang.String)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ReplicationConfig-java.util.Properties-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>ReplicationConfig</h4>
|
|
<pre>public ReplicationConfig(java.util.Properties properties)
|
|
throws java.lang.IllegalArgumentException</pre>
|
|
<div class="block">Creates a ReplicationConfig which includes the properties specified in
|
|
the properties parameter.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>properties</code> - Supported properties are described as the string
|
|
constants in this class.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - If any properties read from the
|
|
properties parameter are invalid.</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="getGroupName--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getGroupName</h4>
|
|
<pre>public java.lang.String getGroupName()</pre>
|
|
<div class="block">Gets the name associated with the replication group.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the name of this replication group.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setGroupName-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setGroupName</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a> setGroupName(java.lang.String groupName)
|
|
throws java.lang.IllegalArgumentException</pre>
|
|
<div class="block">Sets the name for the replication group.
|
|
<p>
|
|
The name should consist of letters, digits, and/or hyphen ("-"),
|
|
underscore ("_"), or period (".").</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>groupName</code> - the string representing the name</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - If the string name is not valid</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNodeName--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNodeName</h4>
|
|
<pre>public java.lang.String getNodeName()</pre>
|
|
<div class="block">Returns the unique name associated with this node.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the node name</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setNodeName-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setNodeName</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a> setNodeName(java.lang.String nodeName)
|
|
throws java.lang.IllegalArgumentException</pre>
|
|
<div class="block">Sets the name to be associated with this node. It must be unique within
|
|
the group. When the node is instantiated and joins the replication
|
|
group, a check is done to ensure that the name is unique, and a <a href="../../../../com/sleepycat/je/rep/RestartRequiredException.html" title="class in com.sleepycat.je.rep"><code>RestartRequiredException</code></a> is thrown if it is not.
|
|
<p>
|
|
The name should consist of letters, digits, and/or hyphen ("-"),
|
|
underscore ("_"), or period (".").
|
|
|
|
<p>Note that the node name is immutable. Normally the host name should
|
|
not be used as the node name, unless you intend to reuse the host
|
|
name when a machine fails and is replaced, or the node is upgraded to
|
|
new hardware.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>nodeName</code> - the node name for this replicated environment.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - If the name is not valid</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNodeType--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNodeType</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/NodeType.html" title="enum in com.sleepycat.je.rep">NodeType</a> getNodeType()</pre>
|
|
<div class="block">Returns the <a href="../../../../com/sleepycat/je/rep/NodeType.html" title="enum in com.sleepycat.je.rep"><code>NodeType</code></a> of this node.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the node type</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setNodeType-com.sleepycat.je.rep.NodeType-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setNodeType</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a> setNodeType(<a href="../../../../com/sleepycat/je/rep/NodeType.html" title="enum in com.sleepycat.je.rep">NodeType</a> nodeType)</pre>
|
|
<div class="block">Sets the type of this node.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>nodeType</code> - the node type</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNodeHostPort--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNodeHostPort</h4>
|
|
<pre>public java.lang.String getNodeHostPort()</pre>
|
|
<div class="block">Returns the hostname and port associated with this node. The hostname
|
|
and port combination are denoted by a string of the form:
|
|
<pre>
|
|
hostname:port
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the hostname and port string.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#NODE_HOST_PORT"><code>NODE_HOST_PORT</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setNodeHostPort-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setNodeHostPort</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a> setNodeHostPort(java.lang.String hostPort)</pre>
|
|
<div class="block">Sets the hostname and port associated with this node. The hostname
|
|
and port combination are denoted by a string of the form:
|
|
<pre>
|
|
hostname[:port]
|
|
</pre>
|
|
The port must be outside the range of "Well Known Ports"
|
|
(zero through 1023).</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>hostPort</code> - the string containing the hostname and port as above.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#NODE_HOST_PORT"><code>NODE_HOST_PORT</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicaAckTimeout-java.util.concurrent.TimeUnit-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicaAckTimeout</h4>
|
|
<pre>public long getReplicaAckTimeout(java.util.concurrent.TimeUnit unit)</pre>
|
|
<div class="block">Returns the configured replica timeout value.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the timeout in milliseconds</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicaAckTimeout-long-java.util.concurrent.TimeUnit-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicaAckTimeout</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a> setReplicaAckTimeout(long replicaAckTimeout,
|
|
java.util.concurrent.TimeUnit unit)</pre>
|
|
<div class="block">Set the replica commit timeout.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>replicaAckTimeout</code> - time in milliseconds</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMaxClockDelta-java.util.concurrent.TimeUnit-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxClockDelta</h4>
|
|
<pre>public long getMaxClockDelta(java.util.concurrent.TimeUnit unit)</pre>
|
|
<div class="block">Returns the maximum acceptable clock skew between this Replica and its
|
|
Feeder, which is the node that is the source of its replication stream.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the max permissible clock skew</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMaxClockDelta-long-java.util.concurrent.TimeUnit-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMaxClockDelta</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a> setMaxClockDelta(long maxClockDelta,
|
|
java.util.concurrent.TimeUnit unit)
|
|
throws java.lang.IllegalArgumentException</pre>
|
|
<div class="block">Sets the maximum acceptable clock skew between this Replica and its
|
|
Feeder, which is the node that is the source of its replication
|
|
stream. This value is checked whenever a Replica establishes a
|
|
connection to its replication stream source. The connection is abandoned
|
|
if the clock skew is larger than this value.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>maxClockDelta</code> - the maximum acceptable clock skew</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if the value is not a positive integer</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setConsistencyPolicy-com.sleepycat.je.ReplicaConsistencyPolicy-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setConsistencyPolicy</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a> setConsistencyPolicy(<a href="../../../../com/sleepycat/je/ReplicaConsistencyPolicy.html" title="interface in com.sleepycat.je">ReplicaConsistencyPolicy</a> policy)</pre>
|
|
<div class="block">Sets the consistency policy to be associated with the configuration.
|
|
This policy acts as the default policy used to govern the consistency
|
|
requirements when starting new transactions. See the <a
|
|
href="../../../../../ReplicationGuide/consistency.html">overview on
|
|
consistency in replicated systems</a> for more background.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>policy</code> - the consistency policy to be set for this config.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getConsistencyPolicy--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getConsistencyPolicy</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/ReplicaConsistencyPolicy.html" title="interface in com.sleepycat.je">ReplicaConsistencyPolicy</a> getConsistencyPolicy()</pre>
|
|
<div class="block">Returns the default consistency policy associated with the
|
|
configuration.
|
|
<p>
|
|
If the user does not set the default consistency policy through <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#setConsistencyPolicy-com.sleepycat.je.ReplicaConsistencyPolicy-"><code>setConsistencyPolicy(com.sleepycat.je.ReplicaConsistencyPolicy)</code></a>, the system will use the policy
|
|
defined by <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html#CONSISTENCY_POLICY"><code>CONSISTENCY_POLICY</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code>getConsistencyPolicy</code> in interface <code>com.sleepycat.je.dbi.RepConfigProxy</code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the consistency policy currently associated with this config.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setConfigParam-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setConfigParam</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a> setConfigParam(java.lang.String paramName,
|
|
java.lang.String value)
|
|
throws java.lang.IllegalArgumentException</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#setConfigParam-java.lang.String-java.lang.String-">ReplicationMutableConfig</a></code></span></div>
|
|
<div class="block">Set this configuration parameter with this value. Values are validated
|
|
before setting the parameter.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html#setConfigParam-java.lang.String-java.lang.String-">setConfigParam</a></code> in class <code><a href="../../../../com/sleepycat/je/rep/ReplicationMutableConfig.html" title="class in com.sleepycat.je.rep">ReplicationMutableConfig</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>paramName</code> - the configuration parameter name, one of the String
|
|
constants in this class</dd>
|
|
<dd><code>value</code> - the configuration value.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this;</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if the paramName or value is invalid.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="clone--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>clone</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a> clone()</pre>
|
|
<div class="block">Returns a copy of this configuration object.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getNodeHostname--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNodeHostname</h4>
|
|
<pre>public java.lang.String getNodeHostname()</pre>
|
|
<div class="block">Returns the hostname component of the nodeHost property.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the hostname string</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNodePort--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNodePort</h4>
|
|
<pre>public int getNodePort()</pre>
|
|
<div class="block">Returns the port component of the nodeHost property.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the port number</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setSyncupProgressListener-com.sleepycat.je.ProgressListener-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setSyncupProgressListener</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/rep/ReplicationConfig.html" title="class in com.sleepycat.je.rep">ReplicationConfig</a> setSyncupProgressListener(<a href="../../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je">ProgressListener</a><<a href="../../../../com/sleepycat/je/rep/SyncupProgress.html" title="enum in com.sleepycat.je.rep">SyncupProgress</a>> progressListener)</pre>
|
|
<div class="block">Configure the environment to make periodic calls to a <a href="../../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je"><code>ProgressListener</code></a> to provide feedback on replication stream sync-up.
|
|
The ProgressListener.progress() method is called at different stages of
|
|
the syncup process. See <a href="../../../../com/sleepycat/je/rep/SyncupProgress.html" title="enum in com.sleepycat.je.rep"><code>SyncupProgress</code></a> for information about
|
|
those stages.
|
|
<p>
|
|
When using progress listeners, review the information at <a href="../../../../com/sleepycat/je/ProgressListener.html#progress-T-long-long-"><code>ProgressListener.progress(T, long, long)</code></a> to avoid any unintended disruption to
|
|
replication stream syncup.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>progressListener</code> - The ProgressListener to callback during
|
|
environment instantiation (syncup).</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>5.0</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../../../ReplicationGuide/progoverviewlifecycle.html"
|
|
target="_top">Replication Group Life Cycle</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSyncupProgressListener--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getSyncupProgressListener</h4>
|
|
<pre>public <a href="../../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je">ProgressListener</a><<a href="../../../../com/sleepycat/je/rep/SyncupProgress.html" title="enum in com.sleepycat.je.rep">SyncupProgress</a>> getSyncupProgressListener()</pre>
|
|
<div class="block">Return the ProgressListener to be used at this environment startup.</div>
|
|
</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/ReplicationConfig.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/ReplicatedEnvironmentStats.html" title="class in com.sleepycat.je.rep"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/sleepycat/je/rep/ReplicationGroup.html" title="class in com.sleepycat.je.rep"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/sleepycat/je/rep/ReplicationConfig.html" target="_top">Frames</a></li>
|
|
<li><a href="ReplicationConfig.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><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><font size=1>Copyright (c) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
|
|
</body>
|
|
</html>
|