1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.5.0) on Thu May 15 17:17:31 EDT 2008 --> 6<TITLE> 7ReplicationStatus (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="com.sleepycat.db.ReplicationStatus class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="ReplicationStatus (Oracle - Berkeley DB Java API)"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReplicationStatus.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 45 </TR> 46</TABLE> 47</TD> 48<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 49<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 50</TD> 51</TR> 52 53<TR> 54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 55 <A HREF="../../../com/sleepycat/db/ReplicationStats.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 56 <A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../index.html?com/sleepycat/db/ReplicationStatus.html" target="_top"><B>FRAMES</B></A> 59 <A HREF="ReplicationStatus.html" target="_top"><B>NO FRAMES</B></A> 60 <SCRIPT type="text/javascript"> 61 <!-- 62 if(window==top) { 63 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 64 } 65 //--> 66</SCRIPT> 67<NOSCRIPT> 68 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 69</NOSCRIPT> 70 71 72</FONT></TD> 73</TR> 74<TR> 75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 76 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 78DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 79</TR> 80</TABLE> 81<A NAME="skip-navbar_top"></A> 82<!-- ========= END OF TOP NAVBAR ========= --> 83 84<HR> 85<!-- ======== START OF CLASS DATA ======== --> 86<H2> 87<FONT SIZE="-1"> 88com.sleepycat.db</FONT> 89<BR> 90Class ReplicationStatus</H2> 91<PRE> 92<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> 93 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.ReplicationStatus</B> 94</PRE> 95<HR> 96<DL> 97<DT><PRE>public final class <B>ReplicationStatus</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL> 98</PRE> 99 100<P> 101The return status from processing a replication message. 102<P> 103 104<P> 105<HR> 106 107<P> 108 109<!-- ========== METHOD SUMMARY =========== --> 110 111<A NAME="method_summary"><!-- --></A> 112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 113<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 114<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 115<B>Method Summary</B></FONT></TH> 116</TR> 117<TR BGCOLOR="white" CLASS="TableRowColor"> 118<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 119<CODE> <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A></CODE></FONT></TD> 120<TD><CODE><B><A HREF="../../../com/sleepycat/db/ReplicationStatus.html#getCData()">getCData</A></B>()</CODE> 121 122<BR> 123 Whenever the system receives contact information from a new 124 environment, a copy of the opaque data specified in the cdata 125 parameter to the <A HREF="../../../com/sleepycat/db/Environment.html#startReplication(com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Environment.startReplication</CODE></A> is available 126 from the getCDAta method.</TD> 127</TR> 128<TR BGCOLOR="white" CLASS="TableRowColor"> 129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 130<CODE> int</CODE></FONT></TD> 131<TD><CODE><B><A HREF="../../../com/sleepycat/db/ReplicationStatus.html#getEnvID()">getEnvID</A></B>()</CODE> 132 133<BR> 134 Return the environment ID associated with the operation.</TD> 135</TR> 136<TR BGCOLOR="white" CLASS="TableRowColor"> 137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 138<CODE> <A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A></CODE></FONT></TD> 139<TD><CODE><B><A HREF="../../../com/sleepycat/db/ReplicationStatus.html#getLSN()">getLSN</A></B>()</CODE> 140 141<BR> 142 Whenever processing a messages results in the processing of messages 143 that are permanent, or a message carrying a DB_REP_PERMANENT flag 144 was processed successfully, but was not written to disk, the LSN of 145 the record is available from the getLSN method.</TD> 146</TR> 147<TR BGCOLOR="white" CLASS="TableRowColor"> 148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 149<CODE> boolean</CODE></FONT></TD> 150<TD><CODE><B><A HREF="../../../com/sleepycat/db/ReplicationStatus.html#isIgnore()">isIgnore</A></B>()</CODE> 151 152<BR> 153 This message cannot be processed.</TD> 154</TR> 155<TR BGCOLOR="white" CLASS="TableRowColor"> 156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 157<CODE> boolean</CODE></FONT></TD> 158<TD><CODE><B><A HREF="../../../com/sleepycat/db/ReplicationStatus.html#isNewSite()">isNewSite</A></B>()</CODE> 159 160<BR> 161 The system received contact information from a new environment.</TD> 162</TR> 163<TR BGCOLOR="white" CLASS="TableRowColor"> 164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 165<CODE> boolean</CODE></FONT></TD> 166<TD><CODE><B><A HREF="../../../com/sleepycat/db/ReplicationStatus.html#isNotPermanent()">isNotPermanent</A></B>()</CODE> 167 168<BR> 169 A message carrying a DB_REP_PERMANENT flag was processed successfully, 170 but was not written to disk.</TD> 171</TR> 172<TR BGCOLOR="white" CLASS="TableRowColor"> 173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 174<CODE> boolean</CODE></FONT></TD> 175<TD><CODE><B><A HREF="../../../com/sleepycat/db/ReplicationStatus.html#isPermanent()">isPermanent</A></B>()</CODE> 176 177<BR> 178 Processing this message resulted in the processing of records that 179 are permanent.</TD> 180</TR> 181<TR BGCOLOR="white" CLASS="TableRowColor"> 182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 183<CODE> boolean</CODE></FONT></TD> 184<TD><CODE><B><A HREF="../../../com/sleepycat/db/ReplicationStatus.html#isSuccess()">isSuccess</A></B>()</CODE> 185 186<BR> 187 The operation succeeded.</TD> 188</TR> 189<TR BGCOLOR="white" CLASS="TableRowColor"> 190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 191<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> 192<TD><CODE><B><A HREF="../../../com/sleepycat/db/ReplicationStatus.html#toString()">toString</A></B>()</CODE> 193 194<BR> 195 </TD> 196</TR> 197</TABLE> 198 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 199<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 200<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 201<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> 202</TR> 203<TR BGCOLOR="white" CLASS="TableRowColor"> 204<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 205</TR> 206</TABLE> 207 208<P> 209 210<!-- ============ METHOD DETAIL ========== --> 211 212<A NAME="method_detail"><!-- --></A> 213<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 214<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 215<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 216<B>Method Detail</B></FONT></TH> 217</TR> 218</TABLE> 219 220<A NAME="isSuccess()"><!-- --></A><H3> 221isSuccess</H3> 222<PRE> 223public boolean <B>isSuccess</B>()</PRE> 224<DL> 225<DD>The operation succeeded. 226<P> 227<DD><DL> 228</DL> 229</DD> 230</DL> 231<HR> 232 233<A NAME="isIgnore()"><!-- --></A><H3> 234isIgnore</H3> 235<PRE> 236public boolean <B>isIgnore</B>()</PRE> 237<DL> 238<DD>This message cannot be processed. 239 This is an indication that this message is irrelevant to the current 240 replication state (for example, an old message from a previous 241 generation arrives and is processed late). 242<P> 243<DD><DL> 244</DL> 245</DD> 246</DL> 247<HR> 248 249<A NAME="isPermanent()"><!-- --></A><H3> 250isPermanent</H3> 251<PRE> 252public boolean <B>isPermanent</B>()</PRE> 253<DL> 254<DD>Processing this message resulted in the processing of records that 255 are permanent. The maximum LSN of the permanent records stored is 256 available from the getLSN method. 257<P> 258<DD><DL> 259</DL> 260</DD> 261</DL> 262<HR> 263 264<A NAME="isNewSite()"><!-- --></A><H3> 265isNewSite</H3> 266<PRE> 267public boolean <B>isNewSite</B>()</PRE> 268<DL> 269<DD>The system received contact information from a new environment. A 270 copy of the opaque data specified in the cdata parameter to the 271 <A HREF="../../../com/sleepycat/db/Environment.html#startReplication(com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Environment.startReplication</CODE></A> is available from the 272 getCDAta method. The application should take whatever action is 273 needed to establish a communication channel with this new 274 environment. 275<P> 276<DD><DL> 277</DL> 278</DD> 279</DL> 280<HR> 281 282<A NAME="isNotPermanent()"><!-- --></A><H3> 283isNotPermanent</H3> 284<PRE> 285public boolean <B>isNotPermanent</B>()</PRE> 286<DL> 287<DD>A message carrying a DB_REP_PERMANENT flag was processed successfully, 288 but was not written to disk. The LSN of this record is available from 289 the getLSN method. The application should take whatever action is 290 deemed necessary to retain its recoverability characteristics. 291<P> 292<DD><DL> 293</DL> 294</DD> 295</DL> 296<HR> 297 298<A NAME="getCData()"><!-- --></A><H3> 299getCData</H3> 300<PRE> 301public <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> <B>getCData</B>()</PRE> 302<DL> 303<DD>Whenever the system receives contact information from a new 304 environment, a copy of the opaque data specified in the cdata 305 parameter to the <A HREF="../../../com/sleepycat/db/Environment.html#startReplication(com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Environment.startReplication</CODE></A> is available 306 from the getCDAta method. The application should take whatever 307 action is needed to establish a communication channel with this new 308 environment. 309<P> 310<DD><DL> 311</DL> 312</DD> 313</DL> 314<HR> 315 316<A NAME="getEnvID()"><!-- --></A><H3> 317getEnvID</H3> 318<PRE> 319public int <B>getEnvID</B>()</PRE> 320<DL> 321<DD>Return the environment ID associated with the operation. In most cases, 322 this is the same as the environment ID passed to <A HREF="../../../com/sleepycat/db/Environment.html#processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"><CODE>Environment.processReplicationMessage</CODE></A>. However, if a new master is elected, this 323 method returns the environment ID of the new master. It is the 324 application's responsibility to ensure that the matching node begins acting 325 as the master environment. 326<P> 327<DD><DL> 328</DL> 329</DD> 330</DL> 331<HR> 332 333<A NAME="getLSN()"><!-- --></A><H3> 334getLSN</H3> 335<PRE> 336public <A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> <B>getLSN</B>()</PRE> 337<DL> 338<DD>Whenever processing a messages results in the processing of messages 339 that are permanent, or a message carrying a DB_REP_PERMANENT flag 340 was processed successfully, but was not written to disk, the LSN of 341 the record is available from the getLSN method. The application 342 should take whatever action is deemed necessary to retain its 343 recoverability characteristics. 344<P> 345<DD><DL> 346</DL> 347</DD> 348</DL> 349<HR> 350 351<A NAME="toString()"><!-- --></A><H3> 352toString</H3> 353<PRE> 354public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> 355<DL> 356<DD> 357<P> 358<DD><DL> 359<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL> 360</DD> 361<DD><DL> 362</DL> 363</DD> 364</DL> 365<!-- ========= END OF CLASS DATA ========= --> 366<HR> 367 368 369<!-- ======= START OF BOTTOM NAVBAR ====== --> 370<A NAME="navbar_bottom"><!-- --></A> 371<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 372<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 373<TR> 374<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 375<A NAME="navbar_bottom_firstrow"><!-- --></A> 376<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 377 <TR ALIGN="center" VALIGN="top"> 378 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 379 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 380 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 381 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReplicationStatus.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 382 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 383 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 384 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 385 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 386 </TR> 387</TABLE> 388</TD> 389<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 390<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 391</TD> 392</TR> 393 394<TR> 395<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 396 <A HREF="../../../com/sleepycat/db/ReplicationStats.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 397 <A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 398<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 399 <A HREF="../../../index.html?com/sleepycat/db/ReplicationStatus.html" target="_top"><B>FRAMES</B></A> 400 <A HREF="ReplicationStatus.html" target="_top"><B>NO FRAMES</B></A> 401 <SCRIPT type="text/javascript"> 402 <!-- 403 if(window==top) { 404 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 405 } 406 //--> 407</SCRIPT> 408<NOSCRIPT> 409 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 410</NOSCRIPT> 411 412 413</FONT></TD> 414</TR> 415<TR> 416<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 417 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 418<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 419DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 420</TR> 421</TABLE> 422<A NAME="skip-navbar_bottom"></A> 423<!-- ======== END OF BOTTOM NAVBAR ======= --> 424 425<HR> 426<font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 427</BODY> 428</HTML> 429
