275 lines
11 KiB
HTML
275 lines
11 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>AppStateMonitor (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="AppStateMonitor (Oracle - Berkeley DB Java Edition API)";
|
||
|
}
|
||
|
}
|
||
|
catch(err) {
|
||
|
}
|
||
|
//-->
|
||
|
var methods = {"i0":6};
|
||
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AppStateMonitor.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>Prev Class</li>
|
||
|
<li><a href="../../../../com/sleepycat/je/rep/CommitPointConsistencyPolicy.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/AppStateMonitor.html" target="_top">Frames</a></li>
|
||
|
<li><a href="AppStateMonitor.html" target="_top">No Frames</a></li>
|
||
|
</ul>
|
||
|
<ul class="navList" id="allclasses_navbar_top">
|
||
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
||
|
</ul>
|
||
|
<div>
|
||
|
<script type="text/javascript"><!--
|
||
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
||
|
if(window==top) {
|
||
|
allClassesLink.style.display = "block";
|
||
|
}
|
||
|
else {
|
||
|
allClassesLink.style.display = "none";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li>Nested | </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method.summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="subNavList">
|
||
|
<li>Detail: </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method.detail">Method</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<a name="skip.navbar.top">
|
||
|
<!-- -->
|
||
|
</a></div>
|
||
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
<div class="header">
|
||
|
<div class="subTitle">com.sleepycat.je.rep</div>
|
||
|
<h2 title="Interface AppStateMonitor" class="title">Interface AppStateMonitor</h2>
|
||
|
</div>
|
||
|
<div class="contentContainer">
|
||
|
<div class="description">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<hr>
|
||
|
<br>
|
||
|
<pre>public interface <span class="typeNameLabel">AppStateMonitor</span></pre>
|
||
|
<div class="block">A mechanism for adding application specific information when asynchronously
|
||
|
tracking the state of a running JE HA application.
|
||
|
<p>
|
||
|
<a href="../../../../com/sleepycat/je/rep/NodeState.html" title="class in com.sleepycat.je.rep"><code>NodeState</code></a> provides information about the current state of a member
|
||
|
of the replication group. The application can obtain NodeState via <a href="../../../../com/sleepycat/je/rep/util/ReplicationGroupAdmin.html#getNodeState-com.sleepycat.je.rep.ReplicationNode-int-"><code>ReplicationGroupAdmin.getNodeState(com.sleepycat.je.rep.ReplicationNode, int)</code></a> or <a href="../../../../com/sleepycat/je/rep/util/DbPing.html#getNodeState--"><code>DbPing.getNodeState()</code></a>. A NodeState contains mostly
|
||
|
JE-centric information, such as whether the node is a master or
|
||
|
replica. However, it may be important to add in some application specific
|
||
|
information to enable the best use of the status.
|
||
|
<p>
|
||
|
For example, an application may want to direct operations to specific nodes
|
||
|
based on whether the node is available. The fields in <a href="../../../../com/sleepycat/je/rep/NodeState.html" title="class in com.sleepycat.je.rep"><code>NodeState</code></a> will
|
||
|
tell the application whether the node is up and available in a JE HA sense,
|
||
|
but the application may also need information about an application level
|
||
|
resource, which would affect the load balancing decision. The AppStateMonitor
|
||
|
is a way for the application to inject this kind of application specific
|
||
|
information into the replicated node status.
|
||
|
<p>
|
||
|
The AppStateMonitor is registered with the replicated environment using
|
||
|
<a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.html#registerAppStateMonitor-com.sleepycat.je.rep.AppStateMonitor-"><code>ReplicatedEnvironment.registerAppStateMonitor(AppStateMonitor)</code></a>.
|
||
|
There is at most one AppStateMonitor associated with the actual environment
|
||
|
(not an <a href="../../../../com/sleepycat/je/Environment.html" title="class in com.sleepycat.je"><code>Environment</code></a> handle) at any given time. JE
|
||
|
HA calls <a href="../../../../com/sleepycat/je/rep/AppStateMonitor.html#getAppState--"><code>getAppState()</code></a> when it is assembling status
|
||
|
information for a given node.
|
||
|
<p>
|
||
|
After registration, the application can obtain this application specific
|
||
|
information along with other JE HA status information when it obtains a
|
||
|
<a href="../../../../com/sleepycat/je/rep/NodeState.html" title="class in com.sleepycat.je.rep"><code>NodeState</code></a>, through <a href="../../../../com/sleepycat/je/rep/NodeState.html#getAppState--"><code>NodeState.getAppState()</code></a>.
|
||
|
<p>
|
||
|
<a href="../../../../com/sleepycat/je/rep/AppStateMonitor.html#getAppState--"><code>getAppState()</code></a> returns a byte array whose length
|
||
|
should be larger than 0. An IllegalStateException will be thrown if the
|
||
|
returned byte array is 0 size. Users are responsible for serializing and
|
||
|
deserializing the desired information into this byte array.</div>
|
||
|
<dl>
|
||
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
||
|
<dd>5.0</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="summary">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="method.summary">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Method Summary</h3>
|
||
|
<table class="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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>byte[]</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/AppStateMonitor.html#getAppState--">getAppState</a></span>()</code>
|
||
|
<div class="block">Return a byte array which holds information about the application's
|
||
|
state.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="details">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="method.detail">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Method Detail</h3>
|
||
|
<a name="getAppState--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>getAppState</h4>
|
||
|
<pre>byte[] getAppState()</pre>
|
||
|
<div class="block">Return a byte array which holds information about the application's
|
||
|
state. The application is responsible for serialize and deserialize this
|
||
|
information.
|
||
|
<p>
|
||
|
Note the returned byte array's length should be larger than 0.</div>
|
||
|
<dl>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the application state</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
</div>
|
||
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
|
<div class="bottomNav"><a name="navbar.bottom">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
<a name="navbar.bottom.firstrow">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="navList" title="Navigation">
|
||
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
||
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
<li class="navBarCell1Rev">Class</li>
|
||
|
<li><a href="class-use/AppStateMonitor.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>Prev Class</li>
|
||
|
<li><a href="../../../../com/sleepycat/je/rep/CommitPointConsistencyPolicy.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/AppStateMonitor.html" target="_top">Frames</a></li>
|
||
|
<li><a href="AppStateMonitor.html" target="_top">No Frames</a></li>
|
||
|
</ul>
|
||
|
<ul class="navList" id="allclasses_navbar_bottom">
|
||
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
||
|
</ul>
|
||
|
<div>
|
||
|
<script type="text/javascript"><!--
|
||
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
||
|
if(window==top) {
|
||
|
allClassesLink.style.display = "block";
|
||
|
}
|
||
|
else {
|
||
|
allClassesLink.style.display = "none";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li>Nested | </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method.summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="subNavList">
|
||
|
<li>Detail: </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method.detail">Method</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<a name="skip.navbar.bottom">
|
||
|
<!-- -->
|
||
|
</a></div>
|
||
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
<p class="legalCopy"><small><font size=1>Copyright (c) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
|
||
|
</body>
|
||
|
</html>
|